com.verisign.epp.codec.host

Class EPPHostDeleteCmd

java.lang.Object

com.verisign.epp.codec.gen.EPPCommand

com.verisign.epp.codec.gen.EPPDeleteCmd

com.verisign.epp.codec.host.EPPHostDeleteCmd

All Implemented Interfaces:

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

public class EPPHostDeleteCmd
extends EPPDeleteCmd

Represents an EPP Host <delete> command that allows a client to delete a host object. The EPP <delete> command provides a transform operation that allows a client to delete a host object. In addition to the standard EPP command elements, the <delete> command MUST contain a <host:delete> element that identifies the host namespace and the location of the host schema. The <host:delete> element SHALL contain the following child elements:
A <host:name> element that contains the fully qualified name of the host object to be deleted. Use getName and setName to get and set the element.

A host name object MUST NOT be deleted if the host object is associated with any other object. For example, if the host object is associated with a domain object, the host object MUST NOT be deleted until the existing association has been broken.
EPPReponse is the response associated with EPPHostDeleteCmd.

Version:

$Revision: 1.2 $

Author:

$Author: jim $

See Also:

EPPResponse, 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
EPPHostDeleteCmd() EPPHostDeleteCmd default constructor.
EPPHostDeleteCmd(java.lang.String aTransId, java.lang.String aName) EPPHostDeleteCmd constructor that takes the host name as an argument.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone EPPHostDeleteCmd.
protected void	doDecode(org.w3c.dom.Element aElement) Decode the EPPHostDeleteCmd 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 EPPHostDeleteCmd instance.
boolean	equals(java.lang.Object aObject) Compare an instance of EPPHostDeleteCmd with this instance.
java.lang.String	getName() Gets the host name to delete.
java.lang.String	getNamespace() Gets the EPP command Namespace associated with EPPHostDeleteCmd.
void	setName(java.lang.String aName) Sets the host name to delete.
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.EPPDeleteCmd

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

EPPHostDeleteCmd

public EPPHostDeleteCmd()

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

EPPHostDeleteCmd

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

EPPHostDeleteCmd constructor that takes the host name as an argument.

Parameters:

aTransId - Transaction Id associated with command.

aName - Host name to delete.

Method Detail

getNamespace

public java.lang.String getNamespace()

Gets the EPP command Namespace associated with EPPHostDeleteCmd.

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

Specified by:

doEncode in class EPPDeleteCmd

Parameters:

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

Returns:

Root DOM Element representing the EPPHostDeleteCmd instance.

Throws:

EPPEncodeException - Unable to encode EPPHostDeleteCmd instance.

doDecode

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

Decode the EPPHostDeleteCmd attributes from the aElement DOM Element tree.

Specified by:

doDecode in class EPPDeleteCmd

Parameters:

aElement - Root DOM Element to decode EPPHostDeleteCmd from.

Throws:

EPPDecodeException - Unable to decode aElement

getName

public java.lang.String getName()

Gets the host name to delete.

Returns:

Host Name String instance if defined; null otherwise.

setName

public void setName(java.lang.String aName)

Sets the host name to delete.

Parameters:

aName - Host Name

equals

public boolean equals(java.lang.Object aObject)

Compare an instance of EPPHostDeleteCmd with this instance.

Overrides:

equals in class EPPDeleteCmd

Parameters:

aObject - Object to compare with.

Returns:

DOCUMENT ME!

clone

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

Clone EPPHostDeleteCmd.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class EPPCommand

Returns:

clone of EPPHostDeleteCmd

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.