Package com.verisign.epp.framework
Class EPPEmailFwdHandler
- java.lang.Object
-
- com.verisign.epp.framework.EPPEmailFwdHandler
-
- All Implemented Interfaces:
EPPEventHandler
- Direct Known Subclasses:
EmailFwdHandler
public abstract class EPPEmailFwdHandler extends java.lang.Object implements EPPEventHandler
TheEPPEmailFwdHandler
class provides an interface for handling EPP EmailFwd 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 ofEPPEmailFwdHandler
should be registered with theEPPDispatcher
so that EEPEvents related to the EmailFwd Mapping will be handled there.- See Also:
EPPEventHandler
,EPPEvent
-
-
Constructor Summary
Constructors Constructor Description EPPEmailFwdHandler()
Whenever an EPPEmailFwdHandler 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
doEmailFwdCheck(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Check command is received.protected abstract EPPEventResponse
doEmailFwdCreate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Create command is received.protected abstract EPPEventResponse
doEmailFwdDelete(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Delete command is received.protected abstract EPPEventResponse
doEmailFwdInfo(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Info command is received.protected abstract EPPEventResponse
doEmailFwdRenew(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Renew command is received.protected abstract EPPEventResponse
doEmailFwdTransfer(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Transfer command is received.protected abstract EPPEventResponse
doEmailFwdUpdate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd 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 emailfwd 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 emailfwd 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, emailfwd.- 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 emailfwd 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 thisEPPEmailFwdHandler
- 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 emailfwd 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 thisEPPEmailFwdHandler
- Throws:
EPPHandleEventException
- Thrown if an error condition occurs. It must contain anEPPEventResponse
-
doEmailFwdCreate
protected abstract EPPEventResponse doEmailFwdCreate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Create command is received. Subclasses should define the behavior when a EmailFwd Create command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPEmailFwdHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doEmailFwdDelete
protected abstract EPPEventResponse doEmailFwdDelete(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Delete command is received. Subclasses should define the behavior when a EmailFwd Delete command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPEmailFwddHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doEmailFwdInfo
protected abstract EPPEventResponse doEmailFwdInfo(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Info command is received. Subclasses should define the behavior when a EmailFwd Info command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPEmailFwddHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doEmailFwdCheck
protected abstract EPPEventResponse doEmailFwdCheck(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Check command is received. Subclasses should define the behavior when a EmailFwd Check command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPEmailFwddHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doEmailFwdRenew
protected abstract EPPEventResponse doEmailFwdRenew(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Renew command is received. Subclasses should define the behavior when a EmailFwd Renew command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPEmailFwddHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doEmailFwdTransfer
protected abstract EPPEventResponse doEmailFwdTransfer(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Transfer command is received. Subclasses should define the behavior when a EmailFwd Transfer command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPEmailFwddHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
doEmailFwdUpdate
protected abstract EPPEventResponse doEmailFwdUpdate(EPPEvent aEvent, java.lang.Object aData)
Invoked when a EmailFwd Update command is received. Subclasses should define the behavior when a EmailFwd Update command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPEmailFwddHandler
- Returns:
- EPPEventResponse The response that should be sent back to the client.
-
-