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

Class EPPRegistryDomainName

java.lang.Object
com.verisign.epp.codec.registry.v02.EPPRegistryDomainName
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRegistryDomainName extends Object implements EPPCodecComponent
This class is encoded to the <registry:domainName> element inside the <registry:domain> element. It represents policies for a domain name label for a specific level, defined with the "level" attribute, with a minimum value of "2" for the second level domain name label level. The <registry:domainName> element contains the following child elements

See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryDomainName

      public EPPRegistryDomainName()

  • Method Details

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPRegistryDomainName 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 EPPRegistryDomainName instance.
      Throws:
      EPPEncodeException - - Unable to encode EPPRegistryDomainName instance.

    • decode

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

    • equals

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPRegistryDomainName.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPRegistryDomainName
      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.

    • getLevel

      public Integer getLevel()
      Get the level of domain name.
      Returns:
      level of domain name. Must be >= 2

    • setLevel

      public void setLevel(Integer level)
      Set the level of domain name.
      Parameters:
      level - level of domain name. Must be >= 2

    • getMinLength

      public Integer getMinLength()
      Get minimum number of characters in a domain name.
      Returns:
      minimum number of characters in a domain name

    • setMinLength

      public void setMinLength(Integer minLength)
      Set minimum number of characters in a domain name.
      Parameters:
      minLength - minimum number of characters in a domain name

    • getMaxLength

      public Integer getMaxLength()
      Get maximum number of characters in a domain name.
      Returns:
      maximum number of characters in a domain name

    • setMaxLength

      public void setMaxLength(Integer maxLength)
      Set maximum number of characters in a domain name.
      Parameters:
      maxLength - maximum number of characters in a domain name

    • getAlphaNumStart

      public Boolean getAlphaNumStart()
      Get whether or not to allow domain name start with an alphanumeric character.
      Returns:
      true allow domain name start with an alphanumeric character. false do not allow domain name start with an alphanumeric character

    • setAlphaNumStart

      public void setAlphaNumStart(Boolean alphaNumStart)
      Set whether or not to allow domain name start with an alphanumeric character.
      Parameters:
      alphaNumStart - true allow domain name start with an alphanumeric character. false do not allow domain name start with an alphanumeric character

    • getAlphaNumEnd

      public Boolean getAlphaNumEnd()
      Get whether or not to allow domain name end with an alphanumeric character.
      Returns:
      true allow domain name end with an alphanumeric character. false do not allow domain name end with an alphanumeric character

    • setAlphaNumEnd

      public void setAlphaNumEnd(Boolean alphaNumEnd)
      Set whether or not to allow domain name end with an alphanumeric character.
      Parameters:
      alphaNumEnd - true allow domain name end with an alphanumeric character. false do not allow domain name end with an alphanumeric character

    • getALabelSupported

      public Boolean getALabelSupported()
      Get whether ASCII domain names are supported.
      Returns:
      true if ASCII domain names are supported; false otherwise.

    • setALabelSupported

      public void setALabelSupported(Boolean aALabelSupported)
      Set whether whether ASCII domain names are supported.
      Parameters:
      aALabelSupported - true ASCII domain names are supported; false otherwise.

    • getULabelSupported

      public Boolean getULabelSupported()
      Get whether non-ASCII domain names are supported.
      Returns:
      true if non-ASCII domain names are supported; false otherwise.

    • setULabelSupported

      public void setULabelSupported(Boolean aULabelSupported)
      Set whether non-ASCII domain names are supported.
      Parameters:
      aULabelSupported - true non-ASCII domain names are supported; false otherwise.

    • hasNameRegex

      public boolean hasNameRegex()
      Is the domain name regular expression defined?
      Returns:
      true if the domain name regular expression is defined; false otherwise.

    • getNameRegex

      public EPPRegistryRegex getNameRegex()
      Get the regular expression that domain name must follow.
      Returns:
      Regular expression if defined; null otherwise.

    • setNameRegex

      public void setNameRegex(EPPRegistryRegex aNameRegex)
      Set the regular expression that domain name must follow.
      Parameters:
      aNameRegex - Regular expression for the domain name label. Set to null to unset it.

    • getReservedNames

      public EPPRegistryReservedNames getReservedNames()
      Get the instance of EPPRegistryReservedNames that defines a set of reserved domain names.
      Returns:
      instance of EPPRegistryReservedNames

    • setReservedNames

      public void setReservedNames(EPPRegistryReservedNames reservedNames)
      Set the instance of EPPRegistryReservedNames that defines a set of reserved domain names.
      Parameters:
      reservedNames - instance of EPPRegistryReservedNames

    • getNamespace

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