Package com.verisign.epp.codec.nv
Class EPPDomainNameVerification
- java.lang.Object
-
- com.verisign.epp.codec.nv.EPPDomainNameVerification
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPDomainNameVerification extends java.lang.Object implements EPPCodecComponent
Represents a Domain Name Verification (DNV) used inEPPNameVerificationCreateCmd
and theEPPNameVerificationInfoResp
.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPDomainNameVerification
.static java.lang.String
ELM_NAME
XML root tag forEPPDomainNameVerification
.
-
Constructor Summary
Constructors Constructor Description EPPDomainNameVerification()
EPPDomainNameVerification
default constructor.EPPDomainNameVerification(java.lang.String aName)
EPPDomainNameVerification
constructor that takes the required domain label.EPPDomainNameVerification(java.lang.String aName, java.lang.String aRnvCode)
EPPDomainNameVerification
constructor that takes the required domain label and the optional Real Name Verification Code Token value for verification of a Restricted Name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPDomainNameVerification
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPDomainNameVerification
attributes from the aElement DOM Element tree.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of theEPPDomainNameVerification
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPDomainNameVerification
with this instance.java.lang.String
getName()
Gets the domain label for verificationjava.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.lang.String
getRnvCode()
Gets the Real Name Verification Code Token value.boolean
hasRnvCode()
Has the Real Name Verification Code Token value been set?void
setName(java.lang.String aName)
Sets the domain label for verification.void
setRnvCode(java.lang.String aRnvCode)
Sets the Real Name Verification Code 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 forEPPDomainNameVerification
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPDomainNameVerification
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPDomainNameVerification
public EPPDomainNameVerification()
EPPDomainNameVerification
default constructor.
-
EPPDomainNameVerification
public EPPDomainNameVerification(java.lang.String aName)
EPPDomainNameVerification
constructor that takes the required domain label.- Parameters:
aName
- Domain label to verify
-
EPPDomainNameVerification
public EPPDomainNameVerification(java.lang.String aName, java.lang.String aRnvCode)
EPPDomainNameVerification
constructor that takes the required domain label and the optional Real Name Verification Code Token value for verification of a Restricted Name.- Parameters:
aName
- Domain label to verifyaRnvCode
- OPTIONAL Real Name Verification Code Token value. Set tonull
if undefined.
-
-
Method Detail
-
getName
public java.lang.String getName()
Gets the domain label for verification- Returns:
- The domain label for verification
-
setName
public void setName(java.lang.String aName)
Sets the domain label for verification.- Parameters:
aName
- Domain label for verification
-
hasRnvCode
public boolean hasRnvCode()
Has the Real Name Verification Code Token value been set?- Returns:
true
if the code has been set;false
otherwise.
-
getRnvCode
public java.lang.String getRnvCode()
Gets the Real Name Verification Code Token value.- Returns:
- Real Name Verification Code Token value if defined;
null
otherwise.
-
setRnvCode
public void setRnvCode(java.lang.String aRnvCode)
Sets the Real Name Verification Code Token value.- Parameters:
aRnvCode
- Real Name Verification Code Token value. Set tonull
if undefined.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPDomainNameVerification
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPDomainNameVerification
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPDomainNameVerification
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPDomainNameVerification
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPDomainNameVerification
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPDomainNameVerification
with this instance.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
- Object to compare with.- Returns:
true
if this object is the same as the aObject argument;false
otherwise.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPDomainNameVerification
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- Deep copy clone of
EPPDomainNameVerification
- 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.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-