Package com.verisign.epp.codec.registry.v02

Class EPPRegistryCheckCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPCheckCmd
com.verisign.epp.codec.registry.v02.EPPRegistryCheckCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPRegistryCheckCmd extends EPPCheckCmd
Represents an EPP Registry <check> command, which is used to determine if a zone name is known to the server. The <registry:check> element MUST contain the following child elements:

  • One or more <registry:name> elements that contain the fully qualified name of the queried zones. Use getNames and setNames to get and set the elements. Use addName to add a name to existing list or use setName to set an individual name.

EPPRegistryCheckResp is the concrete EPPReponse associated with EPPRegistryCheckCmd.

See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryCheckCmd

      public EPPRegistryCheckCmd()
      EPPRegistryCheckCmd default constructor. It will set the names attribute to an empty List.

    • EPPRegistryCheckCmd

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

    • EPPRegistryCheckCmd

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

    • EPPRegistryCheckCmd

      public EPPRegistryCheckCmd(String aTransId, List<EPPRegistryZoneName> aNames)
      EPPRegistryCheckCmd constructor that will check a list of zone names.
      Parameters:
      aTransId - Transaction Id associated with command.
      aNames - List of zone name String instances.

  • Method Details

    • getNamespace

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

    • getKey

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

    • equals

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

    • doEncode

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

    • doDecode

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

    • getNames

      public List<EPPRegistryZoneName> getNames()
      Get zone names to check.
      Returns:
      List of zone name EPPRegistryZoneName's

    • setNames

      public void setNames(List<EPPRegistryZoneName> aNames)
      Set zone names to check.
      Parameters:
      aNames - List of zone name EPPRegistryZoneName's

    • setName

      public void setName(String aName)
      Set an individual aLabel zone name to check. This method clears existing zone name List.
      Parameters:
      aName - aLabel zone name to check

    • setName

      public void setName(EPPRegistryZoneName aName)
      Set an individual zone name to check. This method clears existing zone name List.
      Parameters:
      aName - zone name to check

    • addName

      public void addName(String aName)
      Append an aLabel zone name to the name List to check. This method does NOT clear existing zone name List.
      Parameters:
      aName - aLabel zone name to append

    • addName

      public void addName(EPPRegistryZoneName aName)
      Append an zone name to the name List to check. This method does NOT clear existing zone name List.
      Parameters:
      aName - Zone name to append