Package com.verisign.epp.codec.domain
Class EPPDomainCheckResp
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPResponse
-
- com.verisign.epp.codec.domain.EPPDomainCheckResp
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPDomainCheckResp extends EPPResponse
Represents an EPP Domain <domain:chkData> response to aEPPDomainCheckCmd
. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <domain:chkData> element that identifies the domain namespace and the location of the domain schema. The <domain:chkData> elements that contain the following child elements:
- A <domain:name> element that contains the fully qualified name of the queried domain 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 <domain: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).
- See Also:
EPPDomainCheckCmd
,EPPDomainCheckResult
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPDomainCheckResp
.static java.lang.String
ELM_NAME
XML Element Name ofEPPDomainCheckResp
root element.-
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 EPPDomainCheckResp()
EPPDomainCheckResp
default constructor.EPPDomainCheckResp(EPPTransId aTransId)
EPPDomainCheckResp
constructor that sets the transaction identifier.EPPDomainCheckResp(EPPTransId aTransId, EPPDomainCheckResult aResult)
EPPDomainCheckResp
constructor that will set the result of an individual domain.EPPDomainCheckResp(EPPTransId aTransId, java.util.Vector someResults)
EPPDomainCheckResp
constructor that will set the result of multiple domains.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addResult(EPPDomainCheckResult aResult)
Adds a result to the list of check results.java.lang.Object
clone()
CloneEPPDomainCheckResp
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPDomainCheckResp
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 theEPPDomainCheckResp
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPDomainCheckResp
with this instance.java.util.Vector
getCheckResults()
Get the results of aEPPDomainCheckResp
Response.java.lang.String
getNamespace()
Get the EPP command Namespace associated withEPPDomainCheckResp
.java.lang.String
getType()
Get the EPP response type associated withEPPDomainCheckResp
.void
setCheckResults(java.util.Vector aResults)
Set the results of aEPPDomainCheckResp
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
-
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPDomainCheckResp
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML Element Name ofEPPDomainCheckResp
root element.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPDomainCheckResp
public EPPDomainCheckResp()
EPPDomainCheckResp
default constructor. It will set results attribute to an emptyVector
.
-
EPPDomainCheckResp
public EPPDomainCheckResp(EPPTransId aTransId)
EPPDomainCheckResp
constructor that sets the transaction identifier.- Parameters:
aTransId
- Transaction Id associated with response.
-
EPPDomainCheckResp
public EPPDomainCheckResp(EPPTransId aTransId, EPPDomainCheckResult aResult)
EPPDomainCheckResp
constructor that will set the result of an individual domain.- Parameters:
aTransId
- Transaction Id associated with response.aResult
- Result of a single domain name.
-
EPPDomainCheckResp
public EPPDomainCheckResp(EPPTransId aTransId, java.util.Vector someResults)
EPPDomainCheckResp
constructor that will set the result of multiple domains.- Parameters:
aTransId
- Transaction Id associated with response.someResults
- Vector of EPPDomainCheckResult instances.
-
-
Method Detail
-
getType
public java.lang.String getType()
Get the EPP response type associated withEPPDomainCheckResp
.- Overrides:
getType
in classEPPResponse
- Returns:
- EPPDomainCheckResp.ELM_NAME
-
getNamespace
public java.lang.String getNamespace()
Get the EPP command Namespace associated withEPPDomainCheckResp
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Overrides:
getNamespace
in classEPPResponse
- Returns:
EPPDomainMapFactory.NS
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPDomainCheckResp
with this instance.- Overrides:
equals
in classEPPResponse
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
otherwise.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPDomainCheckResp
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPResponse
- Returns:
- clone of
EPPDomainCheckResp
- 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.
-
addResult
public void addResult(EPPDomainCheckResult aResult)
Adds a result to the list of check results.- Parameters:
aResult
- Result to add.
-
setCheckResults
public void setCheckResults(java.util.Vector aResults)
Set the results of aEPPDomainCheckResp
Response. There is oneEPPDomainCheckResult
instance insomeResults
for each domain requested in theEPPDomainCheckCmd
Command.- Parameters:
aResults
- Vector ofEPPDomainCheckResult
instances.
-
getCheckResults
public java.util.Vector getCheckResults()
Get the results of aEPPDomainCheckResp
Response. There is oneEPPDomainCheckResult
instance insomeResults
for each domain requested in theEPPDomainCheckResult
Command.- Returns:
Vector
ofEPPDomainCheckResult
instances.
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPDomainCheckResp
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
EPPDomainCheckResp
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPDomainCheckResp
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPDomainCheckResp
attributes from the aElement DOM Element tree.- Overrides:
doDecode
in classEPPResponse
- Parameters:
aElement
- Root DOM Element to decodeEPPDomainCheckResp
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
-