Class EPPEmailFwdInfoCmd

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable

    public class EPPEmailFwdInfoCmd
    extends EPPInfoCmd
    Represents an EPP EmailFwd <info> command that is used to retrieve information associated with a emailFwd. The <emailFwd:info> element MUST contain the following child elements:

    • A <emailFwd:name> element that contains the fully qualified emailFwd name for which information is requested. Use getName and setName to get and set the element.

    EPPEmailFwdInfoResp is the concrete EPPReponse associated with EPPEmailFwdInfoCmd.

    See Also:
    EPPEmailFwdInfoResp, Serialized Form
    • Constructor Detail

      • EPPEmailFwdInfoCmd

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

        public EPPEmailFwdInfoCmd​(java.lang.String aTransId,
                                  java.lang.String aName)
        EPPEmailFwdInfoCmd constructor that takes the emailFwd name as an argument.
        Parameters:
        aTransId - Transaction Id associated with command.
        aName - EmailFwd name to get information on.
      • EPPEmailFwdInfoCmd

        public EPPEmailFwdInfoCmd​(java.lang.String aTransId,
                                  java.lang.String aName,
                                  EPPAuthInfo aAuthInfo)
        EPPEmailFwdInfoCmd constructor that takes the emailFwd name, authInfo as arguments.
        Parameters:
        aTransId - Transaction Id associated with command.
        aName - EmailFwd name to get information on.
        aAuthInfo - Optional authorization information. Set to null for no authorization information.
    • Method Detail

      • doEncode

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

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

        public java.lang.String getName()
        Gets the emailFwd name to get information on.
        Returns:
        EmailFwd Name String instance if defined; null otherwise.
      • setName

        public void setName​(java.lang.String aName)
        Sets the emailFwd name to get information on.
        Parameters:
        aName - EmailFwd Name
      • getAuthInfo

        public EPPAuthInfo getAuthInfo()
        Get authorization information
        Returns:
        Authorization information if defined; null otherwise;
      • setAuthInfo

        public void setAuthInfo​(EPPAuthInfo aAuthInfo)
        Set authorization information
        Parameters:
        aAuthInfo - EPPAuthInfo
      • equals

        public boolean equals​(java.lang.Object aObject)
        Compare an instance of EPPEmailFwdInfoCmd with this instance.
        Overrides:
        equals in class EPPInfoCmd
        Parameters:
        aObject - Object to compare with.
        Returns:
        DOCUMENT ME!
      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Clone EPPEmailFwdInfoCmd.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class EPPCommand
        Returns:
        clone of EPPEmailFwdInfoCmd
        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.