com.ausregistry.jtoolkit2.se

Class Command

java.lang.Object

com.ausregistry.jtoolkit2.se.Command

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DomainRegistrantTransferCommand, LoginCommand, LogoutCommand, ObjectCommand, PollCommand

public abstract class Command
extends java.lang.Object

Standard and extension EPP command service elements are modelled by subclasses of the Command class. All such classes provide the means to serialize their data to XML format as a valid EPP command, as well as constructors sufficiently flexible to create any valid EPP command of that type, and a method to query the type of command represented by an instance of the class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.w3c.dom.Element	cmdElement
protected org.w3c.dom.Element	command
protected org.w3c.dom.Element	extension
protected java.util.logging.Logger	userLogger
protected XMLWriter	xmlWriter

Constructor Summary

Constructors

Constructor and Description
Command(CommandType commandType)

Method Summary

Modifier and Type	Method and Description
int	appendExtension(CommandExtension ce)
CommandType	getCommandType()
org.w3c.dom.Element	getExtensionElement()
XMLWriter	getXmlWriter()
protected void	initCmdElement()
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.
protected java.lang.String	toXMLImpl(XmlOutputConfig xmlOutputConfig) Serialize the EPP command service element to XML.

Methods inherited from class java.lang.Object

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

Field Detail

cmdElement

protected org.w3c.dom.Element cmdElement

command

protected org.w3c.dom.Element command

extension

protected org.w3c.dom.Element extension

xmlWriter

protected final transient XMLWriter xmlWriter

userLogger

protected final transient java.util.logging.Logger userLogger

Constructor Detail

Command

public Command(CommandType commandType)

Throws:

java.lang.IllegalArgumentException - if commandType is null.

Method Detail

getExtensionElement

public org.w3c.dom.Element getExtensionElement()

initCmdElement

protected void initCmdElement()

getCommandType

public CommandType getCommandType()

toXMLImpl

protected java.lang.String toXMLImpl(XmlOutputConfig xmlOutputConfig)
                              throws org.xml.sax.SAXException

Serialize the EPP command service element to XML.

Throws:

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

appendExtension

public int appendExtension(CommandExtension ce)

getXmlWriter

public XMLWriter getXmlWriter()

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