Package com.verisign.epp.codec.domain
Class EPPDomainTransferCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPTransferCmd
-
- com.verisign.epp.codec.domain.EPPDomainTransferCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPDomainTransferCmd extends EPPTransferCmd
Represents an EPP Domain <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 <domain:transfer> element that identifies the domain namespace and the location of the domain schema. The <domain:transfer> element SHALL contain the following child elements:
- A <domain:name> element that contains the fully qualified domain
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 <domain:period> element that contains the initial
registration period of the domain 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 <domain:authInfo> element that contains authorization information
associated with the domain object or authorization information associated
with the domain 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 domain object MUST implicitly transfer all host objects that are subordinate to the domain object. For example, if domain 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 domain object are listed in the response to an EPP <info> command performed on the domain object.
EPPDomainTransferResp
is the concreteEPPReponse
associated withEPPDomainTransferCmd
.- See Also:
EPPDomainTransferResp
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPDomainTransferCmd
.static java.lang.String
ELM_NAME
XML Element Name ofEPPDomainTransferCmd
root element.-
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 EPPDomainTransferCmd()
Allocates a newEPPDomainTransferCmd
with default attribute values.EPPDomainTransferCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aName)
EPPDomainTransferCmd
constructor that takes the required attributes as arguments.EPPDomainTransferCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aName, EPPAuthInfo aAuthInfo, EPPDomainPeriod aPeriod)
EPPDomainTransferCmd
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()
CloneEPPDomainTransferCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPDomainTransferCmd
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 theEPPDomainTransferCmd
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPDomainTransferCmd
with this instance.EPPAuthInfo
getAuthInfo()
Get authorization Information.java.lang.String
getName()
Gets the domain name to query.java.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPDomainTransferCmd
.EPPDomainPeriod
getPeriod()
Gets the registration period of the transfer command in years.void
setAuthInfo(EPPAuthInfo newAuthInfo)
Set authorization information.void
setName(java.lang.String aName)
Sets the domain name to query.void
setPeriod(EPPDomainPeriod aPeriod)
Sets the registration period of the transfer command.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
-
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPDomainTransferCmd
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML Element Name ofEPPDomainTransferCmd
root element.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPDomainTransferCmd
public EPPDomainTransferCmd()
Allocates a newEPPDomainTransferCmd
with default attribute values. the defaults include the following:
- name is set to
null
- period is set to
null
- authInfo is set to to
null
The transaction ID, operation, name, and authInfo must be set before invokingencode
. - name is set to
-
EPPDomainTransferCmd
public EPPDomainTransferCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aName)
EPPDomainTransferCmd
constructor that takes the required attributes as arguments. The period attribute is set toUNSPEC_PERIOD
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.aName
- Domain name to create.
-
EPPDomainTransferCmd
public EPPDomainTransferCmd(java.lang.String aTransId, java.lang.String aOp, java.lang.String aName, EPPAuthInfo aAuthInfo, EPPDomainPeriod aPeriod)
EPPDomainTransferCmd
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.aName
- Domain name to create.aAuthInfo
- Authorization Information for operating with the domain.aPeriod
- Registration period to be added to the domain upon transfer.
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPDomainTransferCmd
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
EPPDomainMapFactory.NS
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPDomainTransferCmd
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
EPPDomainTransferCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPDomainTransferCmd
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPDomainTransferCmd
attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPTransferCmd
- Parameters:
aElement
- Root DOM Element to decodeEPPDomainTransferCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
getName
public java.lang.String getName()
Gets the domain name to query.- Returns:
- Domain Name if defined;
null
otherwise.
-
setName
public void setName(java.lang.String aName)
Sets the domain name to query.- Parameters:
aName
- Domain Name
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPDomainTransferCmd
with this instance.- Overrides:
equals
in classEPPTransferCmd
- Parameters:
aObject
- Object to compare with.- Returns:
true
when equal;false
otherwise.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPDomainTransferCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPTransferCmd
- Returns:
- clone of
EPPDomainTransferCmd
- 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:
- com.verisign.epp.codec.domain.EPPAuthInfo
-
getPeriod
public EPPDomainPeriod 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
- com.verisign.epp.codec.domain.EPPAuthInfo
-
setPeriod
public void setPeriod(EPPDomainPeriod aPeriod)
Sets the registration period of the transfer command.- Parameters:
aPeriod
- Registration Period.
-
-