Package com.verisign.epp.codec.ttl.v1_0

Class EPPTtlInfo

  • All Implemented Interfaces:
    EPPCodecComponent, java.io.Serializable, java.lang.Cloneable
    public class EPPTtlInfo
extends java.lang.Object
implements EPPCodecComponent
    TTL Info Extension that enables a client to indicate whether to include the TTL policy attributes in the response.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ELM_LOCALNAME
      XML local name for EPPTtlInfo.
      static java.lang.String ELM_NAME
      XML root tag for EPPTtlInfo.

    • Constructor Summary

      Constructors 
      Constructor Description
      EPPTtlInfo()
      Default constructor for EPPTtlInfo.
      EPPTtlInfo​(boolean aPolicy)
      Constructor for EPPTtlInfo that takes a single TTL.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      clone an EPPCodecComponent.
      void decode​(org.w3c.dom.Element aElement)
      Decode a DOM element tree to initialize the instance attributes.
      org.w3c.dom.Element encode​(org.w3c.dom.Document aDocument)
      Encode of a EPPTtlInfo instance that includes checks of the TTLs.
      boolean equals​(java.lang.Object aObject)
      Compare an instance of EPPTtlInfo with this instance.
      protected java.lang.String getLocalName()
      Returns the local name "info" for the info extension.
      java.lang.String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      boolean isPolicy()
      Is the policy attributes requested in the response?
      void setPolicy​(boolean aPolicy)
      Sets whether the policy attributes are requested in the response.
      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 java.lang.Object

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

    • Field Detail

      • ELM_LOCALNAME

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

      • ELM_NAME

        public static final java.lang.String ELM_NAME
        XML root tag for EPPTtlInfo.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EPPTtlInfo

        public EPPTtlInfo()
        Default constructor for EPPTtlInfo.

      • EPPTtlInfo

        public EPPTtlInfo​(boolean aPolicy)
        Constructor for EPPTtlInfo that takes a single TTL.
        Parameters:
        aPolicy - The policy

    • Method Detail

      • getLocalName

        protected java.lang.String getLocalName()
        Returns the local name "info" for the info extension.
        Returns:
        Local name "info" for the info extension.

      • isPolicy

        public boolean isPolicy()
        Is the policy attributes requested in the response?
        Returns:
        true to include the policy attributes in the response; false otherwise.

      • setPolicy

        public void setPolicy​(boolean aPolicy)
        Sets whether the policy attributes are requested in the response.
        Parameters:
        aPolicy - true to include the policy attributes in the response; false otherwise.

      • encode

        public org.w3c.dom.Element encode​(org.w3c.dom.Document aDocument)
                           throws EPPEncodeException
        Encode of a EPPTtlInfo instance that includes checks of the TTLs.
        Specified by:
        encode in interface EPPCodecComponent
        Parameters:
        aDocument - DOM Document, which acts is an Element factory
        Returns:
        Element Root element associated with the object
        Throws:
        EPPEncodeException - Error encoding EPPTtlExtension

      • decode

        public void decode​(org.w3c.dom.Element aElement)
            throws EPPDecodeException
        Decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
        Specified by:
        decode in interface EPPCodecComponent
        Parameters:
        aElement - Element to decode
        Throws:
        EPPDecodeException - Error decoding Element

      • clone

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

      • equals

        public boolean equals​(java.lang.Object aObject)
        Compare an instance of EPPTtlInfo with this instance.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        aObject - Object to compare with.
        Returns:
        true if equal; false otherwise.

      • getNamespace

        public java.lang.String getNamespace()
        Returns the XML namespace associated with the EPPCodecComponent.
        Specified by:
        getNamespace in interface EPPCodecComponent
        Returns:
        XML namespace for the EPPCodecComponent.