Package com.verisign.epp.codec.nv

Class EPPDomainNameVerification

java.lang.Object
com.verisign.epp.codec.nv.EPPDomainNameVerification
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPDomainNameVerification extends Object implements EPPCodecComponent
Represents a Domain Name Verification (DNV) used in EPPNameVerificationCreateCmd and the EPPNameVerificationInfoResp.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    XML local name for EPPDomainNameVerification.
    static final String
    ELM_NAME
    XML root tag for EPPDomainNameVerification.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPDomainNameVerification()
    EPPDomainNameVerification default constructor.
    EPPDomainNameVerification(String aName)
    EPPDomainNameVerification constructor that takes the required domain label.
    EPPDomainNameVerification(String aName, 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

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPDomainNameVerification.
    void
    decode(Element aElement)
    Decode the EPPDomainNameVerification attributes from the aElement DOM Element tree.
    Element
    encode(Document aDocument)
    Encode a DOM Element tree from the attributes of the EPPDomainNameVerification instance.
    boolean
    equals(Object aObject)
    Compare an instance of EPPDomainNameVerification with this instance.
    String
    getName()
    Gets the domain label for verification
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getRnvCode()
    Gets the Real Name Verification Code Token value.
    boolean
    hasRnvCode()
    Has the Real Name Verification Code Token value been set?
    void
    setName(String aName)
    Sets the domain label for verification.
    void
    setRnvCode(String aRnvCode)
    Sets the Real Name Verification Code Token value.
    String
    toString()
    Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

    Methods inherited from class java.lang.Object

    finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • EPPDomainNameVerification

      public EPPDomainNameVerification()
      EPPDomainNameVerification default constructor.

    • EPPDomainNameVerification

      public EPPDomainNameVerification(String aName)
      EPPDomainNameVerification constructor that takes the required domain label.
      Parameters:
      aName - Domain label to verify

    • EPPDomainNameVerification

      public EPPDomainNameVerification(String aName, 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 verify
      aRnvCode - OPTIONAL Real Name Verification Code Token value. Set to null if undefined.

  • Method Details

    • getName

      public String getName()
      Gets the domain label for verification
      Returns:
      The domain label for verification

    • setName

      public void setName(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 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(String aRnvCode)
      Sets the Real Name Verification Code Token value.
      Parameters:
      aRnvCode - Real Name Verification Code Token value. Set to null if undefined.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPDomainNameVerification instance.
      Specified by:
      encode in interface EPPCodecComponent
      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 encode EPPDomainNameVerification instance.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPDomainNameVerification attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Root DOM Element to decode EPPDomainNameVerification from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPDomainNameVerification with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if this object is the same as the aObject argument; false otherwise.

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPDomainNameVerification.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      Deep copy clone of EPPDomainNameVerification
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • toString

      public String toString()
      Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
      Overrides:
      toString in class Object
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      XML namespace for the EPPCodecComponent.