Package com.verisign.epp.codec.domain

Class EPPDomainRenewResp

java.lang.Object

com.verisign.epp.codec.gen.EPPResponse

com.verisign.epp.codec.domain.EPPDomainRenewResp

All Implemented Interfaces:

EPPCodecComponent, EPPMessage, Serializable, Cloneable

public class EPPDomainRenewResp
extends EPPResponse

Represents an EPP Domain <domain:renData> response to a EPPDomainRenewCmd. When a <renew> command has been processed successfully, the EPP <resData> element MUST contain a child <domain:renData> element that identifies the domain namespace and the location of the domain schema. The <domain:name> element contains the following child elements:

• A <domain:name> element that contains the fully qualified domain name that has been created or whose validity period has been extended. Use getName and setName to get and set the element.
• An OPTIONAL <domain:exDate> element that contains the end of the domain's validity period. Use getExpirationDate and setExpirationDate to get and set the element.

See Also:

• EPPDomainRenewCmd
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELM_LOCALNAME	XML local name for EPPDomainRenewResp.
static final String	ELM_NAME	XML Element Name of EPPDomainRenewResp 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
EPPDomainRenewResp()	EPPDomainRenewResp default constructor.
EPPDomainRenewResp(EPPTransId aTransId, String aName)	EPPDomainRenewResp constructor that takes the required attribute values as parameters.
EPPDomainRenewResp(EPPTransId aTransId, String aName, Date aExpirationDate)	EPPDomainRenewResp constructor that takes the required attribute values as parameters.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clone EPPDomainRenewResp.
protected void	doDecode(Element aElement)	Decode the EPPDomainRenewResp attributes from the aElement DOM Element tree.
protected Element	doEncode(Document aDocument)	Encode a DOM Element tree from the attributes of the EPPDomainRenewResp instance.
boolean	equals(Object aObject)	Compare an instance of EPPDomainRenewResp with this instance.
Date	getExpirationDate()	Gets the expiration date and time of the domain.
String	getName()	Gets the domain name
String	getNamespace()	Gets the EPP command Namespace associated with EPPDomainRenewResp.
String	getType()	Gets the EPP command type associated with EPPDomainRenewResp.
void	setExpirationDate(Date aExpirationDate)	Sets the expiration date and time of the domain.
void	setName(String aName)	Sets the domain name.
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, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ELM_LOCALNAME

public static final String ELM_LOCALNAME

XML local name for EPPDomainRenewResp.

See Also:

• Constant Field Values

ELM_NAME

public static final String ELM_NAME

XML Element Name of EPPDomainRenewResp root element.

See Also:

• Constant Field Values

Constructor Details

EPPDomainRenewResp

public EPPDomainRenewResp()

EPPDomainRenewResp default constructor. Must call required setter methods before encode. the defaults include the following:

• name is set to null
• expiration date is set to null

The name must be set before invoking encode.

EPPDomainRenewResp

public EPPDomainRenewResp(EPPTransId aTransId,
 String aName)

EPPDomainRenewResp constructor that takes the required attribute values as parameters.

Parameters:

aTransId - Transaction Id associated with response.

aName - Domain name

EPPDomainRenewResp

public EPPDomainRenewResp(EPPTransId aTransId,
 String aName,
 Date aExpirationDate)

EPPDomainRenewResp constructor that takes the required attribute values as parameters.

Parameters:

aTransId - transaction Id associated with response.

aName - domain name

aExpirationDate - expiration date of the domain

Method Details

getType

public String getType()

Gets the EPP command type associated with EPPDomainRenewResp.

Overrides:

getType in class EPPResponse

Returns:

EPPDomainRenewResp.ELM_NAME

getNamespace

public String getNamespace()

Gets the EPP command Namespace associated with EPPDomainRenewResp.

Specified by:

getNamespace in interface EPPCodecComponent

Specified by:

getNamespace in interface EPPMessage

Overrides:

getNamespace in class EPPResponse

Returns:

EPPDomainMapFactory.NS

equals

public boolean equals(Object aObject)

Compare an instance of EPPDomainRenewResp with this instance.

Overrides:

equals in class EPPResponse

Parameters:

aObject - Object to compare with.

Returns:

true when equal; false otherwise.

clone

public Object clone()
             throws CloneNotSupportedException

Clone EPPDomainRenewResp.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class EPPResponse

Returns:

clone of EPPDomainRenewResp

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.

getName

public String getName()

Gets the domain name

Returns:

Domain Name String instance if defined; null otherwise.

setName

public void setName(String aName)

Sets the domain name.

Parameters:

aName - Domain Name

getExpirationDate

public Date getExpirationDate()

Gets the expiration date and time of the domain.

Returns:

Expiration date and time of the domain if defined; null otherwise.

setExpirationDate

public void setExpirationDate(Date aExpirationDate)

Sets the expiration date and time of the domain.

Parameters:

aExpirationDate - Expiration date and time of the domain.

doEncode

protected Element doEncode(Document aDocument)
                    throws EPPEncodeException

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

Throws:

EPPEncodeException - Unable to encode EPPDomainRenewResp instance.

doDecode

protected void doDecode(Element aElement)
                 throws EPPDecodeException

Decode the EPPDomainRenewResp attributes from the aElement DOM Element tree.

Overrides:

doDecode in class EPPResponse

Parameters:

aElement - Root DOM Element to decode EPPDomainRenewResp from.

Throws:

EPPDecodeException - Unable to decode aElement