Package com.verisign.epp.framework
Class EPPNameWatchHandler
- java.lang.Object
-
- com.verisign.epp.framework.EPPNameWatchHandler
-
- All Implemented Interfaces:
EPPEventHandler
- Direct Known Subclasses:
NameWatchHandler
public abstract class EPPNameWatchHandler extends java.lang.Object implements EPPEventHandler
TheEPPNameWatchHandler
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 ofEPPNameWatchHandler
should be registered with theEPPDispatcher
so that EEPEvents related to the NameWatch Mapping will be handled there.
- See Also:
EPPEventHandler
,EPPEvent
-
-
Constructor Summary
Constructors Constructor Description EPPNameWatchHandler()
Whenever an EPPNameWatchHandler instance is created load the corresponsding Map Factory into the Codec
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract EPPEventResponse
doNameWatchCreate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Create command is received.protected abstract EPPEventResponse
doNameWatchDelete(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Delete command is received.protected abstract EPPEventResponse
doNameWatchInfo(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Info command is received.protected abstract EPPEventResponse
doNameWatchRenew(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Renew command is received.protected abstract EPPEventResponse
doNameWatchTransfer(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Transfer command is received.protected abstract EPPEventResponse
doNameWatchUpdate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Update command is received.java.lang.String
getNamespace()
Returns the Namespace that this handler supports.EPPEventResponse
handleEvent(EPPEvent aEvent, java.lang.Object aData)
This method receives anEPPEvent
and routes it to the appropriate abstract method.protected void
postHandleEvent(EPPEvent aEvent, java.lang.Object aData)
Handles any common behavior that all namewatch commands need to execute after they execute their command specific behavior.protected void
preHandleEvent(EPPEvent aEvent, java.lang.Object aData)
Handles any common behavior that all namewatch commands need to execute before they execute their command specific behavior.
-
-
-
Method Detail
-
getNamespace
public final java.lang.String getNamespace()
Returns the Namespace that this handler supports. In this case, namewatch.- Specified by:
getNamespace
in interfaceEPPEventHandler
- Returns:
- String The Namespace that this handler supports
-
handleEvent
public final EPPEventResponse handleEvent(EPPEvent aEvent, java.lang.Object aData) throws EPPEventException
This method receives anEPPEvent
and routes it to the appropriate abstract method.- Specified by:
handleEvent
in interfaceEPPEventHandler
- Parameters:
aEvent
- AnEPPEvent
that contains theEPPCommand
aData
- Any data that a Server needs to send to thisEPPContactHandler
instance- Returns:
- DOCUMENT ME!
- Throws:
EPPEventException
- Thrown if an unrecognizedEPPEvent
is received
-
preHandleEvent
protected void preHandleEvent(EPPEvent aEvent, java.lang.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
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPNameWatchHandler
- Throws:
EPPHandleEventException
- Thrown if an error condition occurs. It must contain anEPPEventResponse
-
postHandleEvent
protected void postHandleEvent(EPPEvent aEvent, java.lang.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
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPNameWatchHandler
- Throws:
EPPHandleEventException
- Thrown if an error condition occurs. It must contain anEPPEventResponse
-
doNameWatchCreate
protected abstract EPPEventResponse doNameWatchCreate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Create command is received. Subclasses should define the behavior when a NameWatch Create command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPNameWatchHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doNameWatchDelete
protected abstract EPPEventResponse doNameWatchDelete(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Delete command is received. Subclasses should define the behavior when a NameWatch Delete command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPNameWatchdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doNameWatchInfo
protected abstract EPPEventResponse doNameWatchInfo(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Info command is received. Subclasses should define the behavior when a NameWatch Info command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPNameWatchdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doNameWatchRenew
protected abstract EPPEventResponse doNameWatchRenew(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Renew command is received. Subclasses should define the behavior when a NameWatch Renew command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPNameWatchdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doNameWatchTransfer
protected abstract EPPEventResponse doNameWatchTransfer(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Transfer command is received. Subclasses should define the behavior when a NameWatch Transfer command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPNameWatchdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doNameWatchUpdate
protected abstract EPPEventResponse doNameWatchUpdate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a NameWatch Update command is received. Subclasses should define the behavior when a NameWatch Update command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPNameWatchdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
-