Package com.verisign.epp.codec.idntable

Class EPPIdnTableCheckDomain

java.lang.Object
com.verisign.epp.codec.idntable.EPPIdnTableCheckDomain
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPIdnTableCheckDomain extends Object implements EPPCodecComponent
EPPIdnTableCheckDomain is used to represent the Internationalized Domain Name (IDN) information for a domain in a IDN table response to a <check> 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 Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPIdnTableCheckDomain()
    Default constructor for EPPIdnTableCheckDomain.
    EPPIdnTableCheckDomain(String aName, boolean aValid)
    Constructor for EPPIdnTableCheckDomain that takes the domain name and whether the domain name is a valid IDN domain name.
    EPPIdnTableCheckDomain(String aName, boolean aValid, boolean aIdnmap)
    Constructor for EPPIdnTableCheckDomain that takes the domain name and whether the domain name is a valid IDN domain name, and whether the domain name requires the IDN mapping extension with a domain create of the domain name.
    EPPIdnTableCheckDomain(String aDomain, String aReason)
    Constructor for EPPIdnTableCheckDomain that is used for invalid IDN domain names by providing the reason the domain name is not valid.
    EPPIdnTableCheckDomain(String aDomain, List<String> aTables)
    Constructor for EPPIdnTableCheckDomain that is used for valid IDN domain names by providing the list of IDN table identifiers.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addTable(String aTable)
    Append a table identifier to the list of table identifiers.
    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 EPPIdnTableCheckDomain with this instance.
    String
    getName()
    Returns the domain name.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getReason()
    Gets the reason that the domain name is invalid.
    String
    getReasonLang()
    Gets the reason language value.
    List<String>
    getTables()
    Get the list of table identifiers.
    boolean
    hasReason()
    Is the reason defined?
    boolean
    hasReasonLang()
    Is the reason language defined?
    boolean
    hasTables()
    Are any table identifiers defined in the list of table identifiers?
    boolean
    isIdnmap()
    Is the IDN mapping extension required on a domain create of the domain name?
    boolean
    isValid()
    Is the domain name a valid IDN domain name?
    void
    setIdnmap(boolean aIdnmap)
    Set whether the IDN mapping extension is required on a domain create of the domain name.
    void
    setName(String aDomain)
    Sets the domain name.
    void
    setReason(String aReason)
    Sets the reason that the domain name is invalid.
    void
    setReasonLang(String aReasonLang)
    Sets the reason language value.
    void
    setTable(String aTable)
    Set an individual table identifier.
    void
    setTables(List<String> aTables)
    Set the list of table identifiers.
    void
    setValid(boolean aValid)
    Sets whether the domain name is a valid IDN domain name.
    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

    • EPPIdnTableCheckDomain

      public EPPIdnTableCheckDomain()
      Default constructor for EPPIdnTableCheckDomain.

    • EPPIdnTableCheckDomain

      public EPPIdnTableCheckDomain(String aName, boolean aValid)
      Constructor for EPPIdnTableCheckDomain 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?

    • EPPIdnTableCheckDomain

      public EPPIdnTableCheckDomain(String aName, boolean aValid, boolean aIdnmap)
      Constructor for EPPIdnTableCheckDomain that takes the domain name and whether the domain name is a valid IDN domain name, and whether the domain name 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.

    • EPPIdnTableCheckDomain

      public EPPIdnTableCheckDomain(String aDomain, String aReason)
      Constructor for EPPIdnTableCheckDomain that is used for invalid IDN domain names by providing the reason the domain name is not valid.
      Parameters:
      aDomain - Domain name
      aReason - Reason that the IDN domain name is not valid.

    • EPPIdnTableCheckDomain

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

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

    • hasReason

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

    • getReason

      public String getReason()
      Gets the reason that the domain name is invalid.
      Returns:
      Reason that the domain name is invalid if defined; null otherwise.

    • setReason

      public void setReason(String aReason)
      Sets the reason that the domain name is invalid.
      Parameters:
      aReason - Reason that the domain is invalid. Set to null to clear the reason.

    • hasReasonLang

      public boolean hasReasonLang()
      Is the reason language defined?
      Returns:
      true if the reason language is defined; false otherwise.

    • getReasonLang

      public String getReasonLang()
      Gets the reason language value.
      Returns:
      Reason language if defined; null otherwise.

    • setReasonLang

      public void setReasonLang(String aReasonLang)
      Sets the reason language value.
      Parameters:
      aReasonLang - Reason language for reason value.

    • 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<String> getTables()
      Get the list of table identifiers.
      Returns:
      List of table identifier String's

    • setTables

      public void setTables(List<String> aTables)
      Set the list of table identifiers.
      Parameters:
      aTables - List of table identifier String's

    • setTable

      public void setTable(String aTable)
      Set an individual table identifier. This method clears the existing list of table identifiers.
      Parameters:
      aTable - Table identifier

    • addTable

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

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

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