Package com.verisign.epp.framework
Class EPPHostHandler
- java.lang.Object
-
- com.verisign.epp.framework.EPPHostHandler
-
- All Implemented Interfaces:
EPPEventHandler
- Direct Known Subclasses:
HostHandler
,NSHostHandler
public abstract class EPPHostHandler extends java.lang.Object implements EPPEventHandler
TheEPPHostHandler
class provides an interface for handling Host 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 ofEPPHostHandler
should be registered with theEPPDispatcher
so that EEPEvents related to the Host Mapping will be handled there.
- See Also:
EPPEventHandler
,EPPEvent
-
-
Constructor Summary
Constructors Constructor Description EPPHostHandler()
Construct an instance ofEPPHostHandler
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract EPPEventResponse
doHostCheck(EPPEvent aEvent, java.lang.Object aData)
Invoked when a Host Check command is received.protected abstract EPPEventResponse
doHostCreate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a Host Create command is received.protected abstract EPPEventResponse
doHostDelete(EPPEvent aEvent, java.lang.Object aData)
Invoked when a Host Info command is received.protected abstract EPPEventResponse
doHostInfo(EPPEvent aEvent, java.lang.Object aData)
Invoked when a Host Info command is received.protected abstract EPPEventResponse
doHostUpdate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a Host 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 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 host 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, host.- 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 host 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
-
doHostCreate
protected abstract EPPEventResponse doHostCreate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a Host Create command is received. Subclasses should define the behavior when a Host Create 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.
-
doHostDelete
protected abstract EPPEventResponse doHostDelete(EPPEvent aEvent, java.lang.Object aData)
Invoked when a Host Info command is received. Subclasses should define the behavior when a Host Info command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDomaindHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doHostInfo
protected abstract EPPEventResponse doHostInfo(EPPEvent aEvent, java.lang.Object aData)
Invoked when a Host Info command is received. Subclasses should define the behavior when a Host Info command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDomaindHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doHostCheck
protected abstract EPPEventResponse doHostCheck(EPPEvent aEvent, java.lang.Object aData)
Invoked when a Host Check command is received. Subclasses should define the behavior when a Host Check command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDomaindHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doHostUpdate
protected abstract EPPEventResponse doHostUpdate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a Host Update command is received. Subclasses should define the behavior when a Host Update command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPDomaindHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
-