Package com.verisign.epp.codec.gen
Class EPPUpdateCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPUpdateCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
- Direct Known Subclasses:
EPPContactUpdateCmd
,EPPDefRegUpdateCmd
,EPPDomainUpdateCmd
,EPPEmailFwdUpdateCmd
,EPPHostUpdateCmd
,EPPNameVerificationUpdateCmd
,EPPNameWatchUpdateCmd
,EPPOrgUpdateCmd
,EPPRegistryUpdateCmd
,EPPRegistryUpdateCmd
public abstract class EPPUpdateCmd extends EPPCommand
The EPP update command is used to change information associated with an existing object. The elements needed to identify and modify an object are object-specific, so the child elements of the update command are specified using the EPP extension framework. In addition to the standard EPP command elements, the <update> command SHALL contain the following child elements: An object-specific "obj:update" element that identifies the object to be renewed and the elements that are required to modify the object. Object-specific elements MUST identify values to be added, values to be removed, or values to be changed.
EPPUpdateCmd
is an abstract EPP command class that represents a update operation. A command mapping update command extendsEPPUpdateCmd
. For example,EPPDomainUpdateCmd
is aEPPUpdateCmd
that implements the Domain Update Command Mapping.- See Also:
- Serialized Form
-
-
Field 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
Constructors Constructor Description EPPUpdateCmd()
Default constructor forEPPUpdateCmd
.EPPUpdateCmd(java.lang.String aTransId)
EPPUpdateCmd
that takes all required attributes as arguments.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract void
doDecode(org.w3c.dom.Element aElement)
Must be defined byEPPUpdateCmd
extensions (Command Mappings) to decode the attributes to a DOM Element tree.protected abstract org.w3c.dom.Element
doEncode(org.w3c.dom.Document aDocument)
Must be defined byEPPUpdateCmd
extensions (Command Mappings) to encode the attributes to a DOM Element tree.protected void
doGenDecode(org.w3c.dom.Element aElement)
Decodes theEPPUpdateCmd
attributes from theaElement
DOM Element tree.protected org.w3c.dom.Element
doGenEncode(org.w3c.dom.Document aDocument)
Encodes a DOM Element tree from the attributes of theEPPUpdateCmd
instance.boolean
equals(java.lang.Object aObject)
Compares an instance ofEPPUpdateCmd
with this instance.java.lang.String
getType()
Gets the EPP command type associated withEPPUpdateCmd
.-
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand
addExtension, clone, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getNamespace, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId, toString
-
-
-
-
Constructor Detail
-
EPPUpdateCmd
public EPPUpdateCmd()
Default constructor forEPPUpdateCmd
.
-
EPPUpdateCmd
public EPPUpdateCmd(java.lang.String aTransId)
EPPUpdateCmd
that takes all required attributes as arguments. This will call the superEPPCommand(String)
method to set the transaction id for the command.- Parameters:
aTransId
- Transaction Id associated with command.
-
-
Method Detail
-
getType
public java.lang.String getType()
Gets the EPP command type associated withEPPUpdateCmd
.- Specified by:
getType
in classEPPCommand
- Returns:
- EPPCommand.TYPE_UPDATE
-
equals
public boolean equals(java.lang.Object aObject)
Compares an instance ofEPPUpdateCmd
with this instance.- Overrides:
equals
in classEPPCommand
- Parameters:
aObject
- Object to compare with.- Returns:
- DOCUMENT ME!
-
doGenEncode
protected org.w3c.dom.Element doGenEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encodes a DOM Element tree from the attributes of theEPPUpdateCmd
instance. This method is a member of the Template Design Pattern.EPPCommand.encode
is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.- Specified by:
doGenEncode
in classEPPCommand
- Parameters:
aDocument
- - DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPUpdateCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPUpdateCmd
instance.
-
doGenDecode
protected void doGenDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decodes theEPPUpdateCmd
attributes from theaElement
DOM Element tree. This method is a member of the Template Design Pattern.EPPCommand.decode
is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.- Specified by:
doGenDecode
in classEPPCommand
- Parameters:
aElement
- - Root DOM Element to decodeEPPUpdateCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
doEncode
protected abstract org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Must be defined byEPPUpdateCmd
extensions (Command Mappings) to encode the attributes to a DOM Element tree.doGenEncode
is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.- Parameters:
aDocument
- - DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the EPPUpdateCmd extension instance.
- Throws:
EPPEncodeException
- Unable to encode EPPUpdateCmd extension instance.
-
doDecode
protected abstract void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Must be defined byEPPUpdateCmd
extensions (Command Mappings) to decode the attributes to a DOM Element tree.doGenDecode
is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.- Parameters:
aElement
- Root DOM Element representing theEPPUpdateCmd
extension instance.- Throws:
EPPDecodeException
- Unable to decodeaElement
.
-
-