Package com.verisign.epp.codec.host
Class EPPHostCheckCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPCheckCmd
-
- com.verisign.epp.codec.host.EPPHostCheckCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPHostCheckCmd extends EPPCheckCmd
Represents an EPP Host <check> command, which is used to determine if a host name is known to the server. The <host:check> element MUST contain the following child elements:
-
One or more <host:name> elements that contain the fully qualified name
of the queried hosts. Use
getNames
andsetNames
to get and set the elements. UsesetNames
to set an individual name.
EPPHostCheckResp
is the concreteEPPReponse
associated withEPPHostCheckCmd
.- See Also:
EPPHostCheckResp
, Serialized Form
-
-
Field Summary
-
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 EPPHostCheckCmd()
EPPHostCheckCmd
default constructor.EPPHostCheckCmd(java.lang.String aTransId, java.lang.String aName)
EPPHostCheckCmd
constructor that will check an individual host name.EPPHostCheckCmd(java.lang.String aTransId, java.util.Vector someNames)
EPPHostCheckCmd
constructor that will check a list of host names.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPHostCheckCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPHostCheckCmd
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 theEPPHostCheckCmd
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPHostCheckCmd
with this instance.java.util.Vector
getNames()
Gets host names to check.java.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPHostCheckCmd
.void
setName(java.lang.String aName)
Sets host name to check.void
setNames(java.util.Vector someNames)
Sets host 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
-
-
-
-
Constructor Detail
-
EPPHostCheckCmd
public EPPHostCheckCmd()
EPPHostCheckCmd
default constructor. It will set the names attribute to an emptyVector
.
-
EPPHostCheckCmd
public EPPHostCheckCmd(java.lang.String aTransId, java.lang.String aName)
EPPHostCheckCmd
constructor that will check an individual host name.- Parameters:
aTransId
- Transaction Id associated with command.aName
- Host name to check
-
EPPHostCheckCmd
public EPPHostCheckCmd(java.lang.String aTransId, java.util.Vector someNames)
EPPHostCheckCmd
constructor that will check a list of host names.- Parameters:
aTransId
- Transaction Id associated with command.someNames
-Vector
of host nameString
instances.
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPHostCheckCmd
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
EPPHostMapFactory.NS
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPHostCheckCmd
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
EPPHostCheckCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPHostCheckCmd
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPHostCheckCmd
attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPCheckCmd
- Parameters:
aElement
- Root DOM Element to decodeEPPHostCheckCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPHostCheckCmd
with this instance.- Overrides:
equals
in classEPPCheckCmd
- Parameters:
aObject
- Object to compare with.- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPHostCheckCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- clone of
EPPHostCheckCmd
- 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 host name to check.- Parameters:
aName
- Name to check.
-
getNames
public java.util.Vector getNames()
Gets host names to check.- Returns:
- Vector of host name
String
's.
-
setNames
public void setNames(java.util.Vector someNames)
Sets host names to check.- Parameters:
someNames
- Names to check.
-
-