com.ausregistry.jtoolkit2.se

Class PollAckCommand

java.lang.Object

com.ausregistry.jtoolkit2.se.Command

com.ausregistry.jtoolkit2.se.PollCommand

com.ausregistry.jtoolkit2.se.PollAckCommand

All Implemented Interfaces:

java.io.Serializable

public class PollAckCommand
extends PollCommand

Use this command to acknowledge receipt of a service message previously retrieved via a poll request. This dequeues the message and makes the next message available for retrieval. From RFC5730:

After a messages has been 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 the message and decrement the queue counter after receiving acknowledgement from the client, making the next message in the queue (if any) available for retrieval.

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
PollAckCommand(java.lang.String msgID)

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

PollAckCommand

public PollAckCommand(java.lang.String msgID)

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