Class EPPRegistryContact
- java.lang.Object
-
- com.verisign.epp.codec.registry.v02.EPPRegistryContact
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPRegistryContact extends java.lang.Object implements EPPCodecComponent
Represents the optional contact object policy information per RFC 5733. The <registry:contact> element contains the following child elements:
- <registry:contactIdRegEx> - The OPTIONAL regular expression used to validate the <contact:id> element defined in RFC 5733.
- <registry:contactIdPrefix> - The OPTIONAL client-specific prefix that must be used for the <contact:id> element defined in RFC 5733. For example, if the client is assigned the client-specific prefix "EX", every contact created by the client must have a <contact:id> element value prefixed with "EX", as in "EX123".
- <registry:sharePolicy> - The OPTIONAL policy for the sharing of
contacts in the server. The possible shared policy values include:
- "perZone" - The contacts are shared across all objects of the zone. There is a single pool of contacts defined for the zone.
- "perSystem" - The contacts are shared across all zones of the system. There is a single pool of contacts across all of the zones supported by the system.
- <registry:postalInfoTypeSupport> - The policy associated with the postal-address information, represented by the <contact:postalInfo> element in [RFC5733]
- <registry:postalInfo> - The postal-address information policy information.
- <registry:maxCheckContact> - The maximum number of contact identifiers (<contact:id> elements) that can be included in a contact check command defined in RFC 5733.
- <registry:authInfoRegex> - The OPTIONAL regular expression used to validate the contact object authorization information value.
- <registry:clientDisclosureSupported> - The OPTIONAL flag that
indicates whether the server supports the client to identify elements that
require exception server-operator handling to allow or restrict disclosure to
third parties defined in RFC 5733. Default value is
false
. - <registry:supportedStatus> - The OPTIONAL set of supported contact statuses defined in RFC 5733.
- <registry:transferHoldPeriod> - The OPTIONAL period of time a contact object is in the pending transfer before the transfer is auto approved by the server. The <registry:transferHoldPeriod> element MUST have the "unit" attribute with the possible values of "y" for year, "m" for month, and "d" for day.
- <registry:customData> - The OPTIONAL set of custom data using key, value pairs.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EPPRegistryContact.PostalInfoTypeSupport
Possible values for thepostalInfoTypeSupport
attribute.static class
EPPRegistryContact.SharePolicy
Possible values for thesharePolicy
attribute.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_AUTH_INFO_REGEX
XML local name for the authInfoRegexstatic java.lang.String
ELM_CONTACT_ID_PREFIX
XML local name for the contactIdPrefixstatic java.lang.String
ELM_CONTACT_ID_REGEX
XML local name for the contactIdRegexstatic java.lang.String
ELM_CUSTOM_CLIENT_DISCLOSURE_SUPPORTED
XML local name for the clientDisclosureSupportedstatic java.lang.String
ELM_CUSTOM_DATA
XML local name for the customDatastatic java.lang.String
ELM_LOCALNAME
Constant for the status local namestatic java.lang.String
ELM_MAX_CHECK
XML local name for the maxCheckContactstatic java.lang.String
ELM_NAME
Constant for the contact (prefix and local name)static java.lang.String
ELM_POSTAL_INFO_TYPE_SUPPORT
XML local name for thepostalInfoTypeSupport
attributestatic java.lang.String
ELM_SHARE_POLICY
XML local name for the sharePolicy
-
Constructor Summary
Constructors Constructor Description EPPRegistryContact()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPRegistryContact
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPRegistryContact
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 theEPPRegistryContact
instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPRegistryContact
compare.EPPRegistryRegex
getAuthInfoRegex()
Gets authInfo regular expression.java.lang.Boolean
getClientDisclosureSupported()
Gets client disclosure flag.java.lang.String
getContactIdPrefix()
Gets the contact Id prefix.EPPRegistryRegex
getContactIdRegex()
Get info about regular expression used to validate the contact object contact Id value.java.lang.Integer
getMaxCheckContact()
Gets maximum number of contacts allowed in the check command.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.EPPRegistryPostal
getPostalInfo()
Gets postal-address information policy information.EPPRegistryContact.PostalInfoTypeSupport
getPostalInfoTypeSupport()
Gets the policy associated with the postal-address information, represented by the <contact:postalInfo> element.EPPRegistryContact.SharePolicy
getSharePolicy()
Gets the share policy.EPPRegistrySupportedStatus
getSupportedStatus()
Gets a set of supported host statuses defined in RFC 5733.EPPRegistryTransferHoldPeriodType
getTransferHoldPeriod()
Get the period of time a contact object is in the pending transfer before the transfer is auto approved by the serverboolean
hasContactIdPrefix()
Has contact Id prefix?boolean
hasSharePolicy()
Is the share policy defined?void
setAuthInfoRegex(EPPRegistryRegex authInfoRegex)
Gets authInfo regular expression.void
setClientDisclosureSupported(java.lang.Boolean clientDisclosureSupported)
Sets client disclosure flag.void
setContactIdPrefix(java.lang.String aContactIdPrefix)
Sets the contact Id prefix.void
setContactIdRegex(EPPRegistryRegex aContactIdRegex)
Set info about regular expression used to validate the contact object contact Id value.void
setIntPostalInfoTypeSupport(EPPRegistryContact.PostalInfoTypeSupport aPostalInfoTypeSupport)
Sets the policy associated with the postal-address information, represented by the <contact:postalInfo> element.void
setMaxCheckContact(java.lang.Integer maxCheckContact)
Gets maximum number of contacts allowed in the check command.void
setPostalInfo(EPPRegistryPostal postalInfo)
Sets postal-address information policy information.void
setSharePolicy(EPPRegistryContact.SharePolicy aSharePolicy)
Sets the share policy.void
setSupportedStatus(EPPRegistrySupportedStatus supportedStatus)
Sets a set of supported host statuses defined in RFC 5733.void
setTransferHoldPeriod(EPPRegistryTransferHoldPeriodType transferHoldPeriod)
Set the period of time a contact object is in the pending transfer before the transfer is auto approved by the serverjava.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
Constant for the status local name- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
Constant for the contact (prefix and local name)- See Also:
- Constant Field Values
-
ELM_CONTACT_ID_REGEX
public static final java.lang.String ELM_CONTACT_ID_REGEX
XML local name for the contactIdRegex- See Also:
- Constant Field Values
-
ELM_CONTACT_ID_PREFIX
public static final java.lang.String ELM_CONTACT_ID_PREFIX
XML local name for the contactIdPrefix- See Also:
- Constant Field Values
-
ELM_SHARE_POLICY
public static final java.lang.String ELM_SHARE_POLICY
XML local name for the sharePolicy- See Also:
- Constant Field Values
-
ELM_POSTAL_INFO_TYPE_SUPPORT
public static final java.lang.String ELM_POSTAL_INFO_TYPE_SUPPORT
XML local name for thepostalInfoTypeSupport
attribute- See Also:
- Constant Field Values
-
ELM_MAX_CHECK
public static final java.lang.String ELM_MAX_CHECK
XML local name for the maxCheckContact- See Also:
- Constant Field Values
-
ELM_AUTH_INFO_REGEX
public static final java.lang.String ELM_AUTH_INFO_REGEX
XML local name for the authInfoRegex- See Also:
- Constant Field Values
-
ELM_CUSTOM_DATA
public static final java.lang.String ELM_CUSTOM_DATA
XML local name for the customData- See Also:
- Constant Field Values
-
ELM_CUSTOM_CLIENT_DISCLOSURE_SUPPORTED
public static final java.lang.String ELM_CUSTOM_CLIENT_DISCLOSURE_SUPPORTED
XML local name for the clientDisclosureSupported- See Also:
- Constant Field Values
-
-
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 theEPPRegistryContact
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPRegistryContact
instance. - Throws:
EPPEncodeException
- - Unable to encodeEPPRegistryContact
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPRegistryContact
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPRegistryContact
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPRegistryContact
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPRegistryContact
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPRegistryContact
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPRegistryContact
instance to compare with- Returns:
true
if this object is the same as the aObject argument;false
otherwise
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getContactIdRegex
public EPPRegistryRegex getContactIdRegex()
Get info about regular expression used to validate the contact object contact Id value.- Returns:
- instance of
EPPRegistryRegex
that specifies regular expression used to validate the domain object authorization information value
-
setContactIdRegex
public void setContactIdRegex(EPPRegistryRegex aContactIdRegex)
Set info about regular expression used to validate the contact object contact Id value.- Parameters:
aContactIdRegex
- instance ofEPPRegistryRegex
that specifies regular expression used to validate the contact object contact Id value
-
hasContactIdPrefix
public boolean hasContactIdPrefix()
Has contact Id prefix?- Returns:
true
if the contact Id prefix is defined;false
otherwise.
-
getContactIdPrefix
public java.lang.String getContactIdPrefix()
Gets the contact Id prefix.- Returns:
- contact Id prefix if defined;
null
otherwise.
-
setContactIdPrefix
public void setContactIdPrefix(java.lang.String aContactIdPrefix)
Sets the contact Id prefix.- Parameters:
aContactIdPrefix
- Contact Id prefix
-
hasSharePolicy
public boolean hasSharePolicy()
Is the share policy defined?- Returns:
true
if the share policy is defined;false
otherwise.
-
getSharePolicy
public EPPRegistryContact.SharePolicy getSharePolicy()
Gets the share policy.- Returns:
- share policy if defined;
null
otherwise.
-
setSharePolicy
public void setSharePolicy(EPPRegistryContact.SharePolicy aSharePolicy)
Sets the share policy.- Parameters:
aSharePolicy
- Share policy. Set tonull
to clear it.
-
getPostalInfoTypeSupport
public EPPRegistryContact.PostalInfoTypeSupport getPostalInfoTypeSupport()
Gets the policy associated with the postal-address information, represented by the <contact:postalInfo> element.- Returns:
- The policy based on the
EPPRegistryContact.PostalInfoTypeSupport
enumerated values if defined;null
otherwise.
-
setIntPostalInfoTypeSupport
public void setIntPostalInfoTypeSupport(EPPRegistryContact.PostalInfoTypeSupport aPostalInfoTypeSupport)
Sets the policy associated with the postal-address information, represented by the <contact:postalInfo> element.- Parameters:
aPostalInfoTypeSupport
- The policy based on theEPPRegistryContact.PostalInfoTypeSupport
enumerated values
-
getMaxCheckContact
public java.lang.Integer getMaxCheckContact()
Gets maximum number of contacts allowed in the check command.- Returns:
- maximum number of contact identifiers (<contact:id> elements) that can be included in a contact check command defined in RFC 5733
-
setMaxCheckContact
public void setMaxCheckContact(java.lang.Integer maxCheckContact)
Gets maximum number of contacts allowed in the check command.- Parameters:
maxCheckContact
- maximum number of contact identifiers (<contact:id> elements) that can be included in a contact check command defined in RFC 5733
-
getAuthInfoRegex
public EPPRegistryRegex getAuthInfoRegex()
Gets authInfo regular expression.- Returns:
- regular expression used to validate the contact object authorization information value
-
setAuthInfoRegex
public void setAuthInfoRegex(EPPRegistryRegex authInfoRegex)
Gets authInfo regular expression.- Parameters:
authInfoRegex
- regular expression used to validate the contact object authorization information value
-
getPostalInfo
public EPPRegistryPostal getPostalInfo()
Gets postal-address information policy information.- Returns:
- the postal-address information policy information
-
setPostalInfo
public void setPostalInfo(EPPRegistryPostal postalInfo)
Sets postal-address information policy information.- Parameters:
postalInfo
- the postal-address information policy information
-
getClientDisclosureSupported
public java.lang.Boolean getClientDisclosureSupported()
Gets client disclosure flag.- Returns:
true
if the server supports the client to identify elements that require exception server-operator handling to allow or restrict disclosure to third parties defined in RFC 5733.false
otherwise
-
setClientDisclosureSupported
public void setClientDisclosureSupported(java.lang.Boolean clientDisclosureSupported)
Sets client disclosure flag.- Parameters:
clientDisclosureSupported
-true
if the server supports the client to identify elements that require exception server-operator handling to allow or restrict disclosure to third parties defined in RFC 5733.false
otherwise
-
getSupportedStatus
public EPPRegistrySupportedStatus getSupportedStatus()
Gets a set of supported host statuses defined in RFC 5733.- Returns:
- set of supported host statuses defined in RFC 5733
-
setSupportedStatus
public void setSupportedStatus(EPPRegistrySupportedStatus supportedStatus)
Sets a set of supported host statuses defined in RFC 5733.- Parameters:
supportedStatus
- set of supported host statuses defined in RFC 5733
-
getTransferHoldPeriod
public EPPRegistryTransferHoldPeriodType getTransferHoldPeriod()
Get the period of time a contact object is in the pending transfer before the transfer is auto approved by the server- Returns:
- instance of
EPPRegistryTransferHoldPeriodType
-
setTransferHoldPeriod
public void setTransferHoldPeriod(EPPRegistryTransferHoldPeriodType transferHoldPeriod)
Set the period of time a contact object is in the pending transfer before the transfer is auto approved by the server- Parameters:
transferHoldPeriod
- instance ofEPPRegistryTransferHoldPeriodType
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-