public class EPPDomainAddRemove extends java.lang.Object implements EPPCodecComponent
EPPDomainUpdateCmd
. In EPPDomainUpdateCmd
, an instance of
EPPDomainAddRemove
is used to specify the attributes to add; an
instance of EPPDomainAddRemove
is used to specify the attributes to
remove, and an instance of EPPDomainAddRemove
is used to specify the
attributes to changegetServers
and
setServers
to get and set the element.getContacts
and setContacts
to get and
set the element. This attribute will only be allowed if the Contact Mapping
is supported.getStatuses
and
setStatuses
to get and set the element.change
only, A <domain:registrant> element that
contains the identifier for the human or organizational social information
(contact) object to be associated with the domain object as the object
registrant. This object identifier MUST be known to the server before the
contact object can be associated with the domain object. Use
getRegistrant
and setRegistrant
to get and set the
element.EPPDomainAddRemove
will delegate the validation of the
cardinality of the domain attributes elements to the EPP Server.EPPDomainUpdateCmd
,
Serialized FormModifier and Type | Field and Description |
---|---|
static short |
MODE_ADD
mode of
EPPDomainAddRemove is to add attributes. |
static short |
MODE_REMOVE
mode of
EPPDomainAddRemove is to remove attributes. |
Constructor and Description |
---|
EPPDomainAddRemove()
Default constructor for
EPPDomainAddRemove . |
EPPDomainAddRemove(java.lang.String aRegistrant,
EPPAuthInfo aAuthInfo)
Constructor for
EPPDomainAddRemove that includes the attributes as
arguments. |
EPPDomainAddRemove(java.util.Vector aServers,
java.util.Vector aContacts,
java.util.Vector aStatuses)
Constructor for
EPPDomainAddRemove that includes the attributes as
arguments. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPDomainAddRemove . |
boolean |
contactsSupported()
Return if Domain Contacts is supported.
|
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPDomainAddRemove 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
EPPDomainAddRemove instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPDomainAddRemove compare. |
EPPAuthInfo |
getAuthInfo()
Get authorization information for the change mode
|
java.util.Vector |
getContacts()
Gets the contacts to add or remove.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getRegistrant()
Get registrant for the change mode
|
java.util.Vector |
getServers()
Gets the name servers.
|
java.util.Vector |
getStatuses()
Gets the statuses to add or remove.
|
boolean |
isEmpty()
Is the
EPPDomainAddRemove empty? |
void |
setAuthInfo(EPPAuthInfo aAuthInfo)
Set authorization information for the change mode
|
void |
setContacts(java.util.Vector aContacts)
Sets the contacts to add or remove.
|
void |
setRegistrant(java.lang.String newRegistrant)
Set registrant for the change mode
|
void |
setServers(java.util.Vector aServers)
Sets the name servers.
|
void |
setStatuses(java.util.Vector aStatuses)
Sets the statuses to add or remove.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final short MODE_ADD
EPPDomainAddRemove
is to add attributes.public static final short MODE_REMOVE
EPPDomainAddRemove
is to remove attributes.public EPPDomainAddRemove()
EPPDomainAddRemove
. All of the attribute
default to null
to indicate no modification.public EPPDomainAddRemove(java.util.Vector aServers, java.util.Vector aContacts, java.util.Vector aStatuses)
EPPDomainAddRemove
that includes the attributes as
arguments.aServers
- Vector of Name Server String
's. Is null
or empty
for no modifications.aContacts
- Vector of EPPDomainContact
instances. Is null
or
empty for no modifications. If the Contact Mapping is not
supported, this value should be null
.aStatuses
- Vector of status String
's. One of the
EPPDomainInfoResp.STATUS_
contants can be used for each
of the status values. Is null
or empty for no
modifications.public EPPDomainAddRemove(java.lang.String aRegistrant, EPPAuthInfo aAuthInfo)
EPPDomainAddRemove
that includes the attributes as
arguments.aRegistrant
- String
registrant for the change modeaAuthInfo
- EPPAuthInfo
authorization information for the change
modepublic java.util.Vector getServers()
String
instances containing the fully qualified name of a known name server host
object, or EPPHostAttr
instances containing the fully qualified
name of a host and optionally the host IP addresses.Vector
of name server String
instances for host
object references or EPPHostAttr
instances for host
attribute values if exists; null
otherwise.public void setServers(java.util.Vector aServers)
String
instances containing the fully qualified name of a known name server host
object, or EPPHostAttr
instances containing the fully qualified
name of a host and optionally the host IP addresses.aServers
- Vector
of name server String
instances for host
object references or EPPHostAttr
instances for host
attribute values.public java.util.Vector getContacts()
EPPDomainContact
instances.public void setContacts(java.util.Vector aContacts)
aContacts
- The contacts to add or remove.public java.util.Vector getStatuses()
EPPDomainInfoResp.STATUS_
constants can be used for the statuses.String
instances.public void setStatuses(java.util.Vector aStatuses)
EPPDomainInfoResp.STATUS_
constants can be used for the statuses.aStatuses
- Vector of status String
instances.public boolean contactsSupported()
true
if contacts are supported; false
otherwise.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPDomainAddRemove
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPDomainAddRemove
instance.EPPEncodeException
- Unable to encode EPPDomainAddRemove
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPDomainAddRemove
attributes from the aElement DOM
Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPDomainAddRemove
from.EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPDomainAddRemove
compare.equals
in class java.lang.Object
aObject
- EPPDomainAddRemove
instance to compare withtrue
when equal; false
otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPDomainAddRemove
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPDomainAddRemove
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 EPPAuthInfo getAuthInfo()
public java.lang.String getRegistrant()
public void setAuthInfo(EPPAuthInfo aAuthInfo)
aAuthInfo
- com.verisign.epp.codec.domain.EPPDomainAuthInfopublic void setRegistrant(java.lang.String newRegistrant)
newRegistrant
- java.lang.Stringpublic boolean isEmpty()
EPPDomainAddRemove
empty?true
if all of the attributes are null; false
otherwise.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.