Package com.verisign.epp.codec.nv

Class EPPRealNameVerification

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

  • Field Details

  • Constructor Details

    • EPPRealNameVerification

      public EPPRealNameVerification()
      EPPRealNameVerification default constructor.

    • EPPRealNameVerification

      public EPPRealNameVerification(EPPRealNameVerification.Role aRole, String aName, String aNum, EPPRealNameVerification.ProofType aProofType)
      EPPRealNameVerification constructor the required attributes.
      Parameters:
      aRole - Contact role.
      aName - Real name to verify
      aNum - Citizen or organization ID of the contact.
      aProofType - Proof type

    • EPPRealNameVerification

      public EPPRealNameVerification(EPPRealNameVerification.Role aRole, String aName, String aNum, EPPRealNameVerification.ProofType aProofType, EPPNameVerificationDocument aDocument)
      EPPRealNameVerification constructor that takes all attributes with a single document. * @param aType Contact type with default of TYPE_REGISTRANT.
      Parameters:
      aRole - Role of the contact
      aName - Full name of the contact
      aNum - Citizen or the organization ID of the contact.
      aProofType - Proof material type of the contact.
      aDocument - Single proof document

    • EPPRealNameVerification

      public EPPRealNameVerification(EPPRealNameVerification.Role aRole, String aName, String aNum, EPPRealNameVerification.ProofType aProofType, List<EPPNameVerificationDocument> aDocuments)
      EPPRealNameVerification constructor that takes all attributes. * @param aType Contact type with default of TYPE_REGISTRANT.
      Parameters:
      aRole - Role of the contact
      aName - Full name of the contact
      aNum - Citizen or the organization ID of the contact.
      aProofType - Proof material type of the contact.
      aDocuments - List of proof documents

  • Method Details

    • getRole

      public EPPRealNameVerification.Role getRole()
      Gets the contact role.
      Returns:
      Contact role

    • setRole

      public void setRole(EPPRealNameVerification.Role aRole)
      Sets the contact role.
      Parameters:
      aRole - Contact role

    • getNum

      public String getNum()
      Gets the citizen or the organization ID of the contact.
      Returns:
      The citizen or the organization ID of the contact.

    • setNum

      public void setNum(String aNum)
      Sets the citizen or the organization ID of the contact.
      Parameters:
      aNum - Citizen or the organization ID of the contact.

    • getName

      public String getName()
      Gets the full name of the contact
      Returns:
      Full name of the contact

    • setName

      public void setName(String aName)
      Sets the full name of the contact.
      Parameters:
      aName - Full name of the contact

    • getProofType

      public EPPRealNameVerification.ProofType getProofType()
      Gets the proof material type of the contact.
      Returns:
      proof material type of the contact

    • setProofType

      public void setProofType(EPPRealNameVerification.ProofType aProofType)
      Sets the proof material type of the contact.
      Parameters:
      aProofType - proof material type of the contact

    • hasDocuments

      public boolean hasDocuments()
      Are there any verification documents?
      Returns:
      true if there are documents; false otherwise.

    • getDocuments

      public List<EPPNameVerificationDocument> getDocuments()
      Gets the verification documents.
      Returns:
      Verification documents

    • setDocuments

      public void setDocuments(List<EPPNameVerificationDocument> aDocuments)
      Sets the verification documents.
      Parameters:
      aDocuments - Verification documents

    • addDocument

      public void addDocument(EPPNameVerificationDocument aDocument)
      Adds a document to the list of verification documents.
      Parameters:
      aDocument - Document to add to the list of verification documents.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPRealNameVerification 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 EPPRealNameVerification instance.
      Throws:
      EPPEncodeException - Unable to encode EPPRealNameVerification instance.

    • decode

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPRealNameVerification 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 EPPRealNameVerification.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      Deep copy clone of EPPRealNameVerification
      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.