com.verisign.epp.codec.host
Class EPPHostCheckCmd

java.lang.Object
  com.verisign.epp.codec.gen.EPPCommand
      com.verisign.epp.codec.gen.EPPCheckCmd
          com.verisign.epp.codec.host.EPPHostCheckCmd

All Implemented Interfaces:

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

public class EPPHostCheckCmd
extends EPPCheckCmd

Represents an EPP Host <check> command, which is used to determine if a host name is known to the server. The <host:check> element MUST contain the following child elements:

• One or more <host:name> elements that contain the fully qualified name of the queried hosts. Use getNames and setNames to get and set the elements. Use setNames to set an individual name.

EPPHostCheckResp is the concrete EPPReponse associated with EPPHostCheckCmd.

Version:

$Revision: 1.2 $

Author:

$Author: jim $

See Also:

EPPHostCheckResp, 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

EPPHostCheckCmd()
EPPHostCheckCmd default constructor.

EPPHostCheckCmd(java.lang.String aTransId, java.lang.String aName)
EPPHostCheckCmd constructor that will check an individual host name.

EPPHostCheckCmd(java.lang.String aTransId, java.util.Vector someNames)
EPPHostCheckCmd constructor that will check a list of host names.

Method Summary

java.lang.Object	clone() Clone EPPHostCheckCmd.
protected void	doDecode(org.w3c.dom.Element aElement) Decode the EPPHostCheckCmd 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 EPPHostCheckCmd instance.
boolean	equals(java.lang.Object aObject) Compare an instance of EPPHostCheckCmd with this instance.
java.util.Vector	getNames() Gets host names to check.
java.lang.String	getNamespace() Gets the EPP command Namespace associated with EPPHostCheckCmd.
void	setName(java.lang.String aName) Sets host name to check.
void	setNames(java.util.Vector someNames) Sets host names to check.
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.EPPCheckCmd

doGenDecode, doGenEncode, getType

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

addExtension, decode, encode, 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

EPPHostCheckCmd

public EPPHostCheckCmd()

EPPHostCheckCmd default constructor. It will set the names attribute to an empty Vector.

EPPHostCheckCmd

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

EPPHostCheckCmd constructor that will check an individual host name.

Parameters:

aTransId - Transaction Id associated with command.

aName - Host name to check

EPPHostCheckCmd

public EPPHostCheckCmd(java.lang.String aTransId,
                       java.util.Vector someNames)

EPPHostCheckCmd constructor that will check a list of host names.

Parameters:

aTransId - Transaction Id associated with command.

someNames - Vector of host name String instances.

Method Detail

getNamespace

public java.lang.String getNamespace()

Gets the EPP command Namespace associated with EPPHostCheckCmd.

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 EPPHostCheckCmd instance.

Specified by:

doEncode in class EPPCheckCmd

Parameters:

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

Returns:

Element Root DOM Element representing the EPPHostCheckCmd instance.

Throws:

EPPEncodeException - Unable to encode EPPHostCheckCmd instance.

doDecode

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

Decode the EPPHostCheckCmd attributes from the aElement DOM Element tree.

Specified by:

doDecode in class EPPCheckCmd

Parameters:

aElement - Root DOM Element to decode EPPHostCheckCmd from.

Throws:

EPPDecodeException - Unable to decode aElement

equals

public boolean equals(java.lang.Object aObject)

Compare an instance of EPPHostCheckCmd with this instance.

Overrides:

equals in class EPPCheckCmd

Parameters:

aObject - Object to compare with.

Returns:

DOCUMENT ME!

clone

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

Clone EPPHostCheckCmd.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class EPPCommand

Returns:

clone of EPPHostCheckCmd

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.

setName

public void setName(java.lang.String aName)

Sets host name to check.

Parameters:

aName - Name to check.

getNames

public java.util.Vector getNames()

Gets host names to check.

Returns:

Vector of host name String's.

setNames

public void setNames(java.util.Vector someNames)

Sets host names to check.

Parameters:

someNames - Names to check.