Package com.verisign.epp.codec.host
Class EPPHostAddRemove
- java.lang.Object
-
- com.verisign.epp.codec.host.EPPHostAddRemove
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPHostAddRemove extends java.lang.Object implements EPPCodecComponent
Represents attributes to add, remove or change with aEPPHostUpdateCmd
. InEPPHostUpdateCmd
, an instance ofEPPHostAddRemove
is used to specify the attributes to add, an instance ofEPPHostAddRemove
is used to specify the attributes to remove and instance ofEPPHostAddRemove
is used to specify the attributes to change
The <host:add> and <host:rem> elements SHALL contain the following child elements:
- One or more <host:address> elements that contains the IP addresses to be associated with or removed from the host. IP address restrictions explained in the <create> command mapping apply here as well.
- One or more <host:status> elements that contain status values to be associated with or removed from the object. When specifying a value to be removed, only the attribute value is significant; element text is not required to match a value for removal.
The <host:chg> element SHALL contain the following child elements:
- A <host:name> element that contains a new fully qualified host name by which the host object will be known.
- See Also:
EPPHostUpdateCmd
,EPPHostAddress
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EPPHostAddRemove()
Default constructor forEPPHostAddRemove
.EPPHostAddRemove(java.lang.String aName)
Constructor forEPPHostAddRemove
.EPPHostAddRemove(java.util.Vector aAddresses)
Constructor forEPPHostAddRemove
that includes the attributes as arguments.EPPHostAddRemove(java.util.Vector aAddresses, java.util.Vector aStatuses)
Constructor forEPPHostAddRemove
that includes the attributes as arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPHostAddRemove
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPHostAddRemove
attributes from theaElement
DOM Element tree.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of theEPPHostAddRemove
instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPHostAddRemove
compare.java.util.Vector
getAddresses()
Gets the addresses to add or remove.java.lang.String
getName()
Gets name.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.util.Vector
getStatuses()
Gets statuses.void
setAddresses(java.util.Vector aAddresses)
Sets the addresses to add or remove.void
setName(java.lang.String aName)
Sets name.void
setStatuses(java.util.Vector aStatuses)
Sets statuses.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Constructor Detail
-
EPPHostAddRemove
public EPPHostAddRemove()
Default constructor forEPPHostAddRemove
. The addresses attribute defaults tonull
.
-
EPPHostAddRemove
public EPPHostAddRemove(java.util.Vector aAddresses)
Constructor forEPPHostAddRemove
that includes the attributes as arguments.- Parameters:
aAddresses
- Vector ofEPPHostAddress
instances. Isnull
or empty for no modifications.
-
EPPHostAddRemove
public EPPHostAddRemove(java.lang.String aName)
Constructor forEPPHostAddRemove
. The addresses attribute defaults tonull
.- Parameters:
aName
- DOCUMENT ME!
-
EPPHostAddRemove
public EPPHostAddRemove(java.util.Vector aAddresses, java.util.Vector aStatuses)
Constructor forEPPHostAddRemove
that includes the attributes as arguments.- Parameters:
aAddresses
- Vector ofEPPHostAddress
instances. Isnull
or empty for no modifications.aStatuses
- Vector ofEPPHostStatus
instances. Isnull
or empty for no modifications.
-
-
Method Detail
-
getAddresses
public java.util.Vector getAddresses()
Gets the addresses to add or remove.- Returns:
- Vector
EPPHostAddress
instances if defined;null
otherwise.
-
setAddresses
public void setAddresses(java.util.Vector aAddresses)
Sets the addresses to add or remove.- Parameters:
aAddresses
- Vector ofEPPHostAddress
instances.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPHostAddRemove
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPHostAddRemove
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPHostAddRemove
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPHostAddRemove
attributes from theaElement
DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPHostAddRemove
from.- Throws:
EPPDecodeException
- Unable to decodeaElement
.
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPHostAddRemove
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPHostAddRemove
instance to compare with- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPHostAddRemove
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPHostAddRemove
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
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.
-
getName
public java.lang.String getName()
Gets name.- Returns:
- String Name
-
getStatuses
public java.util.Vector getStatuses()
Gets statuses.- Returns:
Vector
ofEPPHostStatus
if defined;null
otherwise.
-
setName
public void setName(java.lang.String aName)
Sets name.- Parameters:
aName
- String
-
setStatuses
public void setStatuses(java.util.Vector aStatuses)
Sets statuses.- Parameters:
aStatuses
-Vector
ofEPPHostStatus
instances
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-