Package com.verisign.epp.codec.allocationtoken

Class EPPAllocationToken

java.lang.Object
com.verisign.epp.codec.allocationtoken.EPPAllocationToken
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPAllocationToken extends Object implements EPPCodecComponent
Allocation Token Extension, defines an allocation token or code for allocating an object like a domain name to the client. The allocation token MAY be transferred out-of-band to a client to give them authorization to allocate an object using one of the EPP transform commands including create, update, and transfer.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    XML local name for EPPAllocationToken.
    static final String
    ELM_NAME
    XML root tag for EPPAllocationToken.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPAllocationToken()
    O Default constructor for EPPAllocationToken.
    EPPAllocationToken(String aToken)
    Constructor for EPPAllocationToken that takes the token.

  • 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 instance into a DOM element tree.
    boolean
    equals(Object aObject)
    Compare an instance of EPPAllocationToken with this instance.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getToken()
    Gets the allocation token value.
    boolean
    hasToken()
    Is the token defined?
    void
    setToken(String aToken)
    Sets the allocation token value.
    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

    • EPPAllocationToken

      public EPPAllocationToken()
      O Default constructor for EPPAllocationToken.

    • EPPAllocationToken

      public EPPAllocationToken(String aToken)
      Constructor for EPPAllocationToken that takes the token.
      Parameters:
      aToken - Sub-product identifier

  • Method Details

    • hasToken

      public boolean hasToken()
      Is the token defined?
      Returns:
      true if the token is defined; false otherwise.

    • getToken

      public String getToken()
      Gets the allocation token value.
      Returns:
      Allocation token value if defined; null otherwise.

    • setToken

      public void setToken(String aToken)
      Sets the allocation token value.
      Parameters:
      aToken - Allocation token

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
      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 EPPAllocationToken

    • 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 EPPAllocationToken
      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 EPPAllocationToken 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.