Package com.verisign.epp.framework
Class EPPDefRegHandler
- java.lang.Object
-
- com.verisign.epp.framework.EPPDefRegHandler
-
- All Implemented Interfaces:
EPPEventHandler
- Direct Known Subclasses:
DefRegHandler
public abstract class EPPDefRegHandler extends java.lang.Object implements EPPEventHandler
TheEPPDefRegHandler
class provides an interface for handling EPP DefReg 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 ofEPPDefRegHandler
should be registered with theEPPDispatcher
so that EEPEvents related to the DefReg Mapping will be handled there.- See Also:
EPPEventHandler
,EPPEvent
-
-
Constructor Summary
Constructors Constructor Description EPPDefRegHandler()
Whenever an EPPDefRegHandler 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
doDefRegCheck(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Check command is received.protected abstract EPPEventResponse
doDefRegCreate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Create command is received.protected abstract EPPEventResponse
doDefRegDelete(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Delete command is received.protected abstract EPPEventResponse
doDefRegInfo(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Info command is received.protected abstract EPPEventResponse
doDefRegRenew(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Renew command is received.protected abstract EPPEventResponse
doDefRegTransfer(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Transfer command is received.protected abstract EPPEventResponse
doDefRegUpdate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg 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 defReg 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 defReg 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, defReg.- 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 defReg 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 thisEPPDefRegHandler
- 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 defReg 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 thisEPPDefRegHandler
- Throws:
EPPHandleEventException
- Thrown if an error condition occurs. It must contain anEPPEventResponse
-
doDefRegCreate
protected abstract EPPEventResponse doDefRegCreate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Create command is received. Subclasses should define the behavior when a DefReg Create command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDefRegHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doDefRegDelete
protected abstract EPPEventResponse doDefRegDelete(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Delete command is received. Subclasses should define the behavior when a DefReg Delete command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDefRegdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doDefRegInfo
protected abstract EPPEventResponse doDefRegInfo(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Info command is received. Subclasses should define the behavior when a DefReg Info command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDefRegdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doDefRegCheck
protected abstract EPPEventResponse doDefRegCheck(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Check command is received. Subclasses should define the behavior when a DefReg Check command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDefRegdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doDefRegRenew
protected abstract EPPEventResponse doDefRegRenew(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Renew command is received. Subclasses should define the behavior when a DefReg Renew command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDefRegdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doDefRegTransfer
protected abstract EPPEventResponse doDefRegTransfer(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Transfer command is received. Subclasses should define the behavior when a DefReg Transfer command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDefRegdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doDefRegUpdate
protected abstract EPPEventResponse doDefRegUpdate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a DefReg Update command is received. Subclasses should define the behavior when a DefReg Update command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDefRegdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
-