Package com.verisign.epp.codec.registry
Class EPPRegistryCheckCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPCheckCmd
-
- com.verisign.epp.codec.registry.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. UsegetNames
andsetNames
to get and set the elements. UseaddName
to add a name to existing list or usesetName
to set an individual name.
EPPRegistryCheckResp
is the concreteEPPReponse
associated withEPPRegistryCheckCmd
.
- See Also:
EPPRegistryCheckResp
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description 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
Constructors Constructor Description EPPRegistryCheckCmd()
EPPRegistryCheckCmd
default constructor.EPPRegistryCheckCmd(java.lang.String aTransId, java.lang.String aName)
EPPRegistryCheckCmd
constructor that will check an individual zone name.EPPRegistryCheckCmd(java.lang.String aTransId, java.util.List names)
EPPRegistryCheckCmd
constructor that will check a list of zone names.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addName(java.lang.String name)
Append a zone name to the nameList
to check.java.lang.Object
clone()
CloneEPPRegistryCheckCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPRegistryCheckCmd
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 theEPPRegistryCheckCmd
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPRegistryCheckCmd
with this instance.java.util.List
getNames()
Get zone names to checkjava.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPRegistryCheckCmd
.void
setName(java.lang.String name)
Set an individual zone name to check.void
setNames(java.util.List names)
Set zone names to checkjava.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_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 emptyList
.
-
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 nameString
instances.
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPRegistryCheckCmd
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
EPPRegistryMapFactory.NS
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPRegistryCheckCmd
with this instance.- Overrides:
equals
in classEPPCheckCmd
- 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
CloneEPPRegistryCheckCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- Deep copy clone of
EPPRegistryCheckCmd
- 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.
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPRegistryCheckCmd
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
EPPRegistryCheckCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPRegistryCheckCmd
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPRegistryCheckCmd
attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPCheckCmd
- Parameters:
aElement
- Root DOM Element to decodeEPPRegistryCheckCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
getNames
public java.util.List getNames()
Get zone names to check- Returns:
List
of zone nameString
's
-
setNames
public void setNames(java.util.List names)
Set zone names to check- Parameters:
names
-List
of zone nameString
's
-
setName
public void setName(java.lang.String name)
Set an individual zone name to check. This method clears existing zone nameList
.- Parameters:
name
- zone name to check
-
addName
public void addName(java.lang.String name)
Append a zone name to the nameList
to check. This method does NOT clear existing zone nameList
.- Parameters:
name
- zone name to append
-
-