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

Class EPPRegistryHost

java.lang.Object
com.verisign.epp.codec.registry.v02.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 aInternal)
      Sets the internal host attributes.
      Parameters:
      aInternal - the internal host attributes

    • getExternal

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

    • setExternal

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

    • hasNameRegex

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

    • getNameRegex

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

    • setNameRegex

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

    • hasMaxCheckHost

      public boolean hasMaxCheckHost()
      Is the maximum number of host names defined?
      Returns:
      true if the maximum number of host names is defined; false otherwise.

    • 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 if defined; null otherwise.

    • setMaxCheckHost

      public void setMaxCheckHost(Integer aMaxCheckHost)
      Sets maximum number of host names that can be included in a host check command.
      Parameters:
      aMaxCheckHost - maximum number of host names that can be included in a host check command. Set to null to unset the value.

    • 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 aSupportedStatus)
      Sets a set of supported host statuses defined in RFC 5732.
      Parameters:
      aSupportedStatus - set of supported host statuses defined in RFC 5732

    • hasInvalidIPs

      public boolean hasInvalidIPs()
      Is the invalid IPs defined?
      Returns:
      true if the invalid IPs is defined; false otherwise.

    • getInvalidIPs

      public List<String> getInvalidIPs()
      Gets the invalid IP address URIs.
      Returns:
      List of invalid IP address URIs

    • setInvalidIPs

      public void setInvalidIPs(List<String> aInvalidIPs)
      Sets the invalid IP address URIs.
      Parameters:
      aInvalidIPs - List of invaild IP address URI String values.

    • addInvalidIP

      public void addInvalidIP(String aInvalidIP)
      Adds one invalid IP address URI to the list.
      Parameters:
      aInvalidIP - supported algorithm as described in section 2.1.3 of RFC 4034

    • getNamespace

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