|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPCheckCmd
com.verisign.epp.codec.registry.EPPRegistryCheckCmd
public class EPPRegistryCheckCmd
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:
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
.
EPPRegistryCheckResp
,
Serialized FormField Summary | |
---|---|
static int |
MAX_ZONES
Maximum number of zones 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 | |
---|---|
EPPRegistryCheckCmd()
EPPRegistryCheckCmd default constructor. |
|
EPPRegistryCheckCmd(java.lang.String aTransId,
java.util.List names)
EPPRegistryCheckCmd constructor that will check a list of
zone names. |
|
EPPRegistryCheckCmd(java.lang.String aTransId,
java.lang.String aName)
EPPRegistryCheckCmd constructor that will check an
individual zone name. |
Method Summary | |
---|---|
void |
addName(java.lang.String name)
Append a zone name to the name List to check. |
java.lang.Object |
clone()
Clone EPPRegistryCheckCmd . |
protected void |
doDecode(org.w3c.dom.Element aElement)
Decode the EPPRegistryCheckCmd 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 EPPRegistryCheckCmd instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of EPPRegistryCheckCmd with this
instance. |
java.util.List |
getNames()
Get zone names to check |
java.lang.String |
getNamespace()
Gets the EPP command Namespace associated with EPPRegistryCheckCmd . |
void |
setName(java.lang.String name)
Set an individual zone name to check. |
void |
setNames(java.util.List names)
Set zone 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 |
---|
public static final int MAX_ZONES
Constructor Detail |
---|
public EPPRegistryCheckCmd()
EPPRegistryCheckCmd
default constructor. It will set the
names attribute to an empty List
.
public EPPRegistryCheckCmd(java.lang.String aTransId, java.lang.String aName)
EPPRegistryCheckCmd
constructor that will check an
individual zone name.
aTransId
- Transaction Id associated with command.aName
- zone name to checkpublic EPPRegistryCheckCmd(java.lang.String aTransId, java.util.List names)
EPPRegistryCheckCmd
constructor that will check a list of
zone names.
aTransId
- Transaction Id associated with command.names
- List
of zone name String
instances.Method Detail |
---|
public java.lang.String getNamespace()
EPPRegistryCheckCmd
.
getNamespace
in interface EPPMessage
getNamespace
in class EPPCommand
EPPRegistryMapFactory.NS
public boolean equals(java.lang.Object aObject)
EPPRegistryCheckCmd
with this
instance.
equals
in class EPPCheckCmd
aObject
- Object to compare with.
true
if this object is the same as the aObject argument;
false
otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPRegistryCheckCmd
.
clone
in interface EPPCodecComponent
clone
in class EPPCommand
EPPRegistryCheckCmd
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class EPPCommand
String
if successful;
ERROR
otherwise.protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPRegistryCheckCmd
instance.
doEncode
in class EPPCheckCmd
aDocument
- DOM Document that is being built. Used as an Element factory.
EPPRegistryCheckCmd
instance.
EPPEncodeException
- Unable to encode EPPRegistryCheckCmd
instance.protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPRegistryCheckCmd
attributes from the aElement
DOM Element tree.
doDecode
in class EPPCheckCmd
aElement
- Root DOM Element to decode EPPRegistryCheckCmd
from.
EPPDecodeException
- Unable to decode aElementpublic java.util.List getNames()
List
of zone name String
'spublic void setNames(java.util.List names)
names
- List
of zone name String
'spublic void setName(java.lang.String name)
List
.
name
- zone name to checkpublic void addName(java.lang.String name)
List
to check. This method does
NOT clear existing zone name List
.
name
- zone name to append
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |