Package com.verisign.epp.codec.registry
Class EPPRegistryCheckResp
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPResponse
-
- com.verisign.epp.codec.registry.EPPRegistryCheckResp
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPRegistryCheckResp extends EPPResponse
Represents an EPP Registry <registry:chkData> response to aEPPRegistryCheckCmd
. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <registry:chkData> element that identifies the registry namespace and the location of the registry schema. The <registry:chkData> elements that contain the following child elements:
- A <registry:name> element that contains the fully qualified name of the queried zone 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" means that the object is availabe. A value of "0" or "false" means that the object is not available.
- An OPTIONAL <registry: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:
EPPRegistryCheckCmd
,EPPRegistryCheckResult
, 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 EPPRegistryCheckResp()
EPPRegistryCheckResp
default constructor.EPPRegistryCheckResp(EPPTransId aTransId, EPPRegistryCheckResult aResult)
EPPRegistryCheckResp
constructor that will set the result of an individual zone object.EPPRegistryCheckResp(EPPTransId aTransId, java.util.List someResults)
EPPRegistryCheckResp
constructor that will set the result of multiple zone objects.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPRegistryCheckResp
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPRegistryCheckResp
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 theEPPRegistryCheckResp
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPRegistryCheckResp
with this instance.java.util.List
getCheckResults()
Get the check results of zone objects.java.lang.String
getNamespace()
Get the EPP command Namespace associated withEPPRegistryCheckResp
.java.lang.String
getType()
Get the EPP response type associated withEPPRegistryCheckResp
.void
setCheckResults(java.util.List results)
Set the check results of zone objects.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
-
EPPRegistryCheckResp
public EPPRegistryCheckResp()
EPPRegistryCheckResp
default constructor. It will set results attribute to an emptyList
.
-
EPPRegistryCheckResp
public EPPRegistryCheckResp(EPPTransId aTransId, EPPRegistryCheckResult aResult)
EPPRegistryCheckResp
constructor that will set the result of an individual zone object.- Parameters:
aTransId
- transaction Id associated with responseaResult
-EPPRegistryCheckResult
instance of a single registry name
-
EPPRegistryCheckResp
public EPPRegistryCheckResp(EPPTransId aTransId, java.util.List someResults)
EPPRegistryCheckResp
constructor that will set the result of multiple zone objects.- Parameters:
aTransId
- transaction Id associated with responsesomeResults
-List
ofEPPRegistryCheckResult
instances
-
-
Method Detail
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPRegistryCheckResp
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
EPPRegistryCheckResp
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPRegistryCheckResp
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPRegistryCheckResp
attributes from the aElement DOM Element tree.- Overrides:
doDecode
in classEPPResponse
- Parameters:
aElement
- Root DOM Element to decodeEPPRegistryCheckResp
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
getType
public java.lang.String getType()
Get the EPP response type associated withEPPRegistryCheckResp
.- Overrides:
getType
in classEPPResponse
- Returns:
EPPRegistryCheckResp.ELM_NAME
-
getNamespace
public java.lang.String getNamespace()
Get the EPP command Namespace associated withEPPRegistryCheckResp
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Overrides:
getNamespace
in classEPPResponse
- Returns:
EPPRegistryMapFactory.NS
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPRegistryCheckResp
with this instance.- Overrides:
equals
in classEPPResponse
- 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
CloneEPPRegistryCheckResp
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPResponse
- Returns:
- clone of
EPPRegistryCheckResp
- 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.
-
getCheckResults
public java.util.List getCheckResults()
Get the check results of zone objects.- Returns:
List
ofEPPRegistryCheckResult
-
setCheckResults
public void setCheckResults(java.util.List results)
Set the check results of zone objects.- Parameters:
results
-List
ofEPPRegistryCheckResult
-
-