com.verisign.epp.codec.host

Class EPPHostInfoCmd

java.lang.Object

com.verisign.epp.codec.gen.EPPCommand

com.verisign.epp.codec.gen.EPPInfoCmd

com.verisign.epp.codec.host.EPPHostInfoCmd

All Implemented Interfaces:

EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable

public class EPPHostInfoCmd
extends EPPInfoCmd

Represents an EPP Host <info> command that is used to retrieve information associated with a host. The <host:info> element MUST contain the following child elements:

• A <host:name> element that contains the fully qualified host name for which information is requested. Use getName and setName to get and set the element.

EPPHostInfoResp is the concrete EPPReponse associated with EPPHostInfoCmd.

See Also:

EPPHostInfoResp, Serialized Form

Field Summary

Fields inherited from class com.verisign.epp.codec.gen.EPPCommand

extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE

Constructor Summary

Constructors

Constructor and Description
EPPHostInfoCmd() EPPHostInfoCmd default constructor.
EPPHostInfoCmd(java.lang.String aTransId, java.lang.String aName) EPPHostInfoCmd constructor that takes the host name as an argument.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone EPPHostInfoCmd.
protected void	doDecode(org.w3c.dom.Element aElement) Decode the EPPHostInfoCmd attributes from the aElement DOM Element tree.
protected org.w3c.dom.Element	doEncode(org.w3c.dom.Document aDocument) Encode a DOM Element tree from the attributes of the EPPHostInfoCmd instance.
boolean	equals(java.lang.Object aObject) Compare an instance of EPPHostInfoCmd with this instance.
java.lang.String	getName() Gets the host name to get information on.
java.lang.String	getNamespace() Gets the EPP command Namespace associated with EPPHostInfoCmd.
void	setName(java.lang.String aName) Sets the host name to get information on.
java.lang.String	toString() Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Methods inherited from class com.verisign.epp.codec.gen.EPPInfoCmd

doGenDecode, doGenEncode, getType

Methods inherited from class com.verisign.epp.codec.gen.EPPCommand

addExtension, decode, encode, findDuplicateExtNamespaces, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EPPHostInfoCmd

public EPPHostInfoCmd()

EPPHostInfoCmd default constructor. The name is initialized to null. The name must be set before invoking encode.

EPPHostInfoCmd

public EPPHostInfoCmd(java.lang.String aTransId,
                      java.lang.String aName)

EPPHostInfoCmd constructor that takes the host name as an argument.

Parameters:

aTransId - Transaction Id associated with command.

aName - Host name to get information on.

Method Detail

getNamespace

public java.lang.String getNamespace()

Gets the EPP command Namespace associated with EPPHostInfoCmd.

Specified by:

getNamespace in interface EPPCodecComponent

Specified by:

getNamespace in interface EPPMessage

Specified by:

getNamespace in class EPPCommand

Returns:

EPPHostMapFactory.NS

doEncode

protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument)
                                throws EPPEncodeException

Encode a DOM Element tree from the attributes of the EPPHostInfoCmd instance.

Specified by:

doEncode in class EPPInfoCmd

Parameters:

aDocument - DOM Document that is being built. Used as an Element factory.

Returns:

Root DOM Element representing the EPPHostInfoCmd instance.

Throws:

EPPEncodeException - Unable to encode EPPHostInfoCmd instance.

doDecode

protected void doDecode(org.w3c.dom.Element aElement)
                 throws EPPDecodeException

Decode the EPPHostInfoCmd attributes from the aElement DOM Element tree.

Specified by:

doDecode in class EPPInfoCmd

Parameters:

aElement - Root DOM Element to decode EPPHostInfoCmd from.

Throws:

EPPDecodeException - Unable to decode aElement

getName

public java.lang.String getName()

Gets the host name to get information on.

Returns:

Host Name String instance if defined; null otherwise.

setName

public void setName(java.lang.String aName)

Sets the host name to get information on.

Parameters:

aName - Host Name

equals

public boolean equals(java.lang.Object aObject)

Compare an instance of EPPHostInfoCmd with this instance.

Overrides:

equals in class EPPInfoCmd

Parameters:

aObject - Object to compare with.

Returns:

DOCUMENT ME!

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone EPPHostInfoCmd.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class EPPCommand

Returns:

clone of EPPHostInfoCmd

Throws:

java.lang.CloneNotSupportedException - standard Object.clone exception

toString

public java.lang.String toString()

Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:

toString in class EPPCommand

Returns:

Indented XML String if successful; ERROR otherwise.