Package com.verisign.epp.framework
Class EPPPollQueueMgr
java.lang.Object
com.verisign.epp.framework.EPPPollQueueMgr
The
EPPPollQueueMgr is used to handle the poll command, which allows
to discover and retrieve client service messages from a server. Once
GenHandler issues the get method, EPPPollQueueMgr receives
data from EPPPollDataSource and then returns concrete
EPPResponse back to GenHandler.-
Method Summary
Modifier and TypeMethodDescriptionDelete object from data sourceGets theEPPResponsepoll message from the data sourceGets the poll queue data sourcestatic EPPPollQueueMgrGets instance ofEPPPollQueueMgrvoidPuts poll message into the poll data sourcevoidregister(EPPPollHandler aHandler) Registers a poll handler.voidsetDataSource(EPPPollDataSource aSource) Registers the poll data source.
-
Method Details
-
getInstance
Gets instance ofEPPPollQueueMgr- Returns:
- Gets the Singleton instance of
EPPPollQueueMgr
-
getDataSource
Gets the poll queue data source- Returns:
- Gets the registered
EPPPollDataSourceif defined;nullotherwise.
-
register
Registers a poll handler.- Parameters:
aHandler- Poll handler to register in theEPPPollQueueMgr.
-
setDataSource
Registers the poll data source.- Parameters:
aSource- Poll data source to register in theEPPPollQueueMgr.
-
get
Gets theEPPResponsepoll message from the data source- Parameters:
aRecp- Server-specific recipient object that can be used to filter the messages by the recipient.aContextData- Server context passed into theEPPPollDataSource.- Returns:
- EPPResponse Returns the concrete
EPPResponse - Throws:
EPPPollQueueException- Unable to get theEPPResponsefrom data source
-
put
public void put(Object aRecp, String aKind, Object aData, Object aContextData) throws EPPPollQueueException Puts poll message into the poll data source- Parameters:
aRecp- Recipient of the poll message, which represents the logical poll queue.aKind- Kind of poll messageaData- Poll messageaContextData- Server context data- Throws:
EPPPollQueueException- Error putting message in queue
-
delete
public EPPResponse delete(Object aRecp, String aMsgId, Object aContextData) throws EPPPollQueueException Delete object from data source- Parameters:
aRecp- Recipient of the poll message, which represents the logical poll queue.aMsgId- Message identifier to deleteaContextData- Server context data- Returns:
- EPPResponse
EPPResponsecontaining result of deleting the poll message - Throws:
EPPPollQueueException- Error deleting the message
-