Package com.verisign.epp.codec.host
Class EPPHostCheckResp
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPResponse
-
- com.verisign.epp.codec.host.EPPHostCheckResp
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPHostCheckResp extends EPPResponse
Represents an EPP Host <host:chkData> response to aEPPHostCheckCmd
. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <host:chkData> element that identifies the host namespace and the location of the host schema. The <host:chkData> element contains one or more <host:cd> elements that contain the following child elements:
- A <host:name> element that contains the fully qualified name of the queried host object. This element MUST contain an "avail" attribute whose value indicates object availability at the moment the <check> command was completed. A value of "1" or "true" menas that the object is availabe. A value of "0" or "false" means that the object is not available.
-
An OPTIONAL <host:reason> element that MAY be provided when an object
is not available for provisioning. If present, this element contains
server-specific text to help explain why the object is unavailable. This
text MUST be represented in the response language previously negotiated
with the client; an OPTIONAL "lang" attribute MAY be present to identify
the language if the negotiated value is something other that a default
value of "en" (English). Use
getCheckResults
andsetCheckResults
to get and set the elements.
- See Also:
EPPHostCheckCmd
,EPPHostCheckResult
, Serialized Form
-
-
Field Summary
-
Fields inherited from class com.verisign.epp.codec.gen.EPPResponse
ELM_EXTENSION, ELM_MESSAGE_QUEUE, ELM_MESSAGE_QUEUE_QDATE, ELM_RESPONSE_DATA, extensions, TRANSFER_CLIENT_APPROVED, TRANSFER_CLIENT_CANCELLED, TRANSFER_CLIENT_REJECTED, TRANSFER_PENDING, TRANSFER_SERVER_APPROVED, TRANSFER_SERVER_CANCELLED
-
-
Constructor Summary
Constructors Constructor Description EPPHostCheckResp()
EPPHostCheckResp
default constructor.EPPHostCheckResp(EPPTransId aTransId, EPPHostCheckResult aResult)
EPPHostCheckResp
constructor that will set the result of an individual host.EPPHostCheckResp(EPPTransId aTransId, java.util.Vector someResults)
EPPHostCheckResp
constructor that will set the result of multiple hosts.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPHostCheckResp
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPHostCheckResp
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 theEPPHostCheckResp
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPHostCheckResp
with this instance.java.util.Vector
getCheckResults()
Get the results of a EPPHostCheckResp Response.java.lang.String
getNamespace()
Get the EPP command Namespace associated withEPPHostCheckResp
.java.lang.String
getType()
Get the EPP response type associated withEPPHostCheckResp
.void
setCheckResults(java.util.Vector someResults)
Set the results of aEPPHostCheckResp
Response.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.EPPResponse
addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getMessageQueue, getMsgQueue, getMsgQueueCount, getMsgQueueDate, getMsgQueueMsg, getQDate, getResult, getResults, getTransId, hasExtension, hasExtensions, hasMessageQueue, hasMsgQueue, hasResultCode, isSuccess, setExtension, setExtensions, setMsgQueue, setResult, setResult, setResult, setResult, setResults, setTransId
-
-
-
-
Constructor Detail
-
EPPHostCheckResp
public EPPHostCheckResp()
EPPHostCheckResp
default constructor. It will set results attribute to an emptyVector
.
-
EPPHostCheckResp
public EPPHostCheckResp(EPPTransId aTransId, EPPHostCheckResult aResult)
EPPHostCheckResp
constructor that will set the result of an individual host.- Parameters:
aTransId
- Transaction Id associated with response.aResult
- Result of a single host name.
-
EPPHostCheckResp
public EPPHostCheckResp(EPPTransId aTransId, java.util.Vector someResults)
EPPHostCheckResp
constructor that will set the result of multiple hosts.- Parameters:
aTransId
- Transaction Id associated with response.someResults
- Vector of EPPCheckHostResult instances.
-
-
Method Detail
-
getType
public java.lang.String getType()
Get the EPP response type associated withEPPHostCheckResp
.- Overrides:
getType
in classEPPResponse
- Returns:
- EPPHostCheckResp.ELM_NAME
-
getNamespace
public java.lang.String getNamespace()
Get the EPP command Namespace associated withEPPHostCheckResp
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Overrides:
getNamespace
in classEPPResponse
- 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 theEPPHostCheckResp
instance.- Overrides:
doEncode
in classEPPResponse
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPHostCheckResp
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPHostCheckResp
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPHostCheckResp
attributes from the aElement DOM Element tree.- Overrides:
doDecode
in classEPPResponse
- Parameters:
aElement
- Root DOM Element to decodeEPPHostCheckResp
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPHostCheckResp
with this instance.- Overrides:
equals
in classEPPResponse
- Parameters:
aObject
- Object to compare with.- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPHostCheckResp
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPResponse
- Returns:
- clone of
EPPHostCheckResp
- 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 classEPPResponse
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
setCheckResults
public void setCheckResults(java.util.Vector someResults)
Set the results of aEPPHostCheckResp
Response. There is oneEPPCheckHostResult
instance insomeResults
for each host requested in theEPPHostCheckCmd
Command.- Parameters:
someResults
- Vector ofEPPCheckHostResult
instances.
-
getCheckResults
public java.util.Vector getCheckResults()
Get the results of a EPPHostCheckResp Response. There is oneEPPCheckHostResult
instance insomeResults
for each host requested in theEPPCheckHostResult
Command.- Returns:
- Vector of
EPPHostResult
instances.
-
-