Package com.verisign.epp.codec.host

Class EPPHostInfoCmd

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable
    public class EPPHostInfoCmd
extends EPPInfoCmd
    Represents an EPP Host <info> command that is used to retrieve information associated with a host. The <host:info> element MUST contain the following child elements:
    • A <host:name> element that contains the fully qualified host name for which information is requested. Use getName and setName to get and set the element.
    EPPHostInfoResp is the concrete EPPReponse associated with EPPHostInfoCmd.
    See Also:
    EPPHostInfoResp, Serialized Form

    • Field Detail

      • ELM_LOCALNAME

        public static final java.lang.String ELM_LOCALNAME
        XML local name for EPPHostInfoCmd.
        See Also:
        Constant Field Values

      • ELM_NAME

        public static final java.lang.String ELM_NAME
        XML Element Name of EPPHostInfoCmd root element.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EPPHostInfoCmd

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

      • EPPHostInfoCmd

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

    • Method Detail

      • getKey

        public java.lang.String getKey()
        Gets the key for the host object, which is the host name.
        Overrides:
        getKey in class EPPCommand
        Returns:
        The host name if set; null 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 EPPHostInfoCmd 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 EPPHostInfoCmd instance.
        Throws:
        EPPEncodeException - Unable to encode EPPHostInfoCmd instance.

      • doDecode

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

      • getName

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

      • setName

        public void setName​(java.lang.String aName)
        Sets the host name to get information on.
        Parameters:
        aName - Host Name

      • equals

        public boolean equals​(java.lang.Object aObject)
        Compare an instance of EPPHostInfoCmd with this instance.
        Overrides:
        equals in class EPPInfoCmd
        Parameters:
        aObject - Object to compare with.
        Returns:
        true if equal; false otherwise

      • clone

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