com.ausregistry.jtoolkit2.se

Class ObjectCommand

java.lang.Object

com.ausregistry.jtoolkit2.se.Command

com.ausregistry.jtoolkit2.se.ObjectCommand

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CheckCommand, CreateCommand, DeleteCommand, DomainRenewCommand, InfoCommand, ProtocolExtensionCommand, TransferCommand, UpdateCommand

public abstract class ObjectCommand
extends Command

Superclass of all command classes which implement an object-mapped EPP command such as create, delete, update, transfer, info and check. Non-abstract subclasses must specify the command and object type, and not expose assignment of those to the user.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.w3c.dom.Element	objElement
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
ObjectCommand(CommandType commandType, ObjectType objectType) Construct the DOM tree component common to all object-mapped commands which operates on objects related to user.
ObjectCommand(CommandType commandType, ObjectType objectType, java.lang.String ident) Construct the DOM tree component common to all object-mapped commands which operate on a single object.
ObjectCommand(CommandType commandType, ObjectType objectType, java.lang.String[] idents) Construct the DOM tree component common to all object-mapped commands which take multiple object identifiers as parameters.
ObjectCommand(CommandType commandType, ObjectType objectType, java.lang.String ident, java.lang.String attrName, java.lang.String attrValue) Construct the DOM tree component common to all object-mapped commands which operate on a single object, and assign it the attribute name and value.

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

objElement

protected org.w3c.dom.Element objElement

xmlWriter

protected final transient XMLWriter xmlWriter

userLogger

protected final transient java.util.logging.Logger userLogger

Constructor Detail

ObjectCommand

public ObjectCommand(CommandType commandType,
                     ObjectType objectType,
                     java.lang.String[] idents)

Construct the DOM tree component common to all object-mapped commands which take multiple object identifiers as parameters.

Throws:

java.lang.IllegalArgumentException - if objectType or idents are null, or if idents is empty.

ObjectCommand

public ObjectCommand(CommandType commandType,
                     ObjectType objectType,
                     java.lang.String ident)

Construct the DOM tree component common to all object-mapped commands which operate on a single object.

Throws:

java.lang.IllegalArgumentException - if objectType or ident are null.

ObjectCommand

public ObjectCommand(CommandType commandType,
                     ObjectType objectType)

Construct the DOM tree component common to all object-mapped commands which operates on objects related to user.

Throws:

java.lang.IllegalArgumentException - if objectType is null.

ObjectCommand

public ObjectCommand(CommandType commandType,
                     ObjectType objectType,
                     java.lang.String ident,
                     java.lang.String attrName,
                     java.lang.String attrValue)

Construct the DOM tree component common to all object-mapped commands which operate on a single object, and assign it the attribute name and value.

Throws:

java.lang.IllegalArgumentException - if objectType or ident are null.

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