|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPUpdateCmd
com.verisign.epp.codec.host.EPPHostUpdateCmd
public class EPPHostUpdateCmd
Represents an EPP Host <update> command, which provides a transform
operation that allows a client to modify the attributes of a host object.
In addition to the standard EPP command elements, the <update>
command MUST contain a <host:update> element that identifies the host
namespace and the location of the host schema. The <host:update>
element SHALL contain the following child elements:
getName
and
setName
to get and set the element.
getAdd
and setAdd
to get and set the element.
getRemove
and
setRemove
to get and set the element.
getChange
and
setChange
to get and set the element.
EPPReponse
is the response associated with
EPPHostUpdateCmd
.
EPPResponse
,
EPPHostAddRemove
,
Serialized FormField Summary |
---|
Fields inherited from class com.verisign.epp.codec.gen.EPPCommand |
---|
extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE |
Constructor Summary | |
---|---|
EPPHostUpdateCmd()
EPPHostUpdateCmd default constructor. |
|
EPPHostUpdateCmd(java.lang.String aTransId,
java.lang.String aName)
EPPHostUpdateCmd constructor. |
|
EPPHostUpdateCmd(java.lang.String aTransId,
java.lang.String aName,
EPPHostAddRemove aAdd,
EPPHostAddRemove aRemove,
EPPHostAddRemove aChange)
EPPHostUpdateCmd constructor that takes the required
attributes as arguments. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPHostUpdateCmd . |
protected void |
doDecode(org.w3c.dom.Element aElement)
Decode the EPPHostUpdateCmd attributes from the aElement
DOM Element tree. |
protected org.w3c.dom.Element |
doEncode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the EPPHostUpdateCmd instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of EPPHostUpdateCmd with this instance. |
EPPHostAddRemove |
getAdd()
Gets the items to add to the host. |
EPPHostAddRemove |
getChange()
Gets the items to change to the host. |
java.lang.String |
getName()
Gets the host name to update. |
java.lang.String |
getNamespace()
Gets the EPP command Namespace associated with EPPHostUpdateCmd . |
EPPHostAddRemove |
getRemove()
Gets the items to remove from the host. |
void |
setAdd(EPPHostAddRemove aAdd)
Sets the items to add to the host. |
void |
setChange(EPPHostAddRemove newChange)
Sets the items to add to the host. |
void |
setName(java.lang.String aName)
Sets the host name to update. |
void |
setRemove(EPPHostAddRemove aRemove)
Sets the items to remove from the host. |
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 com.verisign.epp.codec.gen.EPPUpdateCmd |
---|
doGenDecode, doGenEncode, getType |
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand |
---|
addExtension, decode, encode, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EPPHostUpdateCmd()
EPPHostUpdateCmd
default constructor. The name is
initialized to null
. The name must be set before
invoking encode
.
public EPPHostUpdateCmd(java.lang.String aTransId, java.lang.String aName)
EPPHostUpdateCmd
constructor.
aTransId
- Transaction Id associated with the command.aName
- Host name to update.public EPPHostUpdateCmd(java.lang.String aTransId, java.lang.String aName, EPPHostAddRemove aAdd, EPPHostAddRemove aRemove, EPPHostAddRemove aChange)
EPPHostUpdateCmd
constructor that takes the required
attributes as arguments.
aTransId
- Transaction Id associated with the command.aName
- Host name to update.aAdd
- Attributes to add to the host. null
if no
additions.aRemove
- Attributes to remove from the host. null
if
no removals.aChange
- Attributes to change from the host. null
if
no changes.Method Detail |
---|
public java.lang.String getNamespace()
EPPHostUpdateCmd
.
getNamespace
in interface EPPMessage
getNamespace
in class EPPCommand
EPPHostMapFactory.NS
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPHostUpdateCmd
instance.
doEncode
in class EPPUpdateCmd
aDocument
- DOM Document that is being built. Used as an Element
factory.
EPPHostUpdateCmd
instance.
EPPEncodeException
- Unable to encode
EPPHostUpdateCmd
instance.protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPHostUpdateCmd
attributes from the aElement
DOM Element tree.
doDecode
in class EPPUpdateCmd
aElement
- Root DOM Element to decode EPPHostUpdateCmd
from.
EPPDecodeException
- Unable to decode aElementpublic boolean equals(java.lang.Object aObject)
EPPHostUpdateCmd
with this instance.
equals
in class EPPUpdateCmd
aObject
- Object to compare with.
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPHostUpdateCmd
.
clone
in interface EPPCodecComponent
clone
in class EPPCommand
EPPHostUpdateCmd
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 EPPCommand
String
if successful;
ERROR
otherwise.public java.lang.String getName()
null
otherwise.public void setName(java.lang.String aName)
aName
- Host Namepublic EPPHostAddRemove getAdd()
null
otherwise.public void setAdd(EPPHostAddRemove aAdd)
aAdd
- Object that contains the list of elements to add to the
host.public EPPHostAddRemove getRemove()
null
otherwise.public void setRemove(EPPHostAddRemove aRemove)
aRemove
- Object that contains the list of elements to remove from
the host.public EPPHostAddRemove getChange()
null
otherwise.public void setChange(EPPHostAddRemove newChange)
newChange
- Object that contains the list of elements to change to
the host.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |