Package com.verisign.epp.framework
Class EPPBalanceHandler
- java.lang.Object
-
- com.verisign.epp.framework.EPPBalanceHandler
-
- All Implemented Interfaces:
EPPEventHandler
- Direct Known Subclasses:
BalanceHandler
public abstract class EPPBalanceHandler extends java.lang.Object implements EPPEventHandler
This class provides an interface for handling EPP Balance 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 ofEPPBalanceHandler
should be registered with theEPPDispatcher
so that EPPEvents related to the Balance Mapping will be handled there.
-
-
Constructor Summary
Constructors Constructor Description EPPBalanceHandler()
Construct an instance ofEPPBalanceHandler
.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract EPPEventResponse
doBalanceInfo(EPPEvent aEvent, java.lang.Object aData)
Returns theEPPEventResponse
back to the client after processing the passed inaEvent
.java.lang.String
getNamespace()
Returns the Balance Namespace associated with this handler.EPPEventResponse
handleEvent(EPPEvent aEvent, java.lang.Object aData)
Returns theEPPEventResponse
after processing the passed inaEvent
.protected void
postHandleEvent(EPPEvent aEvent, java.lang.Object aData)
Handles any common behavior that all Balance 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 Balance commands need to execute before they execute their command specific behavior.
-
-
-
Constructor Detail
-
EPPBalanceHandler
public EPPBalanceHandler()
Construct an instance ofEPPBalanceHandler
. Whenever anEPPBalanceHandler
instance is created it also addsEPPBalanceMapFactory
to theEPPFactory
map factory.
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Returns the Balance Namespace associated with this handler.- Specified by:
getNamespace
in interfaceEPPEventHandler
- Returns:
- String the Balance Namespace associated with this handler.
-
handleEvent
public EPPEventResponse handleEvent(EPPEvent aEvent, java.lang.Object aData) throws EPPEventException
Returns theEPPEventResponse
after processing the passed inaEvent
. 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 thisEPPBalanceHandler
instance.- Returns:
- the
EPPEventResponse
after processing the passed inaEvent
. - 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 Balance 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 thisEPPBalanceHandler
- 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 Balance 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 thisEPPBalanceHandler
- Throws:
EPPHandleEventException
- Thrown if an error condition occurs. It must contain anEPPEventResponse
-
doBalanceInfo
protected abstract EPPEventResponse doBalanceInfo(EPPEvent aEvent, java.lang.Object aData)
Returns theEPPEventResponse
back to the client after processing the passed inaEvent
. Invoked when a Balance Info command is received. Subclasses should define the behavior when a Balance Info command is received.- Parameters:
aEvent
- TheEPPEvent
that is being handledaData
- Any data that a Server needs to send to thisEPPBalanceHandler
- Returns:
- the
EPPEventResponse
back to the client after processing the passed inaEvent
.
-
-