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

Class EPPAuthTokenInfoResp

java.lang.Object

com.verisign.epp.codec.gen.EPPResponse

com.verisign.epp.codec.authtoken.v01.EPPAuthTokenInfoResp

All Implemented Interfaces:

EPPCodecComponent, EPPMessage, Serializable, Cloneable

public class EPPAuthTokenInfoResp
extends EPPResponse

Represents an EPP Auth Token <authToken:infData> response that is used in the authToken info message. The <authToken:infData> element contains the following child elements:

• A <authToken:authToken> element that contains the authentication token passed.
• A <authToken:status> element that contains status of the authToken like active, expired, revoked etc.
• A <authToken:crDate> element that contains the date and time of the authentication token creation.
• A <authToken:exDate> element that contains the date and time of the authentication token expiration.
• A <authToken:revokedDate> element that contains the date and time of the authentication token revocation.
• A <authToken:revokedID> element that contains the identifier of the client that revoked the authentication token.
• A <authToken:revokedReason> element that contains the freeform reason for authentication token revocation.

See Also:

• Serialized Form

Field Summary

Fields

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

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

ELM_EXTENSION, ELM_MESSAGE_QUEUE, ELM_MESSAGE_QUEUE_QDATE, ELM_RESPONSE_DATA, extensions, TRANSFER_CLIENT_APPROVED, TRANSFER_CLIENT_CANCELLED, TRANSFER_CLIENT_REJECTED, TRANSFER_PENDING, TRANSFER_SERVER_APPROVED, TRANSFER_SERVER_CANCELLED

Constructor Summary

Constructors

Constructor	Description
EPPAuthTokenInfoResp()	EPPAuthTokenInfoResp default constructor.
EPPAuthTokenInfoResp(EPPTransId aTransId, EPPAuthTokenData aAuthToken, String aStatus)	EPPAuthTokenInfoResp constructor that takes the required attribute values as parameters.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clone EPPAuthTokenInfoResp.
protected void	doDecode(Element aElement)	Decode the EPPAuthTokenInfoResp attributes from the aElement DOM Element tree.
protected Element	doEncode(Document aDocument)	Encode a DOM Element tree from the attributes of the EPPAuthTokenInfoResp instance.
boolean	equals(Object aObject)	Compare an instance of EPPAuthTokenInfoResp with this instance.
EPPAuthTokenData	getAuthToken()	Gets the authentication token data
Date	getCreatedDate()	Gets the date and time of the submitted <create> command.
Date	getExpirationDate()	Gets the expiration date of this token
String	getNamespace()	Gets the EPP command namespace associated with EPPAuthTokenInfoResp.
Date	getRevokedDate()	Gets the revocation date
String	getRevokedId()	Gets identifier of the client that revoked the auth token.
String	getRevokedReason()	Gets the revoked reason
String	getStatus()	Gets the status of this token
String	getType()	Gets the EPP response type associated with EPPAuthTokenInfoResp .
int	hashCode()
void	setAuthToken(EPPAuthTokenData aAuthToken)	Set the authentication token data.
void	setCreatedDate(Date aDate)	Sets the date and time of the submitted <create> command.
void	setExpirationDate(Date aExpirationDate)	Sets the expiration date
void	setRevokedDate(Date aRevokedDate)	Sets the revocation date
void	setRevokedId(String aRequestedId)	Sets identifier of the client that revoked the auth token.
void	setRevokedReason(String aRevokedReason)	Sets the revoked reason
void	setStatus(String aStatus)	Set the status of this token (e.g.
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.EPPResponse

addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getMessageQueue, getMsgQueue, getMsgQueueCount, getMsgQueueDate, getMsgQueueMsg, getQDate, getResult, getResults, getTransId, hasExtension, hasExtensions, hasMessageQueue, hasMsgQueue, hasResultCode, isSuccess, setExtension, setExtensions, setMsgQueue, setResult, setResult, setResult, setResult, setResults, setTransId

Methods inherited from class java.lang.Object

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

Field Details

ELM_LOCALNAME

public static final String ELM_LOCALNAME

XML local name for EPPAuthTokenInfoResp.

See Also:

• Constant Field Values

ELM_NAME

public static final String ELM_NAME

XML Element Name of EPPAuthTokenInfoResp root element.

See Also:

• Constant Field Values

Constructor Details

EPPAuthTokenInfoResp

public EPPAuthTokenInfoResp()

EPPAuthTokenInfoResp default constructor. Must call required setter methods before invoking encode, which include:

• name - setName

EPPAuthTokenInfoResp

public EPPAuthTokenInfoResp(EPPTransId aTransId,
 EPPAuthTokenData aAuthToken,
 String aStatus)

EPPAuthTokenInfoResp constructor that takes the required attribute values as parameters.

Parameters:

aTransId - Transaction Id associated with response.

aAuthToken - EPPAuthTokenData instance

aStatus - status of the auth token

Method Details

getType

public String getType()

Gets the EPP response type associated with EPPAuthTokenInfoResp .

Overrides:

getType in class EPPResponse

Returns:

EPPAuthTokenInfoResp.ELM_NAME

getNamespace

public String getNamespace()

Gets the EPP command namespace associated with EPPAuthTokenInfoResp.

Specified by:

getNamespace in interface EPPCodecComponent

Specified by:

getNamespace in interface EPPMessage

Overrides:

getNamespace in class EPPResponse

Returns:

EPPAuthTokenMapFactory.NS

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object aObject)

Compare an instance of EPPAuthTokenInfoResp with this instance.

Overrides:

equals in class EPPResponse

Parameters:

aObject - Object to compare with.

Returns:

true if equal; false otherwise.

clone

public Object clone()
             throws CloneNotSupportedException

Clone EPPAuthTokenInfoResp.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class EPPResponse

Returns:

clone of EPPAuthTokenInfoResp

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 EPPResponse

Returns:

Indented XML String if successful; ERROR otherwise.

getRevokedId

public String getRevokedId()

Gets identifier of the client that revoked the auth token.

Returns:

identifier of the client that revoked the auth token if defined; null otherwise.

setRevokedId

public void setRevokedId(String aRequestedId)

Sets identifier of the client that revoked the auth token.

Parameters:

aRequestedId - Identifier of the client that revoked the auth token.

getCreatedDate

public Date getCreatedDate()

Gets the date and time of the submitted <create> command.

Returns:

Date and time of the submitted <create> command if defined; null otherwise.

setCreatedDate

public void setCreatedDate(Date aDate)

Sets the date and time of the submitted <create> command.

Parameters:

aDate - Date and time of the submitted <create> command

getAuthToken

public EPPAuthTokenData getAuthToken()

Gets the authentication token data

Returns:

an instance of EPPAuthTokenData

setAuthToken

public void setAuthToken(EPPAuthTokenData aAuthToken)

Set the authentication token data.

Parameters:

aAuthToken - an instance of EPPAuthTokenData

getStatus

public String getStatus()

Gets the status of this token

Returns:

setStatus

public void setStatus(String aStatus)

Set the status of this token (e.g. revoked, expired etc.)

Parameters:

aStatus - status of this token

getExpirationDate

public Date getExpirationDate()

Gets the expiration date of this token

Returns:

instance of java.util.Date

setExpirationDate

public void setExpirationDate(Date aExpirationDate)

Sets the expiration date

Parameters:

aExpirationDate - expiration date to set

getRevokedDate

public Date getRevokedDate()

Gets the revocation date

Returns:

instance of java.util.Date

setRevokedDate

public void setRevokedDate(Date aRevokedDate)

Sets the revocation date

Parameters:

aRevokedDate - revocation date to set

getRevokedReason

public String getRevokedReason()

Gets the revoked reason

Returns:

reason for which this token is revoked

setRevokedReason

public void setRevokedReason(String aRevokedReason)

Sets the revoked reason

Parameters:

aRevokedReason - reason for which this token is revoked

doEncode

protected Element doEncode(Document aDocument)
                    throws EPPEncodeException

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

Overrides:

doEncode in class EPPResponse

Parameters:

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

Returns:

Element Root DOM Element representing the EPPAuthTokenInfoResp instance.

Throws:

EPPEncodeException - Unable to encode EPPAuthTokenInfoResp instance.

doDecode

protected void doDecode(Element aElement)
                 throws EPPDecodeException

Decode the EPPAuthTokenInfoResp attributes from the aElement DOM Element tree.

Overrides:

doDecode in class EPPResponse

Parameters:

aElement - Root DOM Element to decode EPPAuthTokenInfoResp from.

Throws:

EPPDecodeException - Unable to decode aElement