com.ausregistry.jtoolkit2.se

Class InfoCommand

java.lang.Object

com.ausregistry.jtoolkit2.se.Command

com.ausregistry.jtoolkit2.se.ObjectCommand

com.ausregistry.jtoolkit2.se.InfoCommand

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ContactInfoCommand, DomainInfoCommand, FundInfoCommand, HostInfoCommand

public abstract class InfoCommand
extends ObjectCommand

Representation of the EPP info command, as defined in RFC5730. Subclasses of this must specify the object to which the command is mapped and specify the object-specific identifier of the object to request information about.

See Also:

InfoResponse, 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.ObjectCommand

objElement

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

cmdElement, command, extension

Constructor Summary

Constructors

Constructor and Description
InfoCommand(ObjectType objType) Create an info command mapped to the specified object type to retrieve information about the related object.
InfoCommand(ObjectType objType, java.lang.String ident) Create an info command mapped to the specified object type to retrieve information about the identified object.
InfoCommand(ObjectType objType, java.lang.String ident, java.lang.String pw) Create an info command mapped to the specified object type to retrieve information about the identified object.
InfoCommand(ObjectType objType, java.lang.String ident, java.lang.String roid, java.lang.String pw) Create an info command mapped to the specified object type to retrieve information about the identified object.
InfoCommand(StandardObjectType objType, java.lang.String ident, Attribute attribute)
InfoCommand(StandardObjectType objType, java.lang.String ident, java.lang.String pw, Attribute attribute)
InfoCommand(StandardObjectType objType, java.lang.String ident, java.lang.String roid, java.lang.String pw, Attribute attribute)

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

InfoCommand

public InfoCommand(ObjectType objType,
                   java.lang.String ident)

Create an info command mapped to the specified object type to retrieve information about the identified object.

Parameters:

objType - The type of object to which the info command is to be mapped.

ident - An object type-specific label identifying the object to retrieve information about.

InfoCommand

public InfoCommand(ObjectType objType)

Create an info command mapped to the specified object type to retrieve information about the related object.

Parameters:

objType - The type of object to which the info command is to be mapped.

InfoCommand

public InfoCommand(StandardObjectType objType,
                   java.lang.String ident,
                   Attribute attribute)

InfoCommand

public InfoCommand(ObjectType objType,
                   java.lang.String ident,
                   java.lang.String pw)

Create an info command mapped to the specified object type to retrieve information about the identified object.

Parameters:

objType - The type of object to which the info command is to be mapped.

ident - An object type-specific label identifying the object to retrieve information about.

pw - The password of the object to retrieve information about. This is used to retrieve complete information about an object when the object is sponsored by another client.

InfoCommand

public InfoCommand(StandardObjectType objType,
                   java.lang.String ident,
                   java.lang.String pw,
                   Attribute attribute)

InfoCommand

public InfoCommand(ObjectType objType,
                   java.lang.String ident,
                   java.lang.String roid,
                   java.lang.String pw)

Create an info command mapped to the specified object type to retrieve information about the identified object.

Parameters:

objType - The type of object to which the info command is to be mapped.

ident - An object type-specific label identifying the object to retrieve information about.

roid - The Repository Object Identifer of an object associated with the object to be queried.

pw - The password of the object to retrieve information about. This is used to retrieve complete information about an object when the object is sponsored by another client.

InfoCommand

public InfoCommand(StandardObjectType objType,
                   java.lang.String ident,
                   java.lang.String roid,
                   java.lang.String pw,
                   Attribute attribute)

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