Class EPPRegistryExternalHost
- java.lang.Object
-
- com.verisign.epp.codec.registry.v02.EPPRegistryAbstractMinMax
-
- com.verisign.epp.codec.registry.v02.EPPRegistryExternalHost
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPRegistryExternalHost extends EPPRegistryAbstractMinMax
Defines the policies for external hosts. The <registry:external> elements contains the following child elements:
- <registry:minIP> - Minimum number of IP addresses supported for an external host.
- <registry:maxIP> - Maximum number of IP addresses supported for an external host.
- <registry:sharePolicy> - The OPTIONAL policy for the sharing of
external hosts in the server.The possible shared policy values include:
- "perRegistrar" - The external hosts are shared across all domains of the registrar. There is a single pool of external hosts defined per registrar.
- "perZone" - The external hosts are shared across all domains of the zone. There is a single pool of external hosts defined for the zone.
- "perSystem" - The external hosts are shared across all zones of the system. There is a single pool of external 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EPPRegistryExternalHost.SharePolicy
Possible values for thesharePolicy
attribute.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPRegistryExternalHost
.protected static java.lang.String
ELM_MAX_IP
XML Element Name ofmax
attribute.protected static java.lang.String
ELM_MIN_IP
XML Element Name ofmin
attribute.static java.lang.String
ELM_NAME
XML root tag forEPPRegistryExternalHost
.static java.lang.String
ELM_SHARE_POLICY
XML Element Name ofsharePolicy
attribute.static java.lang.String
ELM_UNIQUE_IP_ADDRESSES_REQUIRED
XML Element Name ofuniqueIpAddressesRequired
attribute.-
Fields inherited from class com.verisign.epp.codec.registry.v02.EPPRegistryAbstractMinMax
ELM_MAX, ELM_MAX_LENGTH, ELM_MIN, ELM_MIN_LENGTH
-
-
Constructor Summary
Constructors Constructor Description EPPRegistryExternalHost()
Creates a newEPPRegistryExternalHost
object.EPPRegistryExternalHost(int aMin, int aMax, EPPRegistryExternalHost.SharePolicy aSharePolicy, java.lang.Boolean aUniqueIpAddressesRequired)
Constructor that takesmin
,max
,sharePolicy
, anduniqueIpAddressesRequired
usingint
's.EPPRegistryExternalHost(java.lang.Integer aMin, java.lang.Integer aMax, EPPRegistryExternalHost.SharePolicy aSharePolicy, java.lang.Boolean aUniqueIpAddressesRequired)
Constructor that takesmin
,max
,sharePolicy
, anduniqueIpAddressesRequired
usingInteger
's.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPRegistryExternalHost
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPRegistryExternalHost
attributes from the aElement DOM Element tree.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of theEPPRegistryExternalHost
instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPRegistryExternalHost
compare.protected java.lang.String
getElmMax()
Gets the maximum element local name.protected java.lang.String
getElmMin()
Gets the minimum element local name.protected org.slf4j.Logger
getLogger()
Gets theLogger
to use.protected java.lang.String
getRootName()
Gets the root element local name.EPPRegistryExternalHost.SharePolicy
getSharePolicy()
Gets the share policy.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".boolean
hasSharePolicy()
Is the share policy defined?void
setSharePolicy(EPPRegistryExternalHost.SharePolicy aSharePolicy)
Sets the share policy.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".java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.-
Methods inherited from class com.verisign.epp.codec.registry.v02.EPPRegistryAbstractMinMax
getMax, getMin, getNamespace, setMax, setMin, validateState
-
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPRegistryExternalHost
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPRegistryExternalHost
.- See Also:
- Constant Field Values
-
ELM_MIN_IP
protected static final java.lang.String ELM_MIN_IP
XML Element Name ofmin
attribute.- See Also:
- Constant Field Values
-
ELM_MAX_IP
protected static final java.lang.String ELM_MAX_IP
XML Element Name ofmax
attribute.- See Also:
- Constant Field Values
-
ELM_SHARE_POLICY
public static final java.lang.String ELM_SHARE_POLICY
XML Element Name ofsharePolicy
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 ofuniqueIpAddressesRequired
attribute.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPRegistryExternalHost
public EPPRegistryExternalHost()
Creates a newEPPRegistryExternalHost
object.
-
EPPRegistryExternalHost
public EPPRegistryExternalHost(java.lang.Integer aMin, java.lang.Integer aMax, EPPRegistryExternalHost.SharePolicy aSharePolicy, java.lang.Boolean aUniqueIpAddressesRequired)
Constructor that takesmin
,max
,sharePolicy
, anduniqueIpAddressesRequired
usingInteger
's.- Parameters:
aMin
- minimum number of IPs supported for an external hostaMax
- maximum number of IPs supported for an external hostaSharePolicy
- Share policy to set. Set tonull
if undefined.aUniqueIpAddressesRequired
- Indicates that all of the IP addresses for the host object must be unique, with a default value of "false". Set tonull
to set the default.
-
EPPRegistryExternalHost
public EPPRegistryExternalHost(int aMin, int aMax, EPPRegistryExternalHost.SharePolicy aSharePolicy, java.lang.Boolean aUniqueIpAddressesRequired)
Constructor that takesmin
,max
,sharePolicy
, anduniqueIpAddressesRequired
usingint
's.- Parameters:
aMin
- minimum number of IPs supported for an external hostaMax
- maximum number of IPs supported for an external hostaSharePolicy
- Share policy to set. Set tonull
if undefined.aUniqueIpAddressesRequired
- Indicates that all of the IP addresses for the host object must be unique, with a default value of "false". Set tonull
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 theEPPRegistryExternalHost
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Overrides:
encode
in classEPPRegistryAbstractMinMax
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPRegistryExternalHost
instance. - Throws:
EPPEncodeException
- - Unable to encodeEPPRegistryExternalHost
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPRegistryExternalHost
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Overrides:
decode
in classEPPRegistryAbstractMinMax
- Parameters:
aElement
- Root DOM Element to decodeEPPRegistryExternalHost
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPRegistryExternalHost
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPRegistryAbstractMinMax
- Returns:
- clone of
EPPRegistryExternalHost
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPRegistryExternalHost
compare.- Overrides:
equals
in classEPPRegistryAbstractMinMax
- Parameters:
aObject
-EPPRegistryExternalHost
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.
-
getSharePolicy
public EPPRegistryExternalHost.SharePolicy getSharePolicy()
Gets the share policy.- Returns:
- share policy if defined;
null
otherwise.
-
setSharePolicy
public void setSharePolicy(EPPRegistryExternalHost.SharePolicy aSharePolicy)
Sets the share policy.- Parameters:
aSharePolicy
- Share policy. Set tonull
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 tonull
the default value of "false" will be set.
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classEPPRegistryAbstractMinMax
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getRootName
protected java.lang.String getRootName()
Gets the root element local name.- Specified by:
getRootName
in classEPPRegistryAbstractMinMax
- Returns:
- Root element local name.
-
getElmMin
protected java.lang.String getElmMin()
Gets the minimum element local name.- Specified by:
getElmMin
in classEPPRegistryAbstractMinMax
- Returns:
- Minimum element local name.
-
getElmMax
protected java.lang.String getElmMax()
Gets the maximum element local name.- Specified by:
getElmMax
in classEPPRegistryAbstractMinMax
- Returns:
- Maximum element local name.
-
getLogger
protected org.slf4j.Logger getLogger()
Gets theLogger
to use.- Specified by:
getLogger
in classEPPRegistryAbstractMinMax
- Returns:
Logger
instance to use for logging.
-
-