Package com.verisign.epp.codec.domain
Class EPPDomainCheckCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPCheckCmd
-
- 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:
- One or more (up to a maximum of
MAX_DOMAINS
) <domain:name> elements that contain the fully qualified name of the queried domains. UsegetNames
andsetNames
to get and set the elements. UsesetName
to set an individual name.
EPPDomainCheckResp
is the concreteEPPReponse
associated withEPPDomainCheckCmd
.
- See Also:
EPPDomainCheckResp
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPDomainCheckCmd
.static java.lang.String
ELM_NAME
XML Element Name ofEPPDomainInfoResp
root element.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
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPDomainCheckCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPDomainCheckCmd
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 theEPPDomainCheckCmd
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPDomainCheckCmd
with this instance.java.util.Vector
getNames()
Gets domain names to check.java.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPDomainCheckCmd
.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 ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.-
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, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId
-
-
-
-
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 forEPPDomainCheckCmd
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML Element Name ofEPPDomainInfoResp
root element.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPDomainCheckCmd
public EPPDomainCheckCmd()
EPPDomainCheckCmd
default constructor. It will set the names attribute to an emptyVector
.
-
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 nameString
instances.
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPDomainCheckCmd
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
EPPDomainMapFactory.NS
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPDomainCheckCmd
with this instance.- Overrides:
equals
in classEPPCheckCmd
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
otherwise.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPDomainCheckCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- Deep copy clone of
EPPDomainCheckCmd
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classEPPCommand
- 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 theEPPDomainCheckCmd
instance.- Specified by:
doEncode
in classEPPCheckCmd
- 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 encodeEPPDomainCheckCmd
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPDomainCheckCmd
attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPCheckCmd
- Parameters:
aElement
- Root DOM Element to decodeEPPDomainCheckCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
-