Package com.verisign.epp.codec.gen

Class EPPUpdateCmd

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable
    Direct Known Subclasses:
    EPPContactUpdateCmd, EPPDefRegUpdateCmd, EPPDomainUpdateCmd, EPPEmailFwdUpdateCmd, EPPHostUpdateCmd, EPPNameVerificationUpdateCmd, EPPNameWatchUpdateCmd, EPPOrgUpdateCmd, EPPRegistryUpdateCmd, EPPRegistryUpdateCmd
    public abstract class EPPUpdateCmd
extends EPPCommand
    The EPP update command is used to change information associated with an existing object. The elements needed to identify and modify an object are object-specific, so the child elements of the update command are specified using the EPP extension framework. In addition to the standard EPP command elements, the <update> command SHALL contain the following child elements: An object-specific "obj:update" element that identifies the object to be renewed and the elements that are required to modify the object. Object-specific elements MUST identify values to be added, values to be removed, or values to be changed.

    EPPUpdateCmd is an abstract EPP command class that represents a update operation. A command mapping update command extends EPPUpdateCmd. For example, EPPDomainUpdateCmd is a EPPUpdateCmd that implements the Domain Update Command Mapping.
    See Also:
    Serialized Form

    • Constructor Detail

      • EPPUpdateCmd

        public EPPUpdateCmd()
        Default constructor for EPPUpdateCmd.

      • EPPUpdateCmd

        public EPPUpdateCmd​(java.lang.String aTransId)
        EPPUpdateCmd that takes all required attributes as arguments. This will call the super EPPCommand(String) method to set the transaction id for the command.
        Parameters:
        aTransId - Transaction Id associated with command.

    • Method Detail

      • getType

        public java.lang.String getType()
        Gets the EPP command type associated with EPPUpdateCmd.
        Specified by:
        getType in class EPPCommand
        Returns:
        EPPCommand.TYPE_UPDATE

      • equals

        public boolean equals​(java.lang.Object aObject)
        Compares an instance of EPPUpdateCmd with this instance.
        Overrides:
        equals in class EPPCommand
        Parameters:
        aObject - Object to compare with.
        Returns:
        DOCUMENT ME!

      • doGenEncode

        protected org.w3c.dom.Element doGenEncode​(org.w3c.dom.Document aDocument)
                                   throws EPPEncodeException
        Encodes a DOM Element tree from the attributes of the EPPUpdateCmd instance. This method is a member of the Template Design Pattern. EPPCommand.encode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
        Specified by:
        doGenEncode in class EPPCommand
        Parameters:
        aDocument - - DOM Document that is being built. Used as an Element factory.
        Returns:
        Root DOM Element representing the EPPUpdateCmd instance.
        Throws:
        EPPEncodeException - Unable to encode EPPUpdateCmd instance.

      • doGenDecode

        protected void doGenDecode​(org.w3c.dom.Element aElement)
                    throws EPPDecodeException
        Decodes the EPPUpdateCmd attributes from the aElement DOM Element tree. This method is a member of the Template Design Pattern. EPPCommand.decode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
        Specified by:
        doGenDecode in class EPPCommand
        Parameters:
        aElement - - Root DOM Element to decode EPPUpdateCmd from.
        Throws:
        EPPDecodeException - Unable to decode aElement

      • doEncode

        protected abstract org.w3c.dom.Element doEncode​(org.w3c.dom.Document aDocument)
                                         throws EPPEncodeException
        Must be defined by EPPUpdateCmd extensions (Command Mappings) to encode the attributes to a DOM Element tree. doGenEncode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
        Parameters:
        aDocument - - DOM Document that is being built. Used as an Element factory.
        Returns:
        Root DOM Element representing the EPPUpdateCmd extension instance.
        Throws:
        EPPEncodeException - Unable to encode EPPUpdateCmd extension instance.

      • doDecode

        protected abstract void doDecode​(org.w3c.dom.Element aElement)
                          throws EPPDecodeException
        Must be defined by EPPUpdateCmd extensions (Command Mappings) to decode the attributes to a DOM Element tree. doGenDecode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
        Parameters:
        aElement - Root DOM Element representing the EPPUpdateCmd extension instance.
        Throws:
        EPPDecodeException - Unable to decode aElement.