Package com.verisign.epp.codec.gen
Class EPPTransferCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPTransferCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
- Direct Known Subclasses:
EPPContactTransferCmd
,EPPDefRegTransferCmd
,EPPDomainTransferCmd
,EPPEmailFwdTransferCmd
,EPPNameWatchTransferCmd
public abstract class EPPTransferCmd extends EPPCommand
The EPP <transfer> command provides a query operation that allows a client to determine real-time status of pending and completed transfer requests. The elements needed to identify an object that is the subject of a transfer request are object-specific, so the child elements of the <transfer> query command are specified using the EPP extension framework. In addition to the standard EPP command elements, the <transfer> command SHALL contain anop
attribute with valuequery
, and the following child elements: An object-specific <obj:transfer> element that identifies the object whose transfer status is requested.
EPPTransferCmd
is an abstract EPP command class that represents a transfer operation. A command mapping transfer command extendsEPPTransferCmd
. For example,EPPDomainTransferCmd
is aEPPTransferCmd
that implements the Domain Transfer Command Mapping. The different types of transfer operations can be one of theEPPCommand.OP_
constants.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
op
Operation "op" associated with theEPPTransferCmd
.-
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 EPPTransferCmd()
Default constructor.EPPTransferCmd(java.lang.String aTransId, java.lang.String aOp)
EPPTransferCmd
that takes all required attributes as arguments.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPTransferCmd
.protected abstract void
doDecode(org.w3c.dom.Element aElement)
Must be defined byEPPTransferCmd
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 byEPPTransferCmd
extensions (Command Mappings) to encode the attributes to a DOM Element tree.protected void
doGenDecode(org.w3c.dom.Element aElement)
Decodes theEPPTransferCmd
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 theEPPTransferCmd
instance.boolean
equals(java.lang.Object aObject)
Compares an instance of EPPTransferCmd with this instance.java.lang.String
getOp()
Gets the EPP command operation attribute associated withEPPTransferCmd
.java.lang.String
getType()
Gets the EPP command type associated with EPPTransferCmd.void
setOp(java.lang.String aOp)
Sets the EPP command operation attribute associated withEPPTransferCmd
.-
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand
addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getNamespace, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId, toString
-
-
-
-
Constructor Detail
-
EPPTransferCmd
public EPPTransferCmd()
Default constructor. Will set Authorization Id to null.
-
EPPTransferCmd
public EPPTransferCmd(java.lang.String aTransId, java.lang.String aOp)
EPPTransferCmd
that takes all required attributes as arguments.- Parameters:
aTransId
- Transaction Id associated with command.aOp
- One of theEPPCommand.OP_
constants associated with the transfer command.
-
-
Method Detail
-
getType
public java.lang.String getType()
Gets the EPP command type associated with EPPTransferCmd.- Specified by:
getType
in classEPPCommand
- Returns:
EPPCommand.TYPE_TRANSFER
-
getOp
public java.lang.String getOp()
Gets the EPP command operation attribute associated withEPPTransferCmd
.- Overrides:
getOp
in classEPPCommand
- Returns:
- One of the
EPPCommand.OP_
constants associated with the transfer command.
-
setOp
public void setOp(java.lang.String aOp)
Sets the EPP command operation attribute associated withEPPTransferCmd
.- Parameters:
aOp
- One of theEPPCommand.OP_
constants associated with the transfer command.
-
equals
public boolean equals(java.lang.Object aObject)
Compares an instance of EPPTransferCmd with this instance.- Overrides:
equals
in classEPPCommand
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
otherwise
-
doGenEncode
protected org.w3c.dom.Element doGenEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encodes a DOM Element tree from the attributes of theEPPTransferCmd
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
EPPTransferCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPTransferCmd
instance.
-
doGenDecode
protected void doGenDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decodes theEPPTransferCmd
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 decodeEPPTransferCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPTransferCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- clone of
EPPTransferCmd
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
doEncode
protected abstract org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Must be defined byEPPTransferCmd
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 EPPTransferCmd extension instance.
- Throws:
EPPEncodeException
- Unable to encode EPPTransferCmd extension instance.
-
doDecode
protected abstract void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Must be defined byEPPTransferCmd
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 theEPPTransferCmd
extension instance.- Throws:
EPPDecodeException
- Unable to decodeaElement
.
-
-