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

Class EPPRegistryInternalHost

  • All Implemented Interfaces:
    EPPCodecComponent, java.io.Serializable, java.lang.Cloneable
    public class EPPRegistryInternalHost
extends EPPRegistryAbstractMinMax
    Defines the policies for internal hosts. The <registry:internal> elements contains the following child elements:
    • <registry:minIP> - Minimum number of IP addresses supported for an internal host.
    • <registry:maxIP> - Maximum number of IP addresses supported for an internal host.
    • <registry:sharePolicy> - The OPTIONAL policy for the sharing of internal hosts in the server.The possible shared policy values include:
      • "perZone" - The internal hosts are shared across all domains of the zone. There is a single pool of internal hosts defined for the zone.
      • "perSystem" - The internal hosts are shared across all zones of the system. There is a single pool of internal hosts across all of the zones supported by the system.
    • <registry:uniqueIpAddressRequired> - The OPTIONAL boolean value that indicates that all of the IP addresses for the host object must be unique, with a default value of "false".
    See Also:
    EPPRegistryHost, Serialized Form

    • Field Detail

      • ELM_LOCALNAME

        public static final java.lang.String ELM_LOCALNAME
        XML local name for EPPRegistryInternalHost.
        See Also:
        Constant Field Values

      • ELM_NAME

        public static final java.lang.String ELM_NAME
        XML root tag for EPPRegistryInternalHost.
        See Also:
        Constant Field Values

      • ELM_MIN_IP

        protected static final java.lang.String ELM_MIN_IP
        XML Element Name of min attribute.
        See Also:
        Constant Field Values

      • ELM_MAX_IP

        protected static final java.lang.String ELM_MAX_IP
        XML Element Name of max attribute.
        See Also:
        Constant Field Values

      • ELM_SHARE_POLICY

        public static final java.lang.String ELM_SHARE_POLICY
        XML Element Name of sharePolicy attribute.
        See Also:
        Constant Field Values

      • ELM_UNIQUE_IP_ADDRESSES_REQUIRED

        public static final java.lang.String ELM_UNIQUE_IP_ADDRESSES_REQUIRED
        XML Element Name of uniqueIpAddressesRequired attribute.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EPPRegistryInternalHost

        public EPPRegistryInternalHost()
        Creates a new EPPRegistryInternalHost object.

      • EPPRegistryInternalHost

        public EPPRegistryInternalHost​(java.lang.Integer aMin,
                               java.lang.Integer aMax,
                               EPPRegistryInternalHost.SharePolicy aSharePolicy,
                               java.lang.Boolean aUniqueIpAddressesRequired)
        Constructor that takes min, max, sharePolicy, and uniqueIpAddressesRequired using Integer's.
        Parameters:
        aMin - minimum number of IPs supported for an internal host
        aMax - maximum number of IPs supported for an internal host
        aSharePolicy - Share policy to set. Set to null if undefined.
        aUniqueIpAddressesRequired - Indicates that all of the IP addresses for the host object must be unique, with a default value of "false". Set to null to set the default.

      • EPPRegistryInternalHost

        public EPPRegistryInternalHost​(int aMin,
                               int aMax,
                               EPPRegistryInternalHost.SharePolicy aSharePolicy,
                               java.lang.Boolean aUniqueIpAddressesRequired)
        Constructor that takes min, max, sharePolicy, and uniqueIpAddressesRequired using int's.
        Parameters:
        aMin - minimum number of IPs supported for an internal host
        aMax - maximum number of IPs supported for an internal host
        aSharePolicy - Share policy to set. Set to null if undefined.
        aUniqueIpAddressesRequired - Indicates that all of the IP addresses for the host object must be unique, with a default value of "false". Set to null to set the default.

    • Method Detail

      • encode

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

      • clone

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

      • equals

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

      • hasSharePolicy

        public boolean hasSharePolicy()
        Is the share policy defined?
        Returns:
        true if the share policy is defined; false otherwise.

      • setSharePolicy

        public void setSharePolicy​(EPPRegistryInternalHost.SharePolicy aSharePolicy)
        Sets the share policy.
        Parameters:
        aSharePolicy - Share policy. Set to null to clear it.

      • getUniqueIpAddressesRequired

        public java.lang.Boolean getUniqueIpAddressesRequired()
        Gets the OPTIONAL boolean value that indicates that all of the IP addresses for the host object must be unique, with a default value of "false".
        Returns:
        the uniqueIpAddressesRequired boolean value.

      • setUniqueIpAddressesRequired

        public void setUniqueIpAddressesRequired​(java.lang.Boolean aUniqueIpAddressesRequired)
        Sets the OPTIONAL boolean value that indicates that all of the IP addresses for the host object must be unique, with a default value of "false".
        Parameters:
        aUniqueIpAddressesRequired - Set the boolean value. If set to null the default value of "false" will be set.

      • toString

        public java.lang.String toString()
        Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
        Overrides:
        toString in class EPPRegistryAbstractMinMax
        Returns:
        Indented XML String if successful; ERROR otherwise.

      • getRootName

        protected java.lang.String getRootName()
        Gets the root element local name.
        Specified by:
        getRootName in class EPPRegistryAbstractMinMax
        Returns:
        Root element local name.

      • getElmMin

        protected java.lang.String getElmMin()
        Gets the minimum element local name.
        Specified by:
        getElmMin in class EPPRegistryAbstractMinMax
        Returns:
        Minimum element local name.

      • getElmMax

        protected java.lang.String getElmMax()
        Gets the maximum element local name.
        Specified by:
        getElmMax in class EPPRegistryAbstractMinMax
        Returns:
        Maximum element local name.

      • getLogger

        protected org.slf4j.Logger getLogger()
        Gets the Logger to use.
        Specified by:
        getLogger in class EPPRegistryAbstractMinMax
        Returns:
        Logger instance to use for logging.