Package com.verisign.epp.codec.registry
Class EPPRegistryHost
java.lang.Object
com.verisign.epp.codec.registry.EPPRegistryHost
- All Implemented Interfaces:
EPPCodecComponent,Serializable,Cloneable
Represents the host object policy information per RFC 5732. The
<registry:host> element contains the following child elements:
-
<registry:internal> - Defines the minimum and maximum number of IP
addresses supported for an internal host. Use
getInternal()andsetInternal(EPPRegistryInternalHost)to get and set the element. - <registry:external> - Defines the policies for external hosts. Use
getExternal()andsetExternal(EPPRegistryExternalHost)to get and set the element. - <registry:nameRegex> - Zero or more <registry:nameRegex> elements
that define the regular expressions used to validate the host name value. Use
getNameRegex()andsetNameRegex(List)to get and set the element. UseaddNameRegex(EPPRegistryRegex)to add one name regex to an existing list. - <registry:maxCheckHost> - The maximum number of host names
(<domain:name> elements) that can be included in a host check command
defined in RFC 5732. Use
getMaxCheckHost()andsetMaxCheckHost(Integer)to get and set the element. - <registry:supportedStatus> - The OPTIONAL set of supported host
statuses defined in RFC 5732. Use
getSupportedStatus()andsetSupportedStatus(EPPRegistrySupportedStatus)to get and set the element. - <registry:customData> - The OPTIONAL set of custom data using key, value pairs.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringXML Element Name ofauthInfoRegexattribute.static final StringXML Element Name ofcustomDataattribute.static final StringXML Element Name ofmaxCheckHostattribute.static final StringXML Element Name ofEPPRegistryHostroot element.static final StringXML Element Name ofnameRegexattribute. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddNameRegex(EPPRegistryRegex regex) Adds one host name regular expression to the existingList.clone()CloneEPPRegistryHost.voidDecode theEPPRegistryHostattributes from the aElement DOM Element tree.Encode a DOM Element tree from the attributes of theEPPRegistryHostinstance.booleanimplements a deepEPPRegistryHostcompare.Gets set of custom data using key, value pairs.Gets the external host attributes.Gets the internal host attributes.Gets maximum number of host names that can be included in a host check command.Gets host name regular expressions.Returns the XML namespace associated with theEPPCodecComponent.Gets a set of supported host statuses defined in RFC 5732.voidsetCustomData(EPPRegistryCustomData customData) Sets set of custom data using key, value pairs.voidsetExternal(EPPRegistryExternalHost external) Sets the external host attributes.voidsetInternal(EPPRegistryInternalHost internal) Sets the internal host attributes.voidsetMaxCheckHost(Integer maxCheckHost) Sets maximum number of host names that can be included in a host check command.voidsetNameRegex(List nameRegex) Sets host name regular expressions.voidsetSupportedStatus(EPPRegistrySupportedStatus supportedStatus) Sets a set of supported host statuses defined in RFC 5732.toString()Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.
-
Field Details
-
ELM_NAME
XML Element Name ofEPPRegistryHostroot element.- See Also:
-
ELM_REGEX
XML Element Name ofnameRegexattribute.- See Also:
-
ELM_MAX_CHECK
XML Element Name ofmaxCheckHostattribute.- See Also:
-
ELM_CUSTOM_DATA
XML Element Name ofcustomDataattribute.- See Also:
-
ELM_AUTH_INFO_REGEX
XML Element Name ofauthInfoRegexattribute.- See Also:
-
-
Constructor Details
-
EPPRegistryHost
public EPPRegistryHost()
-
-
Method Details
-
encode
Encode a DOM Element tree from the attributes of theEPPRegistryHostinstance.- Specified by:
encodein interfaceEPPCodecComponent- Parameters:
aDocument- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPRegistryHostinstance. - Throws:
EPPEncodeException- - Unable to encodeEPPRegistryHostinstance.
-
decode
Decode theEPPRegistryHostattributes from the aElement DOM Element tree.- Specified by:
decodein interfaceEPPCodecComponent- Parameters:
aElement- Root DOM Element to decodeEPPRegistryHostfrom.- Throws:
EPPDecodeException- Unable to decode aElement
-
clone
CloneEPPRegistryHost.- Specified by:
clonein interfaceEPPCodecComponent- Overrides:
clonein classObject- Returns:
- clone of
EPPRegistryHost - Throws:
CloneNotSupportedException- standard Object.clone exception
-
equals
implements a deepEPPRegistryHostcompare. -
toString
Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent. -
getInternal
Gets the internal host attributes.- Returns:
- the internal host attributes
-
setInternal
Sets the internal host attributes.- Parameters:
internal- the internal host attributes
-
getExternal
Gets the external host attributes.- Returns:
- the external host attributes
-
setExternal
Sets the external host attributes.- Parameters:
external- the external host attributes
-
getNameRegex
Gets host name regular expressions.- Returns:
Listof name regular expressions
-
setNameRegex
Sets host name regular expressions.- Parameters:
nameRegex-Listof name regular expressions
-
addNameRegex
Adds one host name regular expression to the existingList.- Parameters:
regex- one name regular expressions
-
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
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
Gets set of custom data using key, value pairs.- Returns:
- instance of
EPPRegistryCustomDatathat gives users the ability to specify custom data with key/value pairs
-
setCustomData
Sets set of custom data using key, value pairs.- Parameters:
customData- instance ofEPPRegistryCustomDatathat gives users the ability to specify custom data with key/value pairs
-
getSupportedStatus
Gets a set of supported host statuses defined in RFC 5732.- Returns:
- set of supported host statuses defined in RFC 5732
-
setSupportedStatus
Sets a set of supported host statuses defined in RFC 5732.- Parameters:
supportedStatus- set of supported host statuses defined in RFC 5732
-
getNamespace
Returns the XML namespace associated with theEPPCodecComponent.- Specified by:
getNamespacein interfaceEPPCodecComponent- Returns:
- XML namespace for the
EPPCodecComponent.
-