Class EPPRegistryHost

java.lang.Object
com.verisign.epp.codec.registry.EPPRegistryHost
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable

public class EPPRegistryHost extends Object implements EPPCodecComponent
Represents the host object policy information per RFC 5732. The <registry:host> element contains the following child elements:

See Also:
  • Field Details

  • Constructor Details

    • EPPRegistryHost

      public EPPRegistryHost()
  • Method Details

    • encode

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

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

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

      public boolean equals(Object aObject)
      implements a deep EPPRegistryHost compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPRegistryHost 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.
    • getInternal

      public EPPRegistryInternalHost getInternal()
      Gets the internal host attributes.
      Returns:
      the internal host attributes
    • setInternal

      public void setInternal(EPPRegistryInternalHost internal)
      Sets the internal host attributes.
      Parameters:
      internal - the internal host attributes
    • getExternal

      public EPPRegistryExternalHost getExternal()
      Gets the external host attributes.
      Returns:
      the external host attributes
    • setExternal

      public void setExternal(EPPRegistryExternalHost external)
      Sets the external host attributes.
      Parameters:
      external - the external host attributes
    • getNameRegex

      public List getNameRegex()
      Gets host name regular expressions.
      Returns:
      List of name regular expressions
    • setNameRegex

      public void setNameRegex(List nameRegex)
      Sets host name regular expressions.
      Parameters:
      nameRegex - List of name regular expressions
    • addNameRegex

      public void addNameRegex(EPPRegistryRegex regex)
      Adds one host name regular expression to the existing List.
      Parameters:
      regex - one name regular expressions
    • getMaxCheckHost

      public Integer getMaxCheckHost()
      Gets maximum number of host names that can be included in a host check command.
      Returns:
      maximum number of host names that can be included in a host check command
    • setMaxCheckHost

      public void setMaxCheckHost(Integer maxCheckHost)
      Sets maximum number of host names that can be included in a host check command.
      Parameters:
      maxCheckHost - maximum number of host names that can be included in a host check command
    • getCustomData

      public EPPRegistryCustomData getCustomData()
      Gets set of custom data using key, value pairs.
      Returns:
      instance of EPPRegistryCustomData that gives users the ability to specify custom data with key/value pairs
    • setCustomData

      public void setCustomData(EPPRegistryCustomData customData)
      Sets set of custom data using key, value pairs.
      Parameters:
      customData - instance of EPPRegistryCustomData that gives users the ability to specify custom data with key/value pairs
    • getSupportedStatus

      public EPPRegistrySupportedStatus getSupportedStatus()
      Gets a set of supported host statuses defined in RFC 5732.
      Returns:
      set of supported host statuses defined in RFC 5732
    • setSupportedStatus

      public void setSupportedStatus(EPPRegistrySupportedStatus supportedStatus)
      Sets a set of supported host statuses defined in RFC 5732.
      Parameters:
      supportedStatus - set of supported host statuses defined in RFC 5732
    • getNamespace

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