Package com.verisign.epp.codec.registry

Class EPPRegistryDeleteCmd

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.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:
    EPPResponse, Serialized Form

    • Constructor Detail

      • EPPRegistryDeleteCmd

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

      • EPPRegistryDeleteCmd

        public EPPRegistryDeleteCmd​(java.lang.String aTransId,
                            java.lang.String 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 Detail

      • getKey

        public java.lang.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 java.lang.String getName()
        Gets the registry name to delete.
        Returns:
        Registry Name String instance if defined; null otherwise.

      • setName

        public void setName​(java.lang.String aName)
        Sets the registry name to delete.
        Parameters:
        aName - Registry Name

      • equals

        public boolean equals​(java.lang.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 java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Clone EPPRegistryDeleteCmd.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class EPPCommand
        Returns:
        clone of EPPRegistryDeleteCmd
        Throws:
        java.lang.CloneNotSupportedException - standard Object.clone exception

      • doEncode

        protected org.w3c.dom.Element doEncode​(org.w3c.dom.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​(org.w3c.dom.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