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

Class EPPRegistryDeleteCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPDeleteCmd
com.verisign.epp.codec.registry.v02.EPPRegistryDeleteCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPRegistryDeleteCmd extends EPPDeleteCmd
Represents an EPP Registry <delete> command that allows a client to delete a registry object. The EPP <delete> command provides a transform operation that allows a client to delete a registry object. In addition to the standard EPP command elements, the <delete> command MUST contain a "registry:delete" element that identifies the registry namespace and the location of the registry schema.

  • A <registry:name> element that contains the fully qualified registry name of the object to be deleted. Use getName and setName to get and set the element.

EPPReponse is the response associated with EPPRegistryDeleteCmd.

See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryDeleteCmd

      public EPPRegistryDeleteCmd()
      EPPRegistryDeleteCmd default constructor. The name is initialized name to null. The name must be set before invoking #encode(Document).

    • EPPRegistryDeleteCmd

      public EPPRegistryDeleteCmd(String aTransId, String aName)
      EPPRegistryDeleteCmd constructor that takes the registry aLabel name as an argument.
      Parameters:
      aTransId - transaction Id associated with command.
      aName - fully qualified aLabel name of zone object to delete.

    • EPPRegistryDeleteCmd

      public EPPRegistryDeleteCmd(String aTransId, EPPRegistryZoneName aName)
      EPPRegistryDeleteCmd constructor that takes the registry name as an argument.
      Parameters:
      aTransId - transaction Id associated with command.
      aName - fully qualified name of zone object to delete.

  • Method Details

    • getNamespace

      public String getNamespace()
      Gets the EPP command Namespace associated with EPPRegistryDeleteCmd.
      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 registry zone name.
      Overrides:
      getKey in class EPPCommand
      Returns:
      The zone name if set; null otherwise.

    • getName

      public EPPRegistryZoneName getName()
      Gets the zone name.
      Returns:
      Zone name if set; null otherwise.

    • setName

      public void setName(EPPRegistryZoneName aName)
      Sets the zone name
      Parameters:
      aName - Zone name

    • setName

      public void setName(String aName)
      Sets the aLabel zone name
      Parameters:
      aName - aLabel zone name

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPRegistryDeleteCmd with this instance.
      Overrides:
      equals in class EPPDeleteCmd
      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 EPPRegistryDeleteCmd.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPCommand
      Returns:
      clone of EPPRegistryDeleteCmd
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • doEncode

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

    • doDecode

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