Package com.verisign.epp.codec.defReg
Class EPPDefRegCheckResp
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPResponse
-
- com.verisign.epp.codec.defReg.EPPDefRegCheckResp
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPDefRegCheckResp extends EPPResponse
Represents an EPPDefReg <defReg:chkData> response to aEPPDefRegFwdCheckCmd
. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <defReg:chkData> element that identifies the defReg namespace and the location of the defReg schema. The <defReg:chkData> elements that contain the following child elements:
- A <defReg:name> element that contains the fully qualified name of the queried defReg object with a attribute level whose value is of either "premium" or "standard". 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 <defReg:reason> element that MAY be provided when an object is not available for provisioning. If present,EPPDefReg 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:
EPPDefRegCheckCmd
,EPPDefRegCheckResult
, 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 EPPDefRegCheckResp()
EPPDefRegFwdCheckResp
default constructor.EPPDefRegCheckResp(EPPTransId aTransId, EPPDefRegCheckResult aResult)
EPPDefRegFwdCheckResp
constructor that will set the result of an individual defReg.EPPDefRegCheckResp(EPPTransId aTransId, java.util.Vector someResults)
EPPDefRegFwdCheckResp
constructor that will set the result of multiple defRegs.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPDefRegFwdCheckResp
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPDefRegFwdCheckResp
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 theEPPDefRegFwdCheckResp
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPDefRegFwdCheckResp
with this instance.java.util.Vector
getCheckResults()
Get the results of aEPPDefRegFwdCheckResp
Response.java.lang.String
getNamespace()
Get the EPP command Namespace associated withEPPDefRegFwdCheckResp
.java.lang.String
getType()
Get the EPP response type associated withEPPDefRegFwdCheckResp
.void
setCheckResults(java.util.Vector someResults)
Set the results of aEPPDefRegFwdCheckResp
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
-
EPPDefRegCheckResp
public EPPDefRegCheckResp()
EPPDefRegFwdCheckResp
default constructor. It will set results attribute to an emptyVector
.
-
EPPDefRegCheckResp
public EPPDefRegCheckResp(EPPTransId aTransId, EPPDefRegCheckResult aResult)
EPPDefRegFwdCheckResp
constructor that will set the result of an individual defReg.- Parameters:
aTransId
- Transaction Id associated with response.aResult
- EPPDefRegCheckResult results.
-
EPPDefRegCheckResp
public EPPDefRegCheckResp(EPPTransId aTransId, java.util.Vector someResults)
EPPDefRegFwdCheckResp
constructor that will set the result of multiple defRegs.- Parameters:
aTransId
- Transaction Id associated with response.someResults
- Vector of EPPDefRegFwdCheckResult instances.
-
-
Method Detail
-
getType
public java.lang.String getType()
Get the EPP response type associated withEPPDefRegFwdCheckResp
.- Overrides:
getType
in classEPPResponse
- Returns:
- EPPDefRegFwdCheckResp.ELM_NAME
-
getNamespace
public java.lang.String getNamespace()
Get the EPP command Namespace associated withEPPDefRegFwdCheckResp
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Overrides:
getNamespace
in classEPPResponse
- Returns:
EPPDefRegFwdMapFactory.NS
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPDefRegFwdCheckResp
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
CloneEPPDefRegFwdCheckResp
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPResponse
- Returns:
- clone of
EPPDefRegFwdCheckResp
- 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 aEPPDefRegFwdCheckResp
Response. There is oneEPPDefRegFwdCheckResult
instance insomeResults
for each defReg requested in theEPPDefRegFwdCheckCmd
Command.- Parameters:
someResults
- Vector ofEPPDefRegFwdCheckResult
instances.
-
getCheckResults
public java.util.Vector getCheckResults()
Get the results of aEPPDefRegFwdCheckResp
Response. There is oneEPPDefRegFwdCheckResult
instance insomeResults
for each defReg requested in theEPPDefRegFwdCheckResult
Command.- Returns:
- Vector of
EPPDefRegFwdCheckResult
instances.
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPDefRegFwdCheckResp
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
EPPDefRegFwdCheckResp
instance. defReg - Throws:
EPPEncodeException
- Unable to encodeEPPDefRegFwdCheckResp
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPDefRegFwdCheckResp
attributes from the aElement DOM Element tree.- Overrides:
doDecode
in classEPPResponse
- Parameters:
aElement
- Root DOM Element to decodeEPPDefRegFwdCheckResp
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
-