Package com.verisign.epp.codec.registry.v02

Class EPPRegistryInfoCmd

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable
    public class EPPRegistryInfoCmd
extends EPPInfoCmd
    Represents an EPP Registry <info> command that is used to retrieve information associated with a registry. The <registry:info> element MUST contain one of the following child elements:

    • A <registry:all> empty element that specifies whether or not to query a list of all supported zone objects by the server. Use isAll and setAll to get and set the element.
    • A <registry:name> element that contains the fully qualified zone object name for which information is requested. Use getName and setName to get and set the element.
    • A <registry:system> Element that is empty and that indicates that the registry system attributes, like maximum connections and timeouts, are queried. Use isSystem and setSystem to get and set the element.
    A valid EPPRegistryInfoCmd must contains one and only one of the above elements.

    EPPRegistryInfoResp is the concrete EPPReponse associated with EPPRegistryInfoResp.

    See Also:
    EPPRegistryInfoResp, Serialized Form

    • Field Detail

      • ELM_LOCALNAME

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

      • ELM_NAME

        public static final java.lang.String ELM_NAME
        XML root tag for EPPRegistryInfoCmd.
        See Also:
        Constant Field Values

      • ATTR_SCOPE

        public static final java.lang.String ATTR_SCOPE
        XML attribute name for the scope attribute.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EPPRegistryInfoCmd

        public EPPRegistryInfoCmd​(java.lang.String aTransId,
                          java.lang.String aName)
        EPPRegistryInfoCmd constructor that takes the qualified aLabel zone object name as an argument. The mode is set to Enum.name().
        Parameters:
        aTransId - transaction Id associated with command
        aName - fully qualified aLabel zone object name to get information on

      • EPPRegistryInfoCmd

        public EPPRegistryInfoCmd​(java.lang.String aTransId,
                          EPPRegistryZoneName aName)
        EPPRegistryInfoCmd constructor that takes the qualified zone object name as an argument. The mode is set to Enum.name().
        Parameters:
        aTransId - transaction Id associated with command
        aName - fully qualified zone object name to get information on

      • EPPRegistryInfoCmd

        public EPPRegistryInfoCmd​(java.lang.String aTransId,
                          EPPRegistryInfoCmd.Mode aMode)
        EPPRegistryInfoCmd constructor defines the query mode to use. It is most likely used when setting the mode to EPPRegistryInfoCmd.Mode.system.
        Parameters:
        aTransId - transaction Id associated with command
        aMode - Query mode to use.

      • EPPRegistryInfoCmd

        public EPPRegistryInfoCmd​(java.lang.String aTransId,
                          EPPRegistryInfoCmd.Scope aScope)
        EPPRegistryInfoCmd constructor that queries for all of the accessible and/or available zone objects from the server with the desired scope. The mode is set to EPPRegistryInfoCmd.Mode.all.
        Parameters:
        aTransId - transaction Id associated with command
        aScope - Zone scope to query for. Passing null will result in the use of the default scope Scope#accessible.

    • 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 EPPRegistryInfoCmd 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 EPPRegistryInfoCmd instance.
        Throws:
        EPPEncodeException - Unable to encode EPPRegistryInfoCmd instance.

      • doDecode

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

      • 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 EPPRegistryInfoCmd with this instance.
        Overrides:
        equals in class EPPInfoCmd
        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 EPPRegistryInfoCmd.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class EPPCommand
        Returns:
        clone of EPPRegistryInfoCmd
        Throws:
        java.lang.CloneNotSupportedException - standard Object.clone exception

      • hasName

        public boolean hasName()
        Is the name defined?
        Returns:
        true if the name is defined; false otherwise.

      • getName

        public EPPRegistryZoneName getName()
        Gets the zone name.
        Returns:
        Zone name if set; null otherwise.

      • setName

        public void setName​(EPPRegistryZoneName aName)
        Sets the zone name to query for. The mode is set to Enum.name().
        Parameters:
        aName - Zone name

      • setName

        public void setName​(java.lang.String aName)
        Sets the zone name to query for. The mode is set to Enum.name().
        Parameters:
        aName - aLabel zone name

      • hasMode

        public boolean hasMode()
        Is the query mode defined?
        Returns:
        true if the query mode is defined; false otherwise.

      • getMode

        public EPPRegistryInfoCmd.Mode getMode()
        Gets the query mode.
        Returns:
        The query mode if defined; null otherwise.

      • setMode

        public void setMode​(EPPRegistryInfoCmd.Mode aMode)
        Sets the query mode.
        Parameters:
        aMode - Query mode to use

      • getScope

        public EPPRegistryInfoCmd.Scope getScope()
        Gets the zone scope used with the query all option.
        Returns:
        Scope passed with the <registry:all> "scope" attribute if defined; null otherwise.