Class EPPAllocationToken
- java.lang.Object
-
- com.verisign.epp.codec.allocationtoken.EPPAllocationToken
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPAllocationToken extends java.lang.Object implements EPPCodecComponent
Allocation Token Extension, defines an allocation token or code for allocating an object like a domain name to the client. The allocation token MAY be transferred out-of-band to a client to give them authorization to allocate an object using one of the EPP transform commands including create, update, and transfer.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPAllocationToken
.static java.lang.String
ELM_NAME
XML root tag forEPPAllocationToken
.
-
Constructor Summary
Constructors Constructor Description EPPAllocationToken()
O Default constructor forEPPAllocationToken
.EPPAllocationToken(java.lang.String aToken)
Constructor forEPPAllocationToken
that takes the token.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
clone anEPPCodecComponent
.void
decode(org.w3c.dom.Element aElement)
decode a DOM element tree to initialize the instance attributes.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
encode instance into a DOM element tree.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPAllocationToken
with this instance.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.lang.String
getToken()
Gets the allocation token value.boolean
hasToken()
Is the token defined?void
setToken(java.lang.String aToken)
Sets the allocation token value.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPAllocationToken
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPAllocationToken
.- See Also:
- Constant Field Values
-
-
Method Detail
-
hasToken
public boolean hasToken()
Is the token defined?- Returns:
true
if the token is defined;false
otherwise.
-
getToken
public java.lang.String getToken()
Gets the allocation token value.- Returns:
- Allocation token value if defined;
null
otherwise.
-
setToken
public void setToken(java.lang.String aToken)
Sets the allocation token value.- Parameters:
aToken
- Allocation token
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document, which acts is an Element factory- Returns:
- Element Root element associated with the object
- Throws:
EPPEncodeException
- Error encodingEPPAllocationToken
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decode a DOM element tree to initialize the instance attributes. TheaElement
argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
-Element
to decode- Throws:
EPPDecodeException
- Error decodingElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone anEPPCodecComponent
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of concrete
EPPAllocationToken
- 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 classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPAllocationToken
with this instance.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
otherwise.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-