Package com.verisign.epp.codec.defReg

Class EPPDefRegCheckCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPCheckCmd
com.verisign.epp.codec.defReg.EPPDefRegCheckCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPDefRegCheckCmd extends EPPCheckCmd
Represents an EPP DefReg <check> command, which is used to determine if an object may be provisioned within a repository. It provides a hint that allows a client to anticipate the success or failure of provisioning an object using the <create> command. Object availability and provisioning conditions are a matter of server policy.

In addition to the standard EPP command elements, the <check> command MUST contain a <defReg:check> element that identifies the defReg namespace. The <defReg:check> element contains the following child elements:
  • One or more <defReg:name> elements that contain the fully qualified names of defRegs to be queried.
EPPDefRegCheckResp is the concrete EPPReponse associated with EPPDefRegCheckCmd.
See Also:

  • Field Details

    • MAX_DEFREGS

      public static final int MAX_DEFREGS
      Maximum number of defRegs to check at once.
      See Also:

  • Constructor Details

    • EPPDefRegCheckCmd

      public EPPDefRegCheckCmd()
      EPPDefRegCheckCmd default constructor. It will set the names attribute to an empty Vector.

    • EPPDefRegCheckCmd

      public EPPDefRegCheckCmd(String aTransId, EPPDefRegName aName)
      EPPDefRegCheckCmd constructor that will check an individual defReg name.
      Parameters:
      aTransId - Transaction Id associated with command.
      aName - DefReg name to check

    • EPPDefRegCheckCmd

      public EPPDefRegCheckCmd(String aTransId, Vector someNames)
      EPPDefRegCheckCmd constructor that will check a list of defReg names.
      Parameters:
      aTransId - Transaction Id associated with command.
      someNames - Vector of defReg name String instances.

  • Method Details

    • getNamespace

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

    • getKey

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPDefRegCheckCmd with this instance.
      Overrides:
      equals in class EPPCheckCmd
      Parameters:
      aObject - Object to compare with.
      Returns:
      DOCUMENT ME!

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPDefRegCheckCmd.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPCommand
      Returns:
      Deep copy clone of EPPDefRegCheckCmd
      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.

    • setName

      public void setName(EPPDefRegName aName)
      Sets defReg name to check.
      Parameters:
      aName - Name to check.

    • getNames

      public Vector getNames()
      Gets defReg names to check.
      Returns:
      Vector of defReg name String's.

    • setNames

      public void setNames(Vector someNames)
      Sets defReg names to check.
      Parameters:
      someNames - Names to check.

    • doEncode

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

    • doDecode

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