EPP 0.2.3

com.neulevel.epp.core.command
Class EppCommandPoll

java.lang.Object
  |
  +--com.neulevel.epp.core.EppEntity
        |
        +--com.neulevel.epp.core.command.EppCommand
              |
              +--com.neulevel.epp.core.command.EppCommandPoll

public class EppCommandPoll
extends EppCommand

This EppCommandPoll class implements EPP Command Poll entity.

Version:
$Revision$ $Date$
Author:
Ning Zhang ning.zhang@neustar.com

Field Summary
static java.lang.String OPTYPE_ACK
          Poll operation type for acknowledging the receiption of a message
static java.lang.String OPTYPE_REQ
          Poll operation type for polling existing messages (default)
 
Fields inherited from class com.neulevel.epp.core.command.EppCommand
clTRID, creds, unspec
 
Constructor Summary
EppCommandPoll()
          Creates an EppCommandPoll object, with default operation type as "req"
EppCommandPoll(java.lang.String xid)
          Creates an EppCommandPoll object, with default operation type as "req", given a client transaction id associated with operation
EppCommandPoll(java.lang.String operation, java.lang.String messageId)
          Creates an EppCommandPoll object, given the operation type and the message id.
EppCommandPoll(java.lang.String operation, java.lang.String messageId, java.lang.String xid)
          Creates an EppCommandPoll object, given the operation type and the message id and a client transaction id associated with operation
 
Method Summary
static EppEntity fromXML(org.w3c.dom.Node root)
          Converts an XML element into an EppCommandPoll object.
 java.lang.String getMessageId()
          Gets the message id related to the poll command
 java.lang.String getOperation()
          Gets the poll operation type
 void setMessageId(java.lang.String messageId)
          Sets the message id related to the poll command
 void setOperation(java.lang.String operation)
          Sets the poll operation type, either "req" or "ack"
 java.lang.String toString()
           
 org.w3c.dom.Element toXML(org.w3c.dom.Document doc, java.lang.String tag)
          Converts the EppCommandPoll object into an XML element
 
Methods inherited from class com.neulevel.epp.core.command.EppCommand
check, create, delete, getClientTransactionId, getCreds, getUnspec, info, renew, setClientTransactionId, setCreds, setUnspec, toXMLCommon, toXMLCommon, toXMLCommon, toXMLCommon, transfer, update
 
Methods inherited from class com.neulevel.epp.core.EppEntity
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OPTYPE_REQ

public static final java.lang.String OPTYPE_REQ
Poll operation type for polling existing messages (default)

OPTYPE_ACK

public static final java.lang.String OPTYPE_ACK
Poll operation type for acknowledging the receiption of a message
Constructor Detail

EppCommandPoll

public EppCommandPoll()
Creates an EppCommandPoll object, with default operation type as "req"

EppCommandPoll

public EppCommandPoll(java.lang.String xid)
Creates an EppCommandPoll object, with default operation type as "req", given a client transaction id associated with operation

EppCommandPoll

public EppCommandPoll(java.lang.String operation,
                      java.lang.String messageId)
Creates an EppCommandPoll object, given the operation type and the message id.

EppCommandPoll

public EppCommandPoll(java.lang.String operation,
                      java.lang.String messageId,
                      java.lang.String xid)
Creates an EppCommandPoll object, given the operation type and the message id and a client transaction id associated with operation
Method Detail

getOperation

public java.lang.String getOperation()
Gets the poll operation type

setOperation

public void setOperation(java.lang.String operation)
Sets the poll operation type, either "req" or "ack"

getMessageId

public java.lang.String getMessageId()
Gets the message id related to the poll command

setMessageId

public void setMessageId(java.lang.String messageId)
Sets the message id related to the poll command

fromXML

public static EppEntity fromXML(org.w3c.dom.Node root)
Converts an XML element into an EppCommandPoll object. The caller of this method must make sure that the root node is of an EPP Command Create entity.
Parameters:
root - root node for an EppCommandPoll object in XML format
Returns:
an EppCommandPoll object, or null if the node is invalid

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc,
                                 java.lang.String tag)
Converts the EppCommandPoll object into an XML element
Overrides:
toXML in class EppEntity
Parameters:
doc - the XML Document object
tag - the tag/element name for the EppCommandPoll object
Returns:
an Element object

toString

public java.lang.String toString()
Overrides:
toString in class EppEntity

EPP 0.2.3

Copyright © 2001 NeuStar, Inc. All Rights Reserved.