Package com.verisign.epp.codec.gen
Class EPPPollCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPPollCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPPollCmd extends EPPCommand
The EPP <pollgt; command is used to discover and retrieve client service messages from a server. Information that MAY be made available to a client using service messages includes notification of object transfer requests and anticipated server outages; other messages types MAY be defined as a matter of server policy.
Service messages are queued by the server for client retrieval. A <pollgt; command MUST return the first message from the message queue. Each message returned from the server includes a server-unique message identifier that MUST be provided to acknowledge receipt of the message, and a counter that indicates the number of messages in the queue. As a message is received by the client, the client MUST respond to the message with an explicit acknowledgement to confirm that the message has been received. A server MUST dequeue a message and decrement the queue counter after receiving acknowledgement from the client, making the next message in the queue (if any) available for retrieval.
Some of the information returned in response to a <pollgt; command MAY be object-specific, so some child elements of the <pollgt; response MAY be specified using the EPP extension framework. In addition to the standard EPP command elements, the <pollgt; command SHALL contain no child elements and anop
attribute with valuereq
to retrieve the first message from the server message queue, or both anop
attribute with valueack
and amsgID
attribute whose value corresponds to the value ofid
attribute copied from the <msggt; element in the response that is being acknowledged.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
msgID
msgID attribute whose value corresponds to the value ofid
attribute copied from themsg
element in the response that is being acknowledged.protected java.lang.String
op
Operation "op" associated with theEPPPollCmd
.static java.lang.String
OP_ACK
Poll operation type indicating that the client has received a message and that the server can remove the message.static java.lang.String
OP_REQ
Poll operation type indicating that the client is requesting information from the server.-
Fields inherited from class com.verisign.epp.codec.gen.EPPCommand
extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE
-
-
Constructor Summary
Constructors Constructor Description EPPPollCmd()
Default constructor.EPPPollCmd(java.lang.String aTransId, java.lang.String aOp)
EPPPollCmd
that takes all required attributes as arguments for aEPPPollCmd.OP_REQ
poll command.EPPPollCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aMsgID)
EPPPollCmd
that takes attributes as arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPPollCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Must be defined byEPPPollCmd
extensions (Command Mappings) to decode the attributes to a DOM Element tree.protected org.w3c.dom.Element
doEncode(org.w3c.dom.Document aDocument)
Must be defined byEPPPollCmd
extensions (Command Mappings) to encode the attributes to a DOM Element tree.protected void
doGenDecode(org.w3c.dom.Element aElement)
Decodes theEPPPollCmd
attributes from theaElement
DOM Element tree.protected org.w3c.dom.Element
doGenEncode(org.w3c.dom.Document aDocument)
Encodes a DOM Element tree from the attributes of theEPPPollCmd
instance.boolean
equals(java.lang.Object aObject)
Compares an instance of EPPPollCmd with this instance.java.lang.String
getMsgID()
Gets the poll Message Id.java.lang.String
getNamespace()
Gets the associated EPP namespace.java.lang.String
getOp()
Gets the EPP command operation attribute associated withEPPPollCmd
.java.lang.String
getType()
Gets the EPP command type associated with EPPPollCmd.void
setMsgID(java.lang.String aMsgID)
Sets the poll Message Id.-
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand
addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId, toString
-
-
-
-
Field Detail
-
OP_REQ
public static final java.lang.String OP_REQ
Poll operation type indicating that the client is requesting information from the server.- See Also:
- Constant Field Values
-
OP_ACK
public static final java.lang.String OP_ACK
Poll operation type indicating that the client has received a message and that the server can remove the message.- See Also:
- Constant Field Values
-
op
protected java.lang.String op
Operation "op" associated with theEPPPollCmd
. This should be equal to one of theEPPPollCmd.OP_
constants.
-
msgID
protected java.lang.String msgID
msgID attribute whose value corresponds to the value ofid
attribute copied from themsg
element in the response that is being acknowledged.
-
-
Constructor Detail
-
EPPPollCmd
public EPPPollCmd()
Default constructor. Will set both op and msgId tonull
.
-
EPPPollCmd
public EPPPollCmd(java.lang.String aTransId, java.lang.String aOp)
EPPPollCmd
that takes all required attributes as arguments for aEPPPollCmd.OP_REQ
poll command. IfaOp
isEPPPollCmd.OP_ACK
, the message id must be set withsetMsgId
before callingencode
.- Parameters:
aTransId
- Transaction Id associated with command.aOp
- One of theEPPPollCmd.OP_
constants.
-
EPPPollCmd
public EPPPollCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aMsgID)
EPPPollCmd
that takes attributes as arguments.- Parameters:
aTransId
- Transaction Id associated with command.aOp
- One of theEPPPollCmd.OP_
constants.aMsgID
- Message Id when operation isEPPPollCmd.OP_ACK
.
-
-
Method Detail
-
getType
public java.lang.String getType()
Gets the EPP command type associated with EPPPollCmd.- Specified by:
getType
in classEPPCommand
- Returns:
EPPCommand.TYPE_POLL
-
getOp
public java.lang.String getOp()
Gets the EPP command operation attribute associated withEPPPollCmd
.- Overrides:
getOp
in classEPPCommand
- Returns:
- One of the
EPPCommand.OP_
constants associated with the poll command.
-
equals
public boolean equals(java.lang.Object aObject)
Compares an instance of EPPPollCmd with this instance.- Overrides:
equals
in classEPPCommand
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
otherwise.
-
doGenEncode
protected org.w3c.dom.Element doGenEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encodes a DOM Element tree from the attributes of theEPPPollCmd
instance. This method is a member of the Template Design Pattern.EPPCommand.encode
is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.- Specified by:
doGenEncode
in classEPPCommand
- Parameters:
aDocument
- - DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPPollCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPPollCmd
instance.
-
doGenDecode
protected void doGenDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decodes theEPPPollCmd
attributes from theaElement
DOM Element tree. This method is a member of the Template Design Pattern.EPPCommand.decode
is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.- Specified by:
doGenDecode
in classEPPCommand
- Parameters:
aElement
- - Root DOM Element to decodeEPPPollCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPPollCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- clone of
EPPPollCmd
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Must be defined byEPPPollCmd
extensions (Command Mappings) to encode the attributes to a DOM Element tree.doGenEncode
is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.- Parameters:
aDocument
- - DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the EPPPollCmd extension instance.
- Throws:
EPPEncodeException
- Unable to encode EPPPollCmd extension instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Must be defined byEPPPollCmd
extensions (Command Mappings) to decode the attributes to a DOM Element tree.doGenDecode
is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.- Parameters:
aElement
- Root DOM Element representing theEPPPollCmd
extension instance.- Throws:
EPPDecodeException
- Unable to decodeaElement
.
-
getMsgID
public java.lang.String getMsgID()
Gets the poll Message Id.- Returns:
- Message Id if defined; null otherwise.
-
getNamespace
public java.lang.String getNamespace()
Gets the associated EPP namespace. The general EPP namespace is returned, which is defined asEPPCodec.NS
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
- namespace URI
-
setMsgID
public void setMsgID(java.lang.String aMsgID)
Sets the poll Message Id.- Parameters:
aMsgID
- Message Id
-
-