Package com.verisign.epp.codec.nameWatch
Class EPPNameWatchTransferCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPTransferCmd
-
- com.verisign.epp.codec.nameWatch.EPPNameWatchTransferCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPNameWatchTransferCmd extends EPPTransferCmd
Represents an EPP NameWatch <transfer> command. The EPP <transfer> command provides a query operation that allows a client to determine real-time status of pending and completed transfer requests. In addition to the standard EPP command elements, the <transfer> command MUST contain anop
attribute with valuequery
, and a <nameWatch:transfer> element that identifies the nameWatch namespace and the location of the nameWatch schema. The <nameWatch:transfer> element SHALL contain the following child elements:
-
A <nameWatch:name> element that contains the fully qualified nameWatch
name of the object for which a transfer request is to be created, approved,
rejected, or cancelled. Use
getName
andsetName
to get and set the element. -
An OPTIONAL <nameWatch:period> element that contains the initial
registration period of the nameWatch object. Use
getPeriod
andsetPeriod
to get and set the element. If returnnull
, period has not been specified yet. -
An "op" attribute that identifies the transfer operation to be performed.
Valid values, definitions, and authorizations for all attribute values are
defined in [EPP]. Use
getOp
andsetOp
to get and set the element. One of theEPPCommand.OP_
constants need to be specified. -
A <nameWatch:authInfo> element that contains authorization information
associated with the nameWatch object or authorization information
associated with the nameWatch object's registrant or associated contacts.
This element is REQUIRED only when a transfer is requested, and it SHALL be
ignored if used otherwise. Use
getAuthInfo
andsetAuthInfo
to get and set the element.
Transfer of a nameWatch object MUST implicitly transfer all host objects that are subordinate to the nameWatch object. For example, if nameWatch object "example.com" is transferred and host object "ns1.example.com" exists, the host object MUST be transferred as part of the "example.com" transfer process. Host objects that are subject to transfer when transferring a nameWatch object are listed in the response to an EPP <info> command performed on the nameWatch object.
EPPNameWatchTransferResp
is the concreteEPPReponse
associated withEPPNameWatchTransferCmd
.- See Also:
EPPNameWatchTransferResp
, Serialized Form
-
-
Field Summary
-
Fields inherited from class com.verisign.epp.codec.gen.EPPTransferCmd
op
-
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 EPPNameWatchTransferCmd()
Allocates a newEPPNameWatchTransferCmd
with default attribute values.EPPNameWatchTransferCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aRoid)
EPPNameWatchTransferCmd
constructor that takes the required attributes as arguments.EPPNameWatchTransferCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aRoid, EPPAuthInfo aAuthInfo)
EPPNameWatchTransferCmd
constructor that takes the required attributes as arguments.EPPNameWatchTransferCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aRoid, EPPAuthInfo aAuthInfo, EPPNameWatchPeriod aPeriod)
EPPNameWatchTransferCmd
constructor that takes the required attributes plus the optional attibuteaPeriod
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPNameWatchTransferCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPNameWatchTransferCmd
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 theEPPNameWatchTransferCmd
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPNameWatchTransferCmd
with this instance.EPPAuthInfo
getAuthInfo()
Get authorization Information.java.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPNameWatchTransferCmd
.EPPNameWatchPeriod
getPeriod()
Gets the registration period of the transfer command in years.java.lang.String
getRoid()
Gets the nameWatch roid to query.void
setAuthInfo(EPPAuthInfo newAuthInfo)
Set authorization information.void
setPeriod(EPPNameWatchPeriod aPeriod)
Sets the registration period of the transfer command.void
setRoid(java.lang.String aRoid)
Sets the nameWatch roid to query.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.-
Methods inherited from class com.verisign.epp.codec.gen.EPPTransferCmd
doGenDecode, doGenEncode, getOp, getType, setOp
-
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand
addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId
-
-
-
-
Constructor Detail
-
EPPNameWatchTransferCmd
public EPPNameWatchTransferCmd()
Allocates a newEPPNameWatchTransferCmd
with default attribute values. the defaults include the following:
-
roid is set to
null
-
period is set to
null
-
authInfo is set to to
null
The transaction ID, operation, and roid must be set before invokingencode
. -
roid is set to
-
EPPNameWatchTransferCmd
public EPPNameWatchTransferCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aRoid)
EPPNameWatchTransferCmd
constructor that takes the required attributes as arguments. The period attribute is set to "0" and will not be included whenencode
is invoked.- Parameters:
aTransId
- Transaction Id associated with the command.aOp
- One of theEPPCommand.OP_
constants associated with the transfer command.aRoid
- NameWatch roid to create.
-
EPPNameWatchTransferCmd
public EPPNameWatchTransferCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aRoid, EPPAuthInfo aAuthInfo)
EPPNameWatchTransferCmd
constructor that takes the required attributes as arguments. The period attribute is set to "0" and will not be included whenencode
is invoked.- Parameters:
aTransId
- Transaction Id associated with the command.aOp
- One of theEPPCommand.OP_
constants associated with the transfer command.aRoid
- NameWatch roid to create.aAuthInfo
- Authorization Information for operating with the nameWatch.
-
EPPNameWatchTransferCmd
public EPPNameWatchTransferCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aRoid, EPPAuthInfo aAuthInfo, EPPNameWatchPeriod aPeriod)
EPPNameWatchTransferCmd
constructor that takes the required attributes plus the optional attibuteaPeriod
.- Parameters:
aTransId
- Transaction Id associated with the command.aOp
- One of theEPPCommand.OP_
constants associated with the transfer command.aRoid
- NameWatch roid to create.aAuthInfo
- Authorization Information for operating with the nameWatch.aPeriod
- Registration period to be added to the nameWatch upon transfer.
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPNameWatchTransferCmd
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
EPPNameWatchMapFactory.NS
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPNameWatchTransferCmd
instance.- Specified by:
doEncode
in classEPPTransferCmd
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPNameWatchTransferCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPNameWatchTransferCmd
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPNameWatchTransferCmd
attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPTransferCmd
- Parameters:
aElement
- Root DOM Element to decodeEPPNameWatchTransferCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
getRoid
public java.lang.String getRoid()
Gets the nameWatch roid to query.- Returns:
- NameWatch Roid
-
setRoid
public void setRoid(java.lang.String aRoid)
Sets the nameWatch roid to query.- Parameters:
aRoid
- NameWatch Roid
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPNameWatchTransferCmd
with this instance.- Overrides:
equals
in classEPPTransferCmd
- Parameters:
aObject
- Object to compare with.- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPNameWatchTransferCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPTransferCmd
- Returns:
- clone of
EPPNameWatchTransferCmd
- 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 classEPPCommand
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getAuthInfo
public EPPAuthInfo getAuthInfo()
Get authorization Information.- Returns:
- EPPAuthInfo if defined;
null
otherwise.
-
getPeriod
public EPPNameWatchPeriod getPeriod()
Gets the registration period of the transfer command in years.- Returns:
- Registration Period in years if defined;
null
otherwise.
-
setAuthInfo
public void setAuthInfo(EPPAuthInfo newAuthInfo)
Set authorization information.- Parameters:
newAuthInfo
- EPPAuthInfo
-
setPeriod
public void setPeriod(EPPNameWatchPeriod aPeriod)
Sets the registration period of the transfer command.- Parameters:
aPeriod
- Registration Period.
-
-