Package com.verisign.epp.codec.registry

Class EPPRegistryUpdateCmd

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable
    public class EPPRegistryUpdateCmd
extends EPPUpdateCmd
    Represents an EPP Registry <update> command. The EPP <update> command provides a transform operation that allows a client to modify the attributes of a zone object. In addition to the standard EPP command elements, the <update> command MUST contain a <domain:update> element that identifies the domain namespace and the location of the domain schema. In addition to The <registry:update> element SHALL contain the following child elements:

    • A <registry:zone> element that contains the detailed registry information of the object to be updated. Use getZone and setZone to get and set the element.
    EPPRegistryUpdateResp is the concrete EPPReponse associated with EPPRegistryUpdateCmd.

    See Also:
    EPPRegistryUpdateResp, Serialized Form

    • Constructor Detail

      • EPPRegistryUpdateCmd

        public EPPRegistryUpdateCmd()
        Creates an empty EPPRegistryUpdateCmd object. zone is set to null. Use setZone to set zone attribute before sending the update command.

      • EPPRegistryUpdateCmd

        public EPPRegistryUpdateCmd​(java.lang.String aTransId,
                            EPPRegistryZoneInfo zone)
        Creates a new EPPRegistryUpdateCmd object that will update a registry object based on the info in zone.
        Parameters:
        aTransId - Transaction Id associated with command.
        zone - Instance of EPPRegistryZoneInfo to update

    • 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.

      • equals

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

      • toString

        public java.lang.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 org.w3c.dom.Element doEncode​(org.w3c.dom.Document aDocument)
                                throws EPPEncodeException
        Encode a DOM Element tree from the attributes of the EPPRegistryUpdateCmd instance.
        Specified by:
        doEncode in class EPPUpdateCmd
        Parameters:
        aDocument - DOM Document that is being built. Used as an Element factory.
        Returns:
        Root DOM Element representing the EPPRegistryUpdateCmd instance.
        Throws:
        EPPEncodeException - Unable to encode EPPRegistryUpdateCmd instance.

      • doDecode

        protected void doDecode​(org.w3c.dom.Element aElement)
                 throws EPPDecodeException
        Decode the EPPRegistryUpdateCmd attributes from the aElement DOM Element tree.
        Specified by:
        doDecode in class EPPUpdateCmd
        Parameters:
        aElement - Root DOM Element to decode EPPRegistryUpdateCmd from.
        Throws:
        EPPDecodeException - Unable to decode aElement