|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPPollCmd
public class EPPPollCmd
The EPP <poll> 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
<poll> 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 <poll> command MAY be
object-specific, so some child elements of the <poll> response MAY be
specified using the EPP extension framework. In addition to the standard
EPP command elements, the <poll> command SHALL contain no child
elements and an op
attribute with value req
to
retrieve the first message from the server message queue, or both an
op
attribute with value ack
and a
msgID
attribute whose value corresponds to the value of
id
attribute copied from the <msg> element in the response
that is being acknowledged.
Field Summary | |
---|---|
protected java.lang.String |
msgID
msgID attribute whose value corresponds to the value of id
attribute copied from the msg element in the response
that is being acknowledged. |
protected java.lang.String |
op
Operation "op" associated with the EPPPollCmd . |
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 | |
---|---|
EPPPollCmd()
Default constructor. |
|
EPPPollCmd(java.lang.String aTransId,
java.lang.String aOp)
EPPPollCmd that takes all required attributes as arguments
for a EPPPollCmd.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 | |
---|---|
java.lang.Object |
clone()
Clone EPPPollCmd . |
protected void |
doDecode(org.w3c.dom.Element aElement)
Must be defined by EPPPollCmd 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 by EPPPollCmd extensions (Command Mappings)
to encode the attributes to a DOM Element tree. |
protected void |
doGenDecode(org.w3c.dom.Element aElement)
Decodes the EPPPollCmd attributes from the
aElement DOM Element tree. |
protected org.w3c.dom.Element |
doGenEncode(org.w3c.dom.Document aDocument)
Encodes a DOM Element tree from the attributes of the EPPPollCmd 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 with EPPPollCmd . |
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, getExtension, getExtension, getExtensions, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String OP_REQ
public static final java.lang.String OP_ACK
protected java.lang.String op
EPPPollCmd
. This should
be equal to one of the EPPPollCmd.OP_
constants.
protected java.lang.String msgID
id
attribute copied from the msg
element in the response
that is being acknowledged.
Constructor Detail |
---|
public EPPPollCmd()
null
.
public EPPPollCmd(java.lang.String aTransId, java.lang.String aOp)
EPPPollCmd
that takes all required attributes as arguments
for a EPPPollCmd.OP_REQ
poll command. If aOp
is EPPPollCmd.OP_ACK
, the message id must be set with
setMsgId
before calling encode
.
aTransId
- Transaction Id associated with command.aOp
- One of the EPPPollCmd.OP_
constants.public EPPPollCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aMsgID)
EPPPollCmd
that takes attributes as arguments.
aTransId
- Transaction Id associated with command.aOp
- One of the EPPPollCmd.OP_
constants.aMsgID
- Message Id when operation
isEPPPollCmd.OP_ACK
.Method Detail |
---|
public java.lang.String getType()
getType
in class EPPCommand
EPPCommand.TYPE_POLL
public java.lang.String getOp()
EPPPollCmd
.
getOp
in class EPPCommand
EPPCommand.OP_
constants associated with
the poll command.public boolean equals(java.lang.Object aObject)
equals
in class EPPCommand
aObject
- Object to compare with.
protected org.w3c.dom.Element doGenEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPPollCmd
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.
doGenEncode
in class EPPCommand
aDocument
- - DOM Document that is being built. Used as an Element
factory.
EPPPollCmd
instance.
EPPEncodeException
- Unable to encode EPPPollCmd
instance.protected void doGenDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPPollCmd
attributes from the
aElement
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.
doGenDecode
in class EPPCommand
aElement
- - Root DOM Element to decode EPPPollCmd
from.
EPPDecodeException
- Unable to decode aElementpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPPollCmd
.
clone
in interface EPPCodecComponent
clone
in class EPPCommand
EPPPollCmd
java.lang.CloneNotSupportedException
- standard Object.clone exceptionprotected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPPollCmd
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.
aDocument
- - DOM Document that is being built. Used as an Element
factory.
EPPEncodeException
- Unable to encode EPPPollCmd extension
instance.protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPPollCmd
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.
aElement
- Root DOM Element representing the
EPPPollCmd
extension instance.
EPPDecodeException
- Unable to decode aElement
.public java.lang.String getMsgID()
public java.lang.String getNamespace()
EPPCodec.NS
.
getNamespace
in interface EPPMessage
getNamespace
in class EPPCommand
public void setMsgID(java.lang.String aMsgID)
aMsgID
- Message Id
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |