com.ausregistry.jtoolkit2.se

Class PollRequestCommand

java.lang.Object

com.ausregistry.jtoolkit2.se.Command

com.ausregistry.jtoolkit2.se.PollCommand

com.ausregistry.jtoolkit2.se.PollRequestCommand

All Implemented Interfaces:

java.io.Serializable

public class PollRequestCommand
extends PollCommand

Use this command to poll the EPP server for the first message in the client's message queue maintained by the server. From RFC5730:

The EPP <poll> command is used to discover and retrieve service messages queued by a server for individual clients. If the message queue is not empty, a successful response to a <poll> command MUST return the first message from the message queue. Each response 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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	userLogger
protected XMLWriter	xmlWriter

Fields inherited from class com.ausregistry.jtoolkit2.se.Command

cmdElement, command, extension

Constructor Summary

Constructors

Constructor and Description
PollRequestCommand()

Method Summary

Modifier and Type	Method and Description
java.lang.String	toXML() Serialize the EPP service element to XML.
java.lang.String	toXML(XmlOutputConfig outputConfig) Serialize the EPP service element to XML using the given output config.

Methods inherited from class com.ausregistry.jtoolkit2.se.Command

appendExtension, getCommandType, getExtensionElement, getXmlWriter, initCmdElement, toXMLImpl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

xmlWriter

protected final transient XMLWriter xmlWriter

userLogger

protected final transient java.util.logging.Logger userLogger

Constructor Detail

PollRequestCommand

public PollRequestCommand()

Method Detail

toXML

public final java.lang.String toXML()
                             throws org.xml.sax.SAXException

Serialize the EPP service element to XML. This MUST be called prior to attempting to use Java serialization on this object. Failure to do so will result in NullPointerException when toXML is called after deserializing the object.

Returns:

XML content as string literal

Throws:

org.xml.sax.SAXException - The XML representation of the command failed schema validation. Further attempts to serialize this command will also fail.

See Also:

toXML

toXML

public final java.lang.String toXML(XmlOutputConfig outputConfig)
                             throws org.xml.sax.SAXException

Serialize the EPP service element to XML using the given output config.

Parameters:

outputConfig - a configuration that indicates how to output the XML

Returns:

XML content as string literal

Throws:

org.xml.sax.SAXException

See Also:

XmlOutputConfig