com.ausregistry.jtoolkit2.se

Class HostCheckCommand

java.lang.Object

com.ausregistry.jtoolkit2.se.Command

com.ausregistry.jtoolkit2.se.ObjectCommand

com.ausregistry.jtoolkit2.se.CheckCommand

com.ausregistry.jtoolkit2.se.HostCheckCommand

All Implemented Interfaces:

java.io.Serializable

public class HostCheckCommand
extends CheckCommand

A HostCheckCommand is used to check the availability of host objects in a Registry. Instances of this class generate RFC5730 and RFC5732 compliant host check EPP command service elements via the toXML method.

See Also:

HostCheckResponse, 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
HostCheckCommand(java.lang.String name) Check the availability of the single identified host.
HostCheckCommand(java.lang.String[] names) Check the availability of at least one host.

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

HostCheckCommand

public HostCheckCommand(java.lang.String name)

Check the availability of the single identified host.

Parameters:

name - The name of the host to check the availability of.

HostCheckCommand

public HostCheckCommand(java.lang.String[] names)

Check the availability of at least one host.

Parameters:

names - The names of the hosts to check the availability of.

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