Package com.verisign.epp.codec.authtoken.v01

Class EPPAuthTokenDeleteCmd

java.lang.Object

com.verisign.epp.codec.gen.EPPCommand

com.verisign.epp.codec.gen.EPPDeleteCmd

com.verisign.epp.codec.authtoken.v01.EPPAuthTokenDeleteCmd

All Implemented Interfaces:

EPPCodecComponent, EPPMessage, Serializable, Cloneable

public class EPPAuthTokenDeleteCmd
extends EPPDeleteCmd

Represents an EPP AuthToken <delete> command that allows a client to delete an authToken object. The EPP <delete> command provides a transform operation that allows a client to delete an authToken object. In addition to the standard EPP command elements, the <delete> command MUST contain a <authToken:delete< element that identifies the domain namespace and the location of the authToken schema.

• An <authToken:authToken> element that contains the authToken to be deleted. Use getName and setName to get and set the element.

EPPReponse is the response associated with EPPAuthTokenDeleteCmd.

See Also:

• EPPResponse
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELM_LOCALNAME	XML local name for EPPAuthTokenDeleteCmd.
static final String	ELM_NAME	XML Element Name of EPPAuthTokenDeleteCmd root element.

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	Description
EPPAuthTokenDeleteCmd()	Allocates a new EPPAuthTokenDeleteCmd with default attribute values, which are all set to null.
EPPAuthTokenDeleteCmd(String aTransId, EPPAuthTokenData aAuthToken)	EPPAuthTokenDeleteCmd constructor with all the required attributes without the revokedReason, which can be set with setRevokedReason(String).

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clone EPPAuthTokenDeleteCmd.
protected void	doDecode(Element aElement)	Decode the EPPAuthTokenDeleteCmd attributes from the aElement DOM Element tree.
protected Element	doEncode(Document aDocument)	Encode a DOM Element tree from the attributes of the EPPAuthTokenDeleteCmd instance.
boolean	equals(Object aObject)	Compare an instance of EPPAuthTokenDeleteCmd with this instance.
EPPAuthTokenData	getAuthenticationToken()	Get the authentication token data.
String	getNamespace()	Get the EPP command Namespace associated with EPPAuthTokenDeleteCmd.
String	getRevokedReason()	Get the revoked reason for this delete operation.
void	setAuthToken(EPPAuthTokenData aAuthToken)	Set the authentication token data.
void	setRevokedReason(String aRevokedReason)	Set the revoked reason for this delete operation.
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, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getKey, getOp, getTransId, hasExtension, hasExtensions, hasKey, hasTransId, setExtension, setExtensions, setTransId

Methods inherited from class java.lang.Object

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

Field Details

ELM_LOCALNAME

public static final String ELM_LOCALNAME

XML local name for EPPAuthTokenDeleteCmd.

See Also:

• Constant Field Values

ELM_NAME

public static final String ELM_NAME

XML Element Name of EPPAuthTokenDeleteCmd root element.

See Also:

• Constant Field Values

Constructor Details

EPPAuthTokenDeleteCmd

public EPPAuthTokenDeleteCmd()

Allocates a new EPPAuthTokenDeleteCmd with default attribute values, which are all set to null.

EPPAuthTokenDeleteCmd

public EPPAuthTokenDeleteCmd(String aTransId,
 EPPAuthTokenData aAuthToken)

EPPAuthTokenDeleteCmd constructor with all the required attributes without the revokedReason, which can be set with setRevokedReason(String).

Parameters:

aTransId - Transaction Id associated with command.

aAuthToken - authentication token to delete.

Method Details

getNamespace

public String getNamespace()

Get the EPP command Namespace associated with EPPAuthTokenDeleteCmd.

Specified by:

getNamespace in interface EPPCodecComponent

Specified by:

getNamespace in interface EPPMessage

Specified by:

getNamespace in class EPPCommand

Returns:

EPPAuthTokenMapFactory.NS

getAuthenticationToken

public EPPAuthTokenData getAuthenticationToken()

Get the authentication token data.

Returns:

EPPAuthTokenData instance

setAuthToken

public void setAuthToken(EPPAuthTokenData aAuthToken)

Set the authentication token data.

Parameters:

aAuthToken - Authentication Token

getRevokedReason

public String getRevokedReason()

Get the revoked reason for this delete operation.

Returns:

revoked reason

setRevokedReason

public void setRevokedReason(String aRevokedReason)

Set the revoked reason for this delete operation.

Parameters:

aRevokedReason - revoked reason

equals

public boolean equals(Object aObject)

Compare an instance of EPPAuthTokenDeleteCmd with this instance.

Overrides:

equals in class EPPDeleteCmd

Parameters:

aObject - Object to compare with.

Returns:

true if equal; false otherwise.

clone

public Object clone()
             throws CloneNotSupportedException

Clone EPPAuthTokenDeleteCmd.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class EPPCommand

Returns:

clone of EPPAuthTokenDeleteCmd

Throws:

CloneNotSupportedException - standard Object.clone exception

toString

public 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.

doEncode

protected Element doEncode(Document aDocument)
                    throws EPPEncodeException

Encode a DOM Element tree from the attributes of the EPPAuthTokenDeleteCmd 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 EPPAuthTokenDeleteCmd instance.

Throws:

EPPEncodeException - Unable to encode EPPAuthTokenDeleteCmd instance.

doDecode

protected void doDecode(Element aElement)
                 throws EPPDecodeException

Decode the EPPAuthTokenDeleteCmd attributes from the aElement DOM Element tree.

Specified by:

doDecode in class EPPDeleteCmd

Parameters:

aElement - Root DOM Element to decode EPPAuthTokenDeleteCmd from.

Throws:

EPPDecodeException - Unable to decode aElement