Package com.verisign.epp.codec.validate.v02

Class EPPValidateCheckCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPCheckCmd
com.verisign.epp.codec.validate.v02.EPPValidateCheckCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPValidateCheckCmd extends EPPCheckCmd
The EPPValidateCheckCmd is used for the Validate Check Command, that is used for the validation of contact and eligibility data.
See Also:

  • Field Details

    • ELM_LOCALNAME

      public static final String ELM_LOCALNAME
      Constant for the name verification check command
      See Also:

  • Constructor Details

    • EPPValidateCheckCmd

      public EPPValidateCheckCmd()
      EPPValidateCheckCmd default constructor.

    • EPPValidateCheckCmd

      public EPPValidateCheckCmd(String aTransId)
      EPPValidateCheckCmd constructor with just the client transaction identifier.
      Parameters:
      aTransId - Transaction Id associated with command.

    • EPPValidateCheckCmd

      public EPPValidateCheckCmd(String aTransId, EPPValidateContact aContact)
      EPPValidateCheckCmd constructor that will check an individual contact.
      Parameters:
      aTransId - Transaction Id associated with command.
      aContact - Contact to validate

    • EPPValidateCheckCmd

      public EPPValidateCheckCmd(String aTransId, List<EPPValidateContact> aContacts)
      EPPValidateCheckCmd constructor that will check a list of contacts.
      Parameters:
      aTransId - Transaction Id associated with command.
      aContacts - List of labels to check

  • Method Details

    • getNamespace

      public String getNamespace()
      Gets the EPP command Namespace associated with EPPValidateCheckCmd .
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Specified by:
      getNamespace in class EPPCommand
      Returns:
      EPPValidateMapFactory.NS

    • getKey

      public String getKey()
      Gets the key for the validate object, which is the contact identifier.
      Overrides:
      getKey in class EPPCommand
      Returns:
      The validate identifier if set with a single value; null otherwise.

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPValidateCheckCmd with this instance.
      Overrides:
      equals in class EPPCheckCmd
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPValidateCheckCmd.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPCommand
      Returns:
      Deep copy clone of EPPValidateCheckCmd
      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 EPPCommand
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • hasContacts

      public boolean hasContacts()
      Is there any contacts set?
      Returns:
      true if there is at least one EPPValidateContact set; false otherwise.

    • setContact

      public void setContact(EPPValidateContact aContact)
      Sets individual contact to validate.
      Parameters:
      aContact - Contact to validate

    • getContacts

      public List<EPPValidateContact> getContacts()
      Gets contacts to validate.
      Returns:
      List of contacts.

    • setLabels

      public void setLabels(List<EPPValidateContact> aContacts)
      Sets contacts to validate.
      Parameters:
      aContacts - Contacts to validate.

    • addContact

      public void addContact(EPPValidateContact aContact)
      Add a contact to the list of contacts to validate.
      Parameters:
      aContact - Contact to add

    • doEncode

      protected Element doEncode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPValidateCheckCmd instance.
      Specified by:
      doEncode in class EPPCheckCmd
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Element Root DOM Element representing the EPPValidateCheckCmd instance.
      Throws:
      EPPEncodeException - Unable to encode EPPValidateCheckCmd instance.

    • doDecode

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPValidateCheckCmd attributes from the aElement DOM Element tree.
      Specified by:
      doDecode in class EPPCheckCmd
      Parameters:
      aElement - Root DOM Element to decode EPPValidateCheckCmd from.
      Throws:
      EPPDecodeException - Unable to decode aElement