Package com.verisign.epp.framework.authtoken.v01

Class EPPAuthTokenHandler

java.lang.Object
com.verisign.epp.framework.authtoken.v01.EPPAuthTokenHandler
All Implemented Interfaces:
EPPEventHandler
Direct Known Subclasses:
AuthTokenHandler
public abstract class EPPAuthTokenHandler extends Object implements EPPEventHandler
The EPPAuthTokenHandler class provides an interface for handling EPP AuthToken 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 EPPAuthTokenHandler should be registered with the EPPDispatcher so that EEPEvents related to the EPPAuthToken Mapping will be handled there.
See Also:

  • Constructor Details

    • EPPAuthTokenHandler

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

  • Method Details

    • getNamespace

      public final String getNamespace()
      Returns the Namespace that this handler supports. In this case, auth token.
      Specified by:
      getNamespace in interface EPPEventHandler
      Returns:
      String The Namespace that this handler supports

    • handleEvent

      public final 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 EPPContactHandler instance
      Returns:
      Response to the event
      Throws:
      EPPEventException - Thrown if an unrecognized EPPEvent is received

    • preHandleEvent

      protected void preHandleEvent(EPPEvent aEvent, Object aData) throws EPPHandleEventException
      Handles any common behavior that all auth token 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 EPPAuthTokenHandler
      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 auth token 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 EPPAuthTokenHandler
      Throws:
      EPPHandleEventException - Thrown if an error condition occurs. It must contain an EPPEventResponse

    • doAuthTokenCreate

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

    • doAuthTokenInfo

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

    • doAuthTokenCheck

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

    • doAuthTokenDelete

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