Package com.verisign.epp.codec.nv

Class EPPNameVerificationCheckCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPCheckCmd
com.verisign.epp.codec.nv.EPPNameVerificationCheckCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPNameVerificationCheckCmd extends EPPCheckCmd
The EPPNameVerificationCheckCmd is used for the Name Verification (DNV) Check Command, that is used to determine if the domain label's can be used to create a Domain Name Verification object. It provides a hint that allows a client to anticipate the success or failure of create a DNV object using the create command.
See Also:

  • Field Details

    • MAX_LABELS

      public static final int MAX_LABELS
      Maximum number of labels to check at once.
      See Also:

    • ELM_LOCALNAME

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

  • Constructor Details

    • EPPNameVerificationCheckCmd

      public EPPNameVerificationCheckCmd()
      EPPNameVerificationCheckCmd default constructor.

    • EPPNameVerificationCheckCmd

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

    • EPPNameVerificationCheckCmd

      public EPPNameVerificationCheckCmd(String aTransId, String aName)
      EPPNameVerificationCheckCmd constructor that will check an individual label.
      Parameters:
      aTransId - Transaction Id associated with command.
      aName - Label name to check

    • EPPNameVerificationCheckCmd

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

  • Method Details

    • getNamespace

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

    • equals

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

    • setLabel

      public void setLabel(String aName)
      Sets label to check.
      Parameters:
      aName - Label to check.

    • getLabels

      public List<String> getLabels()
      Gets labels to check.
      Returns:
      List of labels String's.

    • setLabels

      public void setLabels(List<String> aLabels)
      Sets labels to check.
      Parameters:
      aLabels - Labels to check.

    • addLabel

      public void addLabel(String aLabel)
      Add a label to the list of labels.
      Parameters:
      aLabel - Label to add

    • doEncode

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

    • doDecode

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