Package com.verisign.epp.codec.domain

Class EPPDomainRenewResp

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.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 Detail

      • ELM_LOCALNAME

        public static final java.lang.String ELM_LOCALNAME
        XML local name for EPPDomainRenewResp.
        See Also:
        Constant Field Values

      • ELM_NAME

        public static final java.lang.String ELM_NAME
        XML Element Name of EPPDomainRenewResp root element.
        See Also:
        Constant Field Values

    • Constructor Detail

      • 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,
                          java.lang.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,
                          java.lang.String aName,
                          java.util.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 Detail

      • getType

        public java.lang.String getType()
        Gets the EPP command type associated with EPPDomainRenewResp.
        Overrides:
        getType in class EPPResponse
        Returns:
        EPPDomainRenewResp.ELM_NAME

      • equals

        public boolean equals​(java.lang.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 java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Clone EPPDomainRenewResp.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class EPPResponse
        Returns:
        clone of EPPDomainRenewResp
        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 EPPResponse
        Returns:
        Indented XML String if successful; ERROR otherwise.

      • getName

        public java.lang.String getName()
        Gets the domain name
        Returns:
        Domain Name String instance if defined; null otherwise.

      • setName

        public void setName​(java.lang.String aName)
        Sets the domain name.
        Parameters:
        aName - Domain Name

      • getExpirationDate

        public java.util.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​(java.util.Date aExpirationDate)
        Sets the expiration date and time of the domain.
        Parameters:
        aExpirationDate - Expiration date and time of the domain.

      • doEncode

        protected org.w3c.dom.Element doEncode​(org.w3c.dom.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​(org.w3c.dom.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