Package com.verisign.epp.codec.domain

Class EPPDomainCheckCmd

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

    • One or more (up to a maximum of MAX_DOMAINS) <domain:name> elements that contain the fully qualified name of the queried domains. Use getNames and setNames to get and set the elements. Use setName to set an individual name.

    EPPDomainCheckResp is the concrete EPPReponse associated with EPPDomainCheckCmd.

    See Also:
    EPPDomainCheckResp, Serialized Form

    • Field Detail

      • MAX_DOMAINS

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

      • ELM_LOCALNAME

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

      • ELM_NAME

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

    • Constructor Detail

      • EPPDomainCheckCmd

        public EPPDomainCheckCmd()
        EPPDomainCheckCmd default constructor. It will set the names attribute to an empty Vector.

      • EPPDomainCheckCmd

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

      • EPPDomainCheckCmd

        public EPPDomainCheckCmd​(java.lang.String aTransId,
                         java.util.Vector<java.lang.String> someNames)
        EPPDomainCheckCmd constructor that will check a list of domain names.
        Parameters:
        aTransId - Transaction Id associated with command.
        someNames - Vector of domain name String instances.

    • Method Detail

      • getKey

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

      • equals

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

      • clone

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

      • setName

        public void setName​(java.lang.String aName)
        Sets domain name to check.
        Parameters:
        aName - Name to check.

      • getNames

        public java.util.Vector<java.lang.String> getNames()
        Gets domain names to check.
        Returns:
        Vector of domain name String's.

      • setNames

        public void setNames​(java.util.Vector<java.lang.String> someNames)
        Sets domain names to check.
        Parameters:
        someNames - Names to check.

      • doEncode

        protected org.w3c.dom.Element doEncode​(org.w3c.dom.Document aDocument)
                                throws EPPEncodeException
        Encode a DOM Element tree from the attributes of the EPPDomainCheckCmd 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 EPPDomainCheckCmd instance.
        Throws:
        EPPEncodeException - Unable to encode EPPDomainCheckCmd instance.

      • doDecode

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