Package com.verisign.epp.codec.idntable

Class EPPIdnTableInfoDomain

java.lang.Object
com.verisign.epp.codec.idntable.EPPIdnTableInfoDomain
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPIdnTableInfoDomain extends Object implements EPPCodecComponent
EPPIdnTableInfoDomain is used to represent the Internationalized Domain Name (IDN) information for a domain in a IDN table response to a <info> command. The domain information includes whether the domain is a valid IDN domain name, whether or not the use of the IDN mapping extension is needed, and the matching list of valid IDN table identifiers.
See Also:

  • Field Details

  • Constructor Details

    • EPPIdnTableInfoDomain

      public EPPIdnTableInfoDomain()
      Default constructor for EPPIdnTableInfoDomain.

    • EPPIdnTableInfoDomain

      public EPPIdnTableInfoDomain(String aName, boolean aValid)
      Constructor for EPPIdnTableInfoDomain that takes the domain name and whether the domain name is a valid IDN domain name.
      Parameters:
      aName - Domain name
      aValid - Is the domain name a valid IDN domain name?

    • EPPIdnTableInfoDomain

      public EPPIdnTableInfoDomain(String aName, boolean aValid, boolean aIdnmap)
      Constructor for EPPIdnTableInfoDomain that takes the domain name, whether the domain name is a valid IDN domain name, and whether the server requires the IDN mapping extension with a domain create of the domain name.
      Parameters:
      aName - Domain name
      aValid - Is the domain name a valid IDN domain name?
      aIdnmap - true if the IDN mapping extension is required on a domain create of the domain name; false otherwise.

    • EPPIdnTableInfoDomain

      public EPPIdnTableInfoDomain(String aName, List<EPPIdnTableInfoDomainTable> aTables)
      Constructor for EPPIdnTableInfoDomain that is used for valid IDN domain names by providing the list of IDN table identifiers.
      Parameters:
      aName - Domain name
      aTables - List of matching IDN tables.

  • Method Details

    • getName

      public String getName()
      Returns the domain name.
      Returns:
      Domain name if defined: null otherwise.

    • setName

      public void setName(String aDomain)
      Sets the domain name.
      Parameters:
      aDomain - Domain name

    • isValid

      public boolean isValid()
      Is the domain name a valid IDN domain name?
      Returns:
      true if it is a valid IDN domain name; false otherwise.

    • setValid

      public void setValid(boolean aValid)
      Sets whether the domain name is a valid IDN domain name.
      Parameters:
      aValid - true if the domain name is a valid IDN domain name; false otherwise.

    • isIdnmap

      public boolean isIdnmap()
      Is the IDN mapping extension required on a domain create of the domain name?
      Returns:
      true if the IDN mapping extension is required on a domain create of the domain name; false otherwise.

    • setIdnmap

      public void setIdnmap(boolean aIdnmap)
      Set whether the IDN mapping extension is required on a domain create of the domain name.
      Parameters:
      aIdnmap - true if the IDN mapping extension is required on a domain create of the domain name; false otherwise.

    • hasAname

      public boolean hasAname()
      Is the A-label domain name defined?
      Returns:
      true if the A-label domain name is defined; false otherwise.

    • getAname

      public String getAname()
      Returns the OPTIONAL A-label domain name.
      Returns:
      A-label domain name if defined: null otherwise.

    • setAname

      public void setAname(String aDomain)
      Sets the A-label domain name.
      Parameters:
      aDomain - A-label Domain name

    • hasUname

      public boolean hasUname()
      Is the U-label domain name defined?
      Returns:
      true if the U-label domain name is defined; false otherwise.

    • getUname

      public String getUname()
      Returns the OPTIONAL U-label domain name.
      Returns:
      U-label domain name if defined: null otherwise.

    • setUname

      public void setUname(String aDomain)
      Sets the U-label domain name.
      Parameters:
      aDomain - U-label Domain name

    • hasTables

      public boolean hasTables()
      Are any table identifiers defined in the list of table identifiers?
      Returns:
      true if there is at least one table identifier defined; false otherwise.

    • getTables

      public List<EPPIdnTableInfoDomainTable> getTables()
      Get the list of tables.
      Returns:
      List of tables

    • setTables

      public void setTables(List<EPPIdnTableInfoDomainTable> aTables)
      Set the list of tables.
      Parameters:
      aTables - List of tables

    • setTable

      public void setTable(EPPIdnTableInfoDomainTable aTable)
      Set an individual table. This method clears the existing list of tables.
      Parameters:
      aTable - Table to set

    • addTable

      public void addTable(EPPIdnTableInfoDomainTable aTable)
      Append a table to the list of tables. This method does NOT clear the existing list of tables.
      Parameters:
      aTable - Table to append

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

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