com.verisign.epp.codec.domain
Class EPPDomainCheckCmd

java.lang.Object
  extended by com.verisign.epp.codec.gen.EPPCommand
      extended by com.verisign.epp.codec.gen.EPPCheckCmd
          extended by com.verisign.epp.codec.domain.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:


EPPDomainCheckResp is the concrete EPPReponse associated with EPPDomainCheckCmd.

Version:
$Revision: 1.2 $
Author:
$Author: jim $
See Also:
EPPDomainCheckResp, Serialized Form

Field Summary
static int MAX_DOMAINS
          Maximum number of domains to check at once.
 
Fields inherited from class com.verisign.epp.codec.gen.EPPCommand
extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE
 
Constructor Summary
EPPDomainCheckCmd()
          EPPDomainCheckCmd default constructor.
EPPDomainCheckCmd(java.lang.String aTransId, java.lang.String aName)
          EPPDomainCheckCmd constructor that will check an individual domain name.
EPPDomainCheckCmd(java.lang.String aTransId, java.util.Vector someNames)
          EPPDomainCheckCmd constructor that will check a list of domain names.
 
Method Summary
 java.lang.Object clone()
          Clone EPPDomainCheckCmd.
protected  void doDecode(org.w3c.dom.Element aElement)
          Decode the EPPDomainCheckCmd attributes from the aElement DOM Element tree.
protected  org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument)
          Encode a DOM Element tree from the attributes of the EPPDomainCheckCmd instance.
 boolean equals(java.lang.Object aObject)
          Compare an instance of EPPDomainCheckCmd with this instance.
 java.util.Vector getNames()
          Gets domain names to check.
 java.lang.String getNamespace()
          Gets the EPP command Namespace associated with EPPDomainCheckCmd.
 void setName(java.lang.String aName)
          Sets domain name to check.
 void setNames(java.util.Vector someNames)
          Sets domain names to check.
 java.lang.String toString()
          Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
 
Methods inherited from class com.verisign.epp.codec.gen.EPPCheckCmd
doGenDecode, doGenEncode, getType
 
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand
addExtension, decode, encode, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX_DOMAINS

public static final int MAX_DOMAINS
Maximum number of domains to check at once.

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 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

getNamespace

public java.lang.String getNamespace()
Gets the EPP command Namespace associated with EPPDomainCheckCmd.

Specified by:
getNamespace in interface EPPMessage
Specified by:
getNamespace in class EPPCommand
Returns:
EPPDomainMapFactory.NS

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:
DOCUMENT ME!

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 getNames()
Gets domain names to check.

Returns:
Vector of domain name String's.

setNames

public void setNames(java.util.Vector 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


Copyright ? VeriSign Inc. All Rights Reserved.