Package com.verisign.epp.codec.registry.v02

Class EPPRegistryIDN

java.lang.Object
com.verisign.epp.codec.registry.v02.EPPRegistryIDN
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRegistryIDN extends Object implements EPPCodecComponent
Represents the Internationalized Domain Name (IDN) policy information. The <registry:idn> must contain the following child elements:

  • <registry:idnVersion> - The OPTIONAL server unique version of the IDN language rules. Use getIdnVersion() and setIdnVersion(String) to get and set the element.
  • <registry:idnaVersion> - An Internationalizing Domain Names in Applications (IDNA) version supported by the server. IDNA represents a collection of documents that describe the protocol and usage for Internationalized Domain for Applications like IDNA 2003, with value of 2003, or IDNA 2008, with value of 2008. Use getIdnaVersion() and setIdnaVersion(String) to get and set the element.
  • <registry:unicodeVersion> - The Unicode version supported by the server like the value of "6.0" for Unicode 6.0. Use getUnicodeVersion() and setUnicodeVersion(String) to get and set the element.
  • <registry:encoding> - The OPTIONAL encoding for transforming Unicode characters uniquely and reversibly into DNS compatible characters with a default value of "Punycode". Use getEncoding() and setEncoding(String) to get and set the element.
  • <registry:commingleAllowed> - An OPTIONAL boolean value that indicates whether commingling of scripts is allowed with a default value of "false". Use getCommingleAllowed() and setCommingleAllowed(Boolean) to get and set the element.
  • <registry:language> - Zero or more <registry:language> elements that defines the supported language codes and character code point policy. Use getLanguages() and setLanguages(List) to get and set the element. Use addLanguage(EPPRegistryLanguage) to add one language policy to the existing list.
See Also:

  • Field Details

    • ELM_LOCALNAME

      public static final String ELM_LOCALNAME
      Constant for the EPPRegistryIDN local name
      See Also:

    • ELM_NAME

      public static final String ELM_NAME
      Constant for the EPPRegistryIDN (prefix and local name)
      See Also:

    • ELM_IDN_VERSION

      public static final String ELM_IDN_VERSION
      XML Element Name of idnVersion attribute.
      See Also:

    • ELM_IDNA_VERSION

      public static final String ELM_IDNA_VERSION
      XML Element Name of idnaVersion attribute.
      See Also:

    • ELM_UNICODE_VERSION

      public static final String ELM_UNICODE_VERSION
      XML Element Name of unicodeVersion attribute.
      See Also:

    • ELM_ENCODING

      public static final String ELM_ENCODING
      XML Element Name of encoding attribute.
      See Also:

    • ELM_COMMINGLE_ALLOWED

      public static final String ELM_COMMINGLE_ALLOWED
      XML Element Name of commingleAllowed attribute.
      See Also:

  • Constructor Details

    • EPPRegistryIDN

      public EPPRegistryIDN()

  • Method Details

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPRegistryIDN instance.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Element Root DOM Element representing the EPPRegistryIDN instance.
      Throws:
      EPPEncodeException - - Unable to encode EPPRegistryIDN instance.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPRegistryIDN attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Root DOM Element to decode EPPRegistryIDN from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPRegistryIDN.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPRegistryIDN
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPRegistryIDN compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPRegistryIDN instance to compare with
      Returns:
      true if this object is the same as the aObject argument; false otherwise

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

    • getIdnVersion

      public String getIdnVersion()
      Gets the idnVersion.
      Returns:
      String representation of idnVersion

    • setIdnVersion

      public void setIdnVersion(String aIdnVersion)
      Sets the idnVersion.
      Parameters:
      aIdnVersion - String representation of idnVersion

    • getUnicodeVersion

      public String getUnicodeVersion()
      Gets the unicodeVersion.
      Returns:
      String representation of unicodeVersion

    • setUnicodeVersion

      public void setUnicodeVersion(String aUnicodeVersion)
      Sets the unicodeVersion.
      Parameters:
      aUnicodeVersion - String representation of unicodeVersion

    • getIdnaVersion

      public String getIdnaVersion()
      Gets the idnaVersion.
      Returns:
      String representation of idnaVersion

    • setIdnaVersion

      public void setIdnaVersion(String aIdnaVersion)
      Sets the idnaVersion.
      Parameters:
      aIdnaVersion - String representation of idnaVersion

    • getEncoding

      public String getEncoding()
      Gets the character encoding.
      Returns:
      character encoding for transforming Unicode characters uniquely and reversibly into DNS compatible characters

    • setEncoding

      public void setEncoding(String aEncoding)
      Sets the character encoding.
      Parameters:
      aEncoding - character encoding for transforming Unicode characters uniquely and reversibly into DNS compatible characters

    • getCommingleAllowed

      public Boolean getCommingleAllowed()
      Gets whether commingling of scripts is allowed.
      Returns:
      true allow commingling; false do not allow commingling

    • setCommingleAllowed

      public void setCommingleAllowed(Boolean aCommingleAllowed)
      Sets whether commingling of scripts is allowed.
      Parameters:
      aCommingleAllowed - true allow commingling; false do not allow commingling

    • getLanguages

      public List<EPPRegistryLanguage> getLanguages()
      Gets the List of EPPRegistryLanguage.
      Returns:
      List of EPPRegistryLanguage that defines the supported language codes and character code point policy

    • setLanguages

      public void setLanguages(List<EPPRegistryLanguage> aLanguages)
      Sets the List of EPPRegistryLanguage.
      Parameters:
      aLanguages - List of EPPRegistryLanguage that defines the supported language codes and character code point policy

    • addLanguage

      public void addLanguage(EPPRegistryLanguage language)
      Append one instance of EPPRegistryLanguage to the existing list.
      Parameters:
      language - instance of EPPRegistryLanguage that defines the supported language codes and character code point policy

    • getNamespace

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