Package com.verisign.epp.framework.v1_0

Class EPPMaintenanceHandler

java.lang.Object
com.verisign.epp.framework.v1_0.EPPMaintenanceHandler
All Implemented Interfaces:
EPPEventHandler
Direct Known Subclasses:
MaintenanceHandler
public abstract class EPPMaintenanceHandler extends Object implements EPPEventHandler
The EPPMaintenanceHandler class provides an interface for handling EPP Maintenance Commands in a Server implementation. EPPEvents are handled by the handleEvent() method here and routed to the appropriate abstract member function. Subclasses should override the abstract methods to define the desired behavior of a particular command when it is received. A subclassed instance of EPPMaintenanceHandler should be registered with the EPPDispatcher so that EEPEvents related to the Registry Mapping will be handled there.
See Also:

  • Constructor Details

    • EPPMaintenanceHandler

      public EPPMaintenanceHandler()
      Whenever an EPPMaintenanceHandler instance is created load the corresponding Map Factory into the Codec

  • Method Details

    • getNamespace

      public String getNamespace()
      Gets the XML Namespace for the Mapping.
      Specified by:
      getNamespace in interface EPPEventHandler
      Returns:
      EPPMaintenanceMapFactory.NS

    • handleEvent

      public EPPEventResponse handleEvent(EPPEvent aEvent, Object aData) throws EPPEventException
      This method receives an EPPEvent and routes it to the appropriate abstract method.
      Specified by:
      handleEvent in interface EPPEventHandler
      Parameters:
      aEvent - An EPPEvent that contains the EPPCommand
      aData - Any data that a Server needs to send to this EPPMaintenanceHandler instance
      Returns:
      Response to the event
      Throws:
      EPPEventException - Thrown if an unrecognized EPPEvent is received

    • doMaintenanceInfo

      protected abstract EPPEventResponse doMaintenanceInfo(EPPEvent aEvent, Object aData)
      Invoked when a Maintenance Info command is received. Subclasses should define the behavior when a Maintenance Info command is received.
      Parameters:
      aEvent - The EPPEvent that is being handled
      aData - Any data that a Server needs to send to this EPPMaintenanceHandler
      Returns:
      EPPEventResponse The response that should be sent back to the client.

    • preHandleEvent

      protected void preHandleEvent(EPPEvent aEvent, Object aData) throws EPPHandleEventException
      Handles any common behavior that all registry commands need to execute before they execute their command specific behavior. The default implementation does nothing.
      Parameters:
      aEvent - The EPPEvent that is being handled
      aData - Any data that a Server needs to send to this EPPMaintenanceHandler
      Throws:
      EPPHandleEventException - Thrown if an error condition occurs. It must contain an EPPEventResponse

    • postHandleEvent

      protected void postHandleEvent(EPPEvent aEvent, Object aData) throws EPPHandleEventException
      Handles any common behavior that all registry commands need to execute after they execute their command specific behavior. The default implementation does nothing
      Parameters:
      aEvent - The EPPEvent that is being handled
      aData - Any data that a Server needs to send to this EPPMaintenanceHandler
      Throws:
      EPPHandleEventException - Thrown if an error condition occurs. It must contain an EPPEventResponse