|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.registry.EPPRegistryDomain
public class EPPRegistryDomain
Represents the domain name object policy information per RFC 5731. Instance
of this class is encoded into the <registry:domain> element in the
<registry:zone> element when the server responds with the detailed
information of the zone object. The <registry:domain> must contain the
following child elements:
getDomainNames()
and setDomainNames(List)
to
get and set the element.getIdn()
and setIdn(EPPRegistryIDN)
to get
and set the element.false
. Use getPremiumSupport()
and
setPremiumSupport(Boolean)
to get and set the element.true
. Use
getContactsSupported()
and setContactsSupported(Boolean)
to
get and set the element.getContacts()
and setContacts(List)
to get and set the element. Use addContact(EPPRegistryDomainContact)
to append a contact to the existing contact list.getNameServerLimit()
and
setNameServerLimit(EPPRegistryDomainNSLimit)
to get and set the
element.getChildHostLimit()
and
setChildHostLimit(EPPRegistryDomainHostLimit)
to get and set the
element.getPeriods()
and
setPeriods(List)
to get and set the element.getTransferHoldPeriod()
and
setTransferHoldPeriod(EPPRegistryTransferHoldPeriodType)
to get and
set the element.getGracePeriods()
and setGracePeriods(List)
to get and set
the element.getRgp()
and setRgp(EPPRegistryRGP)
to get and set the
element.getDnssec()
and
setDnssec(EPPRegistryDNSSEC)
to get and set the element.setMaxCheckDomain(Integer)
and
getMaxCheckDomain()
to get and set the element.getSupportedStatus()
and
setSupportedStatus(EPPRegistrySupportedStatus)
to get and set the
element.getAuthInfoRegex()
and setAuthInfoRegex(EPPRegistryRegex)
to get and set the element.getCustomData()
and
setCustomData(EPPRegistryCustomData)
to get and set the element.
EPPRegistryZoneInfo
,
EPPRegistryDomainName
,
EPPRegistryIDN
,
EPPRegistryDomainContact
,
EPPRegistryDomainPeriod
,
EPPRegistryDomainNSLimit
,
EPPRegistryDomainHostLimit
,
EPPRegistryDomainPeriod
,
EPPRegistryTransferHoldPeriodType
,
EPPRegistryGracePeriod
,
EPPRegistryRGP
,
EPPRegistryDNSSEC
,
EPPRegistrySupportedStatus
,
EPPRegistryCustomData
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
ELM_AUTH_INFO_REGEX
XML Element Name of authInfoRegex attribute. |
static java.lang.String |
ELM_MAX_CHECK_DOMAIN
XML Element Name of maxCheckDomain attribute. |
static java.lang.String |
ELM_NAME
XML Element Name of EPPRegistryDomain root element. |
static java.lang.String |
ELM_PREMIUM_SUPPORT
XML Element Name of premiumSupport attribute. |
static java.lang.String |
ELM_REGISTRANT
XML Element Name of contactsSupported attribute. |
static java.lang.String |
ELM_URGENT
Deprecated. XML Element Name of urgent attribute. |
Constructor Summary | |
---|---|
EPPRegistryDomain()
|
Method Summary | |
---|---|
void |
addContact(EPPRegistryDomainContact contact)
Append a domain contact policy to the existing list. |
void |
addDomainName(EPPRegistryDomainName aDomainName)
Add a domain name object policy to the list of domain name policies. |
void |
addGracePeriod(EPPRegistryGracePeriod gracePeriod)
Append one instance of EPPRegistryGracePeriod to the existing
List . |
void |
addPeriod(EPPRegistryDomainPeriod period)
|
java.lang.Object |
clone()
Clone EPPRegistryDomain . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPRegistryDomain 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 the EPPRegistryDomain instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPRegistryDomain compare. |
EPPRegistryRegex |
getAuthInfoRegex()
Get info about regular expression used to validate the domain object authorization information value. |
EPPRegistryDomainHostLimit |
getChildHostLimit()
Get child host limit. |
java.util.List |
getContacts()
Get domain contact policy. |
java.lang.Boolean |
getContactsSupported()
Get the contact supported flag. |
EPPRegistryCustomData |
getCustomData()
Get set of custom data using key, value pairs. |
EPPRegistryDNSSEC |
getDnssec()
Get the DNS Security Extensions (DNSSEC) policies. |
java.util.List |
getDomainNames()
Get the List of EPPRegistryDomainName that specifies the
domain name object policy. |
java.util.List |
getGracePeriods()
Get the List of attributes that defines the grace periods by
operation type. |
EPPRegistryIDN |
getIdn()
Get the Internationalized Domain Name (IDN) policy information. |
java.lang.Integer |
getMaxCheckDomain()
Get the attribute that defines the maximum number of domain names (<domain:name> elements) that can be included in a domain check command defined in RFC 5731. |
EPPRegistryDomainNSLimit |
getNameServerLimit()
Get NS limit definition. |
java.util.List |
getPeriods()
Get List of EPPRegistryDomainPeriod instances that define
the supported min/max/default registration periods by command type. |
java.lang.Boolean |
getPremiumSupport()
Get premium support flag. |
EPPRegistryRGP |
getRgp()
Get the information about Registry Grace Period (RGP). |
EPPRegistrySupportedStatus |
getSupportedStatus()
Get domain status supported by the server. |
EPPRegistryTransferHoldPeriodType |
getTransferHoldPeriod()
Get the period of time a domain object is in the pending transfer before the transfer is auto approved by the server |
void |
setAuthInfoRegex(EPPRegistryRegex authInfoRegex)
Set info about regular expression used to validate the domain object authorization information value. |
void |
setChildHostLimit(EPPRegistryDomainHostLimit childHostLimit)
Set child host limit. |
void |
setContacts(java.util.List contacts)
Set domain contact policy. |
void |
setContactsSupported(java.lang.Boolean contactsSupported)
Set the contact supported flag. |
void |
setCustomData(EPPRegistryCustomData customData)
Set set of custom data using key, value pairs. |
void |
setDnssec(EPPRegistryDNSSEC dnssec)
Set the DNS Security Extensions (DNSSEC) policies. |
void |
setDomainNames(java.util.List domainNames)
Set the List of EPPRegistryDomainName that specifies the
domain name object policy. |
void |
setGracePeriods(java.util.List gracePeriods)
Set the List of attributes that defines the grace periods by
operation type. |
void |
setIdn(EPPRegistryIDN idn)
Set the Internationalized Domain Name (IDN) policy information. |
void |
setMaxCheckDomain(java.lang.Integer maxCheckDomain)
Set the attribute that defines the maximum number of domain names (<domain:name> elements) that can be included in a domain check command defined in RFC 5731. |
void |
setNameServerLimit(EPPRegistryDomainNSLimit nameServerLimit)
Set NS limit definition. |
void |
setPeriods(java.util.List periods)
Set List of EPPRegistryDomainPeriod instances that define
the supported min/max/default registration periods by command type. |
void |
setPremiumSupport(java.lang.Boolean premiumSupport)
Set premium support flag. |
void |
setRgp(EPPRegistryRGP rgp)
Set the information about Registry Grace Period (RGP). |
void |
setSupportedStatus(EPPRegistrySupportedStatus supportedStatus)
Set domain status supported by the server. |
void |
setTransferHoldPeriod(EPPRegistryTransferHoldPeriodType transferHoldPeriod)
Set the period of time a domain object is in the pending transfer before the transfer is auto approved by the server |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ELM_NAME
EPPRegistryDomain
root element.
public static final java.lang.String ELM_PREMIUM_SUPPORT
premiumSupport
attribute.
public static final java.lang.String ELM_REGISTRANT
contactsSupported
attribute.
@Deprecated public static final java.lang.String ELM_URGENT
urgent
attribute.public static final java.lang.String ELM_MAX_CHECK_DOMAIN
maxCheckDomain
attribute.
public static final java.lang.String ELM_AUTH_INFO_REGEX
authInfoRegex
attribute.
Constructor Detail |
---|
public EPPRegistryDomain()
Method Detail |
---|
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPRegistryDomain
instance.
encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.
EPPRegistryDomain
instance.
EPPEncodeException
- - Unable to encode EPPRegistryDomain
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPRegistryDomain
attributes from the aElement DOM
Element tree.
decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPRegistryDomain
from.
EPPDecodeException
- Unable to decode aElementpublic boolean equals(java.lang.Object aObject)
EPPRegistryDomain
compare.
equals
in class java.lang.Object
aObject
- EPPRegistryDomain
instance to compare with
true
if this object is the same as the aObject argument;
false
otherwisepublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPRegistryDomain
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPRegistryDomain
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.public void addDomainName(EPPRegistryDomainName aDomainName)
aDomainName
- Domain name policy to addpublic java.util.List getDomainNames()
List
of EPPRegistryDomainName
that specifies the
domain name object policy.
List
of EPPRegistryDomainName
that specifies
the domain name object policypublic void setDomainNames(java.util.List domainNames)
List
of EPPRegistryDomainName
that specifies the
domain name object policy.
domainNames
- the List
of EPPRegistryDomainName
that
specifies the domain name object policypublic EPPRegistryIDN getIdn()
public void setIdn(EPPRegistryIDN idn)
idn
- the Internationalized Domain Name (IDN) policy information.public java.lang.Boolean getPremiumSupport()
public void setPremiumSupport(java.lang.Boolean premiumSupport)
premiumSupport
- flag that indicates whether the server supports premium domain
namespublic java.lang.Boolean getContactsSupported()
public void setContactsSupported(java.lang.Boolean contactsSupported)
contactsSupported
- flag that indicates whether contacts are supportedpublic java.util.List getContacts()
List
of domain contact policypublic void setContacts(java.util.List contacts)
contacts
- List
of domain contact policypublic void addContact(EPPRegistryDomainContact contact)
contact
- domain contact policy for one of the "admin", "tech", or
"billing" contact.public EPPRegistryDomainNSLimit getNameServerLimit()
EPPRegistryDomainNSLimit
that defines min/max
number of delegated host objects (name servers) that can be
associated with a domain objectpublic void setNameServerLimit(EPPRegistryDomainNSLimit nameServerLimit)
nameServerLimit
- instance of EPPRegistryDomainNSLimit
that defines
min/max number of delegated host objects (name servers) that
can be associated with a domain objectpublic EPPRegistryDomainHostLimit getChildHostLimit()
EPPRegistryDomainHostLimit
that defines the
minimum and maximum number of subordinate host objects (child
hosts) for a domain object.public void setChildHostLimit(EPPRegistryDomainHostLimit childHostLimit)
childHostLimit
- Instance of EPPRegistryDomainHostLimit
that defines
the minimum and maximum number of subordinate host objects
(child hosts) for a domain object.public java.util.List getPeriods()
List
of EPPRegistryDomainPeriod
instances that define
the supported min/max/default registration periods by command type.
Command type must be one of "create, "renew" and "transfer".
List
of EPPRegistryDomainPeriod
instancespublic void setPeriods(java.util.List periods)
List
of EPPRegistryDomainPeriod
instances that define
the supported min/max/default registration periods by command type.
Command type must be one of "create, "renew" and "transfer".
periods
- List
of EPPRegistryDomainPeriod
instancespublic void addPeriod(EPPRegistryDomainPeriod period)
public EPPRegistryTransferHoldPeriodType getTransferHoldPeriod()
EPPRegistryTransferHoldPeriodType
public void setTransferHoldPeriod(EPPRegistryTransferHoldPeriodType transferHoldPeriod)
transferHoldPeriod
- instance of EPPRegistryTransferHoldPeriodType
public java.util.List getGracePeriods()
List
of attributes that defines the grace periods by
operation type.
List
of EPPRegistryGracePeriod
public void setGracePeriods(java.util.List gracePeriods)
List
of attributes that defines the grace periods by
operation type.
gracePeriods
- List
of EPPRegistryGracePeriod
public void addGracePeriod(EPPRegistryGracePeriod gracePeriod)
EPPRegistryGracePeriod
to the existing
List
.
gracePeriod
- instance of EPPRegistryGracePeriod
public EPPRegistryRGP getRgp()
EPPRegistryRGP
.public void setRgp(EPPRegistryRGP rgp)
rgp
- instance of EPPRegistryRGP
.public EPPRegistryDNSSEC getDnssec()
EPPRegistryDNSSEC
that defines the DNS
Security Extensions (DNSSEC) policies.public void setDnssec(EPPRegistryDNSSEC dnssec)
dnssec
- instance of EPPRegistryDNSSEC
that defines the DNS
Security Extensions (DNSSEC) policies.public java.lang.Integer getMaxCheckDomain()
public void setMaxCheckDomain(java.lang.Integer maxCheckDomain)
maxCheckDomain
- maximum number of domain names (<domain:name> elements)
that can be included in a domain check command defined in RFC
5731.public EPPRegistryCustomData getCustomData()
EPPRegistryCustomData
that gives users the
ability to specify custom data with key/value pairspublic void setCustomData(EPPRegistryCustomData customData)
customData
- instance of EPPRegistryCustomData
that gives users the
ability to specify custom data with key/value pairspublic EPPRegistryRegex getAuthInfoRegex()
EPPRegistryRegex
that specifies regular
expression used to validate the domain object authorization
information valuepublic void setAuthInfoRegex(EPPRegistryRegex authInfoRegex)
authInfoRegex
- instance of EPPRegistryRegex
that specifies regular
expression used to validate the domain object authorization
information valuepublic EPPRegistrySupportedStatus getSupportedStatus()
EPPRegistrySupportedStatus
that contains a
list of supported domain status by the serverpublic void setSupportedStatus(EPPRegistrySupportedStatus supportedStatus)
supportedStatus
- instance of EPPRegistrySupportedStatus
that contains a
list of supported domain status by the server
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |