Package com.verisign.epp.framework
Class EPPGenHandler
- java.lang.Object
-
- com.verisign.epp.framework.EPPGenHandler
-
- All Implemented Interfaces:
EPPEventHandler
- Direct Known Subclasses:
GenHandler
public abstract class EPPGenHandler extends java.lang.Object implements EPPEventHandler
TheEPPGenHandler
class provides an interface for handling General EPP 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 ofEPPGenHandler
should be registered with theEPPDispatcher
so that EEPEvents related to the General EPP Mapping will be handled there.- See Also:
EPPEventHandler
,EPPEvent
-
-
Constructor Summary
Constructors Constructor Description EPPGenHandler()
Construct an instance ofEPPGenHandler
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract EPPEventResponse
doHello(EPPEvent aEvent, java.lang.Object aData)
Invoked when an EPP Hello command is received.protected abstract EPPEventResponse
doLogin(EPPEvent aEvent, java.lang.Object aData)
Invoked when an EPP Login command is received.protected abstract EPPEventResponse
doLogout(EPPEvent aEvent, java.lang.Object aData)
Invoked when an EPP Logout command is received.protected abstract EPPEventResponse
doPoll(EPPEvent aEvent, java.lang.Object aData)
Invoked when an EPP Poll 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 gen 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 gen 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, domain.- 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 gen 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 thisEPPDomainHandler
- 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 gen 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 thisEPPDomainHandler
- Throws:
EPPHandleEventException
- Thrown if an error condition occurs. It must contain anEPPEventResponse
-
doLogin
protected abstract EPPEventResponse doLogin(EPPEvent aEvent, java.lang.Object aData)
Invoked when an EPP Login command is received. Subclasses should define the behavior when a Login command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDomainHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doLogout
protected abstract EPPEventResponse doLogout(EPPEvent aEvent, java.lang.Object aData)
Invoked when an EPP Logout command is received. Subclasses should define the behavior when a Logout command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDomainHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doPoll
protected abstract EPPEventResponse doPoll(EPPEvent aEvent, java.lang.Object aData)
Invoked when an EPP Poll command is received. Subclasses should define the behavior when a Poll command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDomainHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doHello
protected abstract EPPEventResponse doHello(EPPEvent aEvent, java.lang.Object aData)
Invoked when an EPP Hello command is received. Subclasses should define the behavior when a Hello command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDomainHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
-