Package com.verisign.epp.codec.registry

Class EPPRegistryCheckCmd

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable
    public class EPPRegistryCheckCmd
extends EPPCheckCmd
    Represents an EPP Registry <check> command, which is used to determine if a zone name is known to the server. The <registry:check> element MUST contain the following child elements:

    • One or more (up to a maximum of MAX_ZONES) <registry:name> elements that contain the fully qualified name of the queried zones. Use getNames and setNames to get and set the elements. Use addName to add a name to existing list or use setName to set an individual name.

    EPPRegistryCheckResp is the concrete EPPReponse associated with EPPRegistryCheckCmd.

    See Also:
    EPPRegistryCheckResp, Serialized Form

    • Field Detail

      • MAX_ZONES

        public static final int MAX_ZONES
        Maximum number of zones to check at once.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EPPRegistryCheckCmd

        public EPPRegistryCheckCmd()
        EPPRegistryCheckCmd default constructor. It will set the names attribute to an empty List.

      • EPPRegistryCheckCmd

        public EPPRegistryCheckCmd​(java.lang.String aTransId,
                           java.lang.String aName)
        EPPRegistryCheckCmd constructor that will check an individual zone name.
        Parameters:
        aTransId - Transaction Id associated with command.
        aName - zone name to check

      • EPPRegistryCheckCmd

        public EPPRegistryCheckCmd​(java.lang.String aTransId,
                           java.util.List names)
        EPPRegistryCheckCmd constructor that will check a list of zone names.
        Parameters:
        aTransId - Transaction Id associated with command.
        names - List of zone name String instances.

    • Method Detail

      • getKey

        public java.lang.String getKey()
        Gets the key for the registry object, which is the zone name.
        Overrides:
        getKey in class EPPCommand
        Returns:
        The zone name if set with a single value; null otherwise.

      • equals

        public boolean equals​(java.lang.Object aObject)
        Compare an instance of EPPRegistryCheckCmd with this instance.
        Overrides:
        equals in class EPPCheckCmd
        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 EPPRegistryCheckCmd.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class EPPCommand
        Returns:
        Deep copy clone of EPPRegistryCheckCmd
        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 EPPRegistryCheckCmd instance.
        Specified by:
        doEncode in class EPPCheckCmd
        Parameters:
        aDocument - DOM Document that is being built. Used as an Element factory.
        Returns:
        Element Root DOM Element representing the EPPRegistryCheckCmd instance.
        Throws:
        EPPEncodeException - Unable to encode EPPRegistryCheckCmd instance.

      • doDecode

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

      • getNames

        public java.util.List getNames()
        Get zone names to check
        Returns:
        List of zone name String's

      • setNames

        public void setNames​(java.util.List names)
        Set zone names to check
        Parameters:
        names - List of zone name String's

      • setName

        public void setName​(java.lang.String name)
        Set an individual zone name to check. This method clears existing zone name List.
        Parameters:
        name - zone name to check

      • addName

        public void addName​(java.lang.String name)
        Append a zone name to the name List to check. This method does NOT clear existing zone name List.
        Parameters:
        name - zone name to append