Class EPPNameWatchHandler

java.lang.Object
com.verisign.epp.framework.EPPNameWatchHandler
All Implemented Interfaces:
EPPEventHandler
Direct Known Subclasses:
NameWatchHandler

public abstract class EPPNameWatchHandler extends Object implements EPPEventHandler
The EPPNameWatchHandler class provides an interface for handling EPP NameWatch 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 EPPNameWatchHandler should be registered with the EPPDispatcher so that EEPEvents related to the NameWatch Mapping will be handled there.

See Also:
  • Constructor Details

    • EPPNameWatchHandler

      public EPPNameWatchHandler()
      Whenever an EPPNameWatchHandler instance is created load the corresponsding Map Factory into the Codec
  • Method Details

    • getNamespace

      public final String getNamespace()
      Returns the Namespace that this handler supports. In this case, namewatch.
      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:
      DOCUMENT ME!
      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 namewatch 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 EPPNameWatchHandler
      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 namewatch 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 EPPNameWatchHandler
      Throws:
      EPPHandleEventException - Thrown if an error condition occurs. It must contain an EPPEventResponse
    • doNameWatchCreate

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

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

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

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

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

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