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

Class EPPTtlInfo

java.lang.Object
com.verisign.epp.codec.ttl.v1_0.EPPTtlInfo
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPTtlInfo extends Object implements EPPCodecComponent
TTL Info Extension that enables a client to indicate whether to include the TTL policy attributes in the response.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    XML local name for EPPTtlInfo.
    static final 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

    Modifier and Type
    Method
    Description
    Object
    clone()
    clone an EPPCodecComponent.
    void
    decode(Element aElement)
    Decode a DOM element tree to initialize the instance attributes.
    Element
    encode(Document aDocument)
    Encode of a EPPTtlInfo instance that includes checks of the TTLs.
    boolean
    equals(Object aObject)
    Compare an instance of EPPTtlInfo with this instance.
    protected String
    getLocalName()
    Returns the local name "info" for the info extension.
    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.
    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 Details

  • Constructor Details

    • 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 Details

    • getLocalName

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

    • equals

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

    • getNamespace

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