Package com.verisign.epp.codec.idnmap

Class EPPIdnMap

java.lang.Object
com.verisign.epp.codec.idnmap.EPPIdnMap
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPIdnMap extends Object implements EPPCodecComponent
EPPIdnMap is used in the extension to the domain create command to define the IDN table and optionally the Unicode NFC of the domain name, and in the extension to the domain info response to return the same information about the domain name.
See Also:

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPIdnMap()
    Default constructor for EPPIdnMap.
    EPPIdnMap(String aTable)
    Constructor for EPPIdnMap that takes the IDN table identifier.
    EPPIdnMap(String aTable, String aUname)
    Constructor for EPPIdnMap that takes both the IDN table identifier and the domain name uname in Unicode NFC.

  • 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 EPPIdnMap with this instance.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getTable()
    Gets the IDN table identifier.
    String
    getUname()
    Gets the uname value, which is the domain name in Unicode NFC.
    boolean
    hasUname()
    Is the uname defined?
    void
    setTable(String aTable)
    Sets the IDN table identifier.
    void
    setUname(String aUname)
    Sets the uname 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

    • EPPIdnMap

      public EPPIdnMap()
      Default constructor for EPPIdnMap.

    • EPPIdnMap

      public EPPIdnMap(String aTable)
      Constructor for EPPIdnMap that takes the IDN table identifier.
      Parameters:
      aTable - IDN table identifier as provided by the server

    • EPPIdnMap

      public EPPIdnMap(String aTable, String aUname)
      Constructor for EPPIdnMap that takes both the IDN table identifier and the domain name uname in Unicode NFC.
      Parameters:
      aTable - IDN table identifier as provided by the server
      aUname - Domain name in Unicode NFC

  • Method Details

    • getTable

      public String getTable()
      Gets the IDN table identifier.
      Returns:
      The IDN table identifier as provided by the server.

    • setTable

      public void setTable(String aTable)
      Sets the IDN table identifier.
      Parameters:
      aTable - The IDN table identifier as provided by the server.

    • hasUname

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

    • getUname

      public String getUname()
      Gets the uname value, which is the domain name in Unicode NFC.
      Returns:
      Domain uname value if defined; null otherwise.

    • setUname

      public void setUname(String aUname)
      Sets the uname value.
      Parameters:
      aUname - Domain name in Unicode NFC

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

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