public class EPPRegistryDomain extends java.lang.Object implements EPPCodecComponent
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.getAuthInfoRegex()
and
setAuthInfoRegex(EPPRegistryRegex)
to get and set the element.
false
. Use
getNullAuthInfoSupported()
and
setNullAuthInfoSupported(Boolean)
to get and set the element.HostModelSupported.hostObj
for the host object model and
HostModelSupported.hostAttr
for the host attribute model, with the
default value of "hostObj". Use getHostModelSupported()
and
setHostModelSupported(HostModelSupported)
to get and set the
element.EPPRegistryZone
,
EPPRegistryDomainName
,
EPPRegistryIDN
,
EPPRegistryDomainContact
,
EPPRegistryDomainPeriod
,
EPPRegistryDomainNSLimit
,
EPPRegistryDomainHostLimit
,
EPPRegistryDomainPeriod
,
EPPRegistryTransferHoldPeriodType
,
EPPRegistryGracePeriod
,
EPPRegistryRGP
,
EPPRegistryDNSSEC
,
EPPRegistrySupportedStatus
,
Serialized FormModifier and Type | Class and Description |
---|---|
static class |
EPPRegistryDomain.HostModelSupported
Possible values for the
hostModelSupported attribute. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_AUTH_INFO_REGEX
XML Element Name of
authInfoRegex attribute. |
static java.lang.String |
ELM_EXCEED_MAX_EX_DATE
XML Element Name of
exceedMaxExDate attribute. |
static java.lang.String |
ELM_HOST_MODEL_SUPPORTED
XML Element Name of
hostModelSupported attribute. |
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPRegistryDomain . |
static java.lang.String |
ELM_MAX_CHECK_DOMAIN
XML Element Name of
maxCheckDomain attribute. |
static java.lang.String |
ELM_NAME
XML root tag for
EPPRegistryDomain . |
static java.lang.String |
ELM_NULL_AUTH_INFO_SUPPORTED
XML Element Name of
nullAuthInfoSupported attribute. |
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. |
Constructor and Description |
---|
EPPRegistryDomain() |
Modifier and Type | Method and Description |
---|---|
void |
addContact(EPPRegistryDomainContact aContact)
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 |
addExceedMaxExDate(EPPRegistryExceedMaxExDate aExceedMaxExDate)
Adds a exceed maximum expiration date policy to the list.
|
void |
addGracePeriod(EPPRegistryGracePeriod aGracePeriod)
Append one instance of
EPPRegistryGracePeriod to the existing
List . |
void |
addPeriod(EPPRegistryDomainPeriod aPeriod)
Adds a supported period to the list of periods.
|
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<EPPRegistryDomainContact> |
getContacts()
Get domain contact policy.
|
java.lang.Boolean |
getContactsSupported()
Get the contact supported flag.
|
EPPRegistryDNSSEC |
getDnssec()
Get the DNS Security Extensions (DNSSEC) policies.
|
java.util.List<EPPRegistryDomainName> |
getDomainNames()
Get the
List of EPPRegistryDomainName that specifies the
domain name object policy. |
java.util.List<EPPRegistryExceedMaxExDate> |
getExceedMaxExDates()
Gets the
List of EPPRegistryExceedExDate instances that the
policy with exceeding the maximum expiration date for renewable commands. |
java.util.List<EPPRegistryGracePeriod> |
getGracePeriods()
Get the
List of attributes that defines the grace periods by
operation type. |
EPPRegistryDomain.HostModelSupported |
getHostModelSupported()
Gets the host model supported from RFC 5731, with the default set to
EPPRegistryDomain.HostModelSupported.hostObj . |
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.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.Boolean |
getNullAuthInfoSupported()
Get null auth info supported flag.
|
java.util.List<EPPRegistryDomainPeriod> |
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
|
boolean |
hasContacts()
Is the contacts defined?
|
boolean |
hasContactsSupported()
Is the contact supported flag flag defined?
|
boolean |
hasDomainNames()
Is the domain name policies defined?
|
boolean |
hasExceedMaxExDates()
Is the exceed maximum expiration dates defined?
|
boolean |
hasGracePeriods()
Is the grace periods defined?
|
boolean |
hasNullAuthInfoSupported()
Is the null auth info supported flag defined?
|
boolean |
hasPeriods()
Is the periods defined?
|
boolean |
hasPremiumSupport()
Is the premium support flag defined?
|
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<EPPRegistryDomainContact> aContacts)
Set domain contact policy.
|
void |
setContactsSupported(java.lang.Boolean aContactsSupported)
Set the contact supported flag.
|
void |
setDnssec(EPPRegistryDNSSEC dnssec)
Set the DNS Security Extensions (DNSSEC) policies.
|
void |
setDomainNames(java.util.List<EPPRegistryDomainName> aDomainNames)
Set the
List of EPPRegistryDomainName that specifies the
domain name object policy. |
void |
setExceedMaxExDates(java.util.List<EPPRegistryExceedMaxExDate> aExceedMaxExDates)
Sets the
List of EPPRegistryExceedExDate instances that the
policy with exceeding the maximum expiration date for renewable commands. |
void |
setGracePeriods(java.util.List<EPPRegistryGracePeriod> aGracePeriods)
Set the
List of attributes that defines the grace periods by
operation type. |
void |
setHostModelSupported(EPPRegistryDomain.HostModelSupported aHostModelSupported)
Sets the host model supported from RFC 5731, with the default set to
EPPRegistryDomain.HostModelSupported.hostObj . |
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 |
setNullAuthInfoSupported(java.lang.Boolean aNullAuthInfoSupported)
Set null auth info supported flag.
|
void |
setPeriods(java.util.List<EPPRegistryDomainPeriod> aPeriods)
Set
List of EPPRegistryDomainPeriod instances that define
the supported min/max/default periods by command type. |
void |
setPremiumSupport(java.lang.Boolean aPremiumSupport)
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 . |
public static final java.lang.String ELM_LOCALNAME
EPPRegistryDomain
.public static final java.lang.String ELM_NAME
EPPRegistryDomain
.public static final java.lang.String ELM_PREMIUM_SUPPORT
premiumSupport
attribute.public static final java.lang.String ELM_REGISTRANT
contactsSupported
attribute.public static final java.lang.String ELM_EXCEED_MAX_EX_DATE
exceedMaxExDate
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.public static final java.lang.String ELM_NULL_AUTH_INFO_SUPPORTED
nullAuthInfoSupported
attribute.public static final java.lang.String ELM_HOST_MODEL_SUPPORTED
hostModelSupported
attribute.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 withtrue
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 boolean hasDomainNames()
true
if the domain name policies is defined; false
otherwise.public java.util.List<EPPRegistryDomainName> 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<EPPRegistryDomainName> aDomainNames)
List
of EPPRegistryDomainName
that specifies the
domain name object policy.aDomainNames
- the List
of EPPRegistryDomainName
that specifies
the domain name object policypublic void addDomainName(EPPRegistryDomainName aDomainName)
aDomainName
- Domain name policy to addpublic EPPRegistryIDN getIdn()
public void setIdn(EPPRegistryIDN idn)
idn
- the Internationalized Domain Name (IDN) policy information.public boolean hasPremiumSupport()
true
if the premium support flag is defined; false
otherwise.public java.lang.Boolean getPremiumSupport()
public void setPremiumSupport(java.lang.Boolean aPremiumSupport)
aPremiumSupport
- flag that indicates whether the server supports premium domain
namespublic boolean hasContactsSupported()
true
if the contact supported flag is defined;
false
otherwise.public java.lang.Boolean getContactsSupported()
public void setContactsSupported(java.lang.Boolean aContactsSupported)
aContactsSupported
- flag that indicates whether contacts are supportedpublic boolean hasContacts()
true
if the contacts is defined; false
otherwise.public java.util.List<EPPRegistryDomainContact> getContacts()
List
of domain contact policypublic void setContacts(java.util.List<EPPRegistryDomainContact> aContacts)
aContacts
- List
of domain contact policypublic void addContact(EPPRegistryDomainContact aContact)
aContact
- 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 boolean hasPeriods()
true
if the periods is defined; false
otherwise.public java.util.List<EPPRegistryDomainPeriod> 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<EPPRegistryDomainPeriod> aPeriods)
List
of EPPRegistryDomainPeriod
instances that define
the supported min/max/default periods by command type. Command type must
be one of "create, "renew" and "transfer".aPeriods
- List
of EPPRegistryDomainPeriod
instancespublic void addPeriod(EPPRegistryDomainPeriod aPeriod)
aPeriod
- A period to add to the listpublic boolean hasExceedMaxExDates()
true
if the exceed maximum expiration dates is defined;
false
otherwise.public java.util.List<EPPRegistryExceedMaxExDate> getExceedMaxExDates()
List
of EPPRegistryExceedExDate
instances that the
policy with exceeding the maximum expiration date for renewable commands.List
of EPPRegistryExceedExDate
instances if
defined; null
otherwise.public void setExceedMaxExDates(java.util.List<EPPRegistryExceedMaxExDate> aExceedMaxExDates)
List
of EPPRegistryExceedExDate
instances that the
policy with exceeding the maximum expiration date for renewable commands.aExceedMaxExDates
- List
of EPPRegistryExceedExDate
instancespublic void addExceedMaxExDate(EPPRegistryExceedMaxExDate aExceedMaxExDate)
aExceedMaxExDate
- A exceed maximum expiration date policy to addpublic EPPRegistryTransferHoldPeriodType getTransferHoldPeriod()
EPPRegistryTransferHoldPeriodType
public void setTransferHoldPeriod(EPPRegistryTransferHoldPeriodType transferHoldPeriod)
transferHoldPeriod
- instance of EPPRegistryTransferHoldPeriodType
public boolean hasGracePeriods()
true
if the grace periods is defined; false
otherwise.public void addGracePeriod(EPPRegistryGracePeriod aGracePeriod)
EPPRegistryGracePeriod
to the existing
List
.aGracePeriod
- instance of EPPRegistryGracePeriod
public java.util.List<EPPRegistryGracePeriod> getGracePeriods()
List
of attributes that defines the grace periods by
operation type.List
of EPPRegistryGracePeriod
public void setGracePeriods(java.util.List<EPPRegistryGracePeriod> aGracePeriods)
List
of attributes that defines the grace periods by
operation type.aGracePeriods
- List
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 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 boolean hasNullAuthInfoSupported()
true
if the null auth info supported flag is defined;
false
otherwise.public java.lang.Boolean getNullAuthInfoSupported()
null
otherwise.public void setNullAuthInfoSupported(java.lang.Boolean aNullAuthInfoSupported)
aNullAuthInfoSupported
- flag that indicates whether the server supports the
<domain:null> element in [RFC5731]public 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 serverpublic EPPRegistryDomain.HostModelSupported getHostModelSupported()
EPPRegistryDomain.HostModelSupported.hostObj
.public void setHostModelSupported(EPPRegistryDomain.HostModelSupported aHostModelSupported)
EPPRegistryDomain.HostModelSupported.hostObj
.aHostModelSupported
- Host model supported enumerated value. If set to null
,
the default value of EPPRegistryDomain.HostModelSupported.hostObj
will be
used.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.