Package com.verisign.epp.codec.emailFwd
Class EPPEmailFwdCheckResp
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPResponse
-
- com.verisign.epp.codec.emailFwd.EPPEmailFwdCheckResp
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPEmailFwdCheckResp extends EPPResponse
Represents an EPP EmailFwd <emailFwd:chkData> response to aEPPEmailFwdCheckCmd
. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <emailFwd:chkData> element that identifies the emailFwd namespace and the location of the emailFwd schema. The <emailFwd:chkData> elements that contain the following child elements:
- A <emailFwd:name> element that contains the fully qualified name of the queried emailFwd 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 <emailFwd: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:
EPPEmailFwdCheckCmd
,EPPEmailFwdCheckResult
, 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 EPPEmailFwdCheckResp()
EPPEmailFwdCheckResp
default constructor.EPPEmailFwdCheckResp(EPPTransId aTransId, EPPEmailFwdCheckResult aResult)
EPPEmailFwdCheckResp
constructor that will set the result of an individual emailFwd.EPPEmailFwdCheckResp(EPPTransId aTransId, java.util.Vector someResults)
EPPEmailFwdCheckResp
constructor that will set the result of multiple emailFwds.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPEmailFwdCheckResp
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPEmailFwdCheckResp
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 theEPPEmailFwdCheckResp
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPEmailFwdCheckResp
with this instance.java.util.Vector
getCheckResults()
Get the results of aEPPEmailFwdCheckResp
Response.java.lang.String
getNamespace()
Get the EPP command Namespace associated withEPPEmailFwdCheckResp
.java.lang.String
getType()
Get the EPP response type associated withEPPEmailFwdCheckResp
.void
setCheckResults(java.util.Vector someResults)
Set the results of aEPPEmailFwdCheckResp
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
-
EPPEmailFwdCheckResp
public EPPEmailFwdCheckResp()
EPPEmailFwdCheckResp
default constructor. It will set results attribute to an emptyVector
.
-
EPPEmailFwdCheckResp
public EPPEmailFwdCheckResp(EPPTransId aTransId, EPPEmailFwdCheckResult aResult)
EPPEmailFwdCheckResp
constructor that will set the result of an individual emailFwd.- Parameters:
aTransId
- Transaction Id associated with response.aResult
- Result of a single emailFwd name.
-
EPPEmailFwdCheckResp
public EPPEmailFwdCheckResp(EPPTransId aTransId, java.util.Vector someResults)
EPPEmailFwdCheckResp
constructor that will set the result of multiple emailFwds.- Parameters:
aTransId
- Transaction Id associated with response.someResults
- Vector of EPPEmailFwdCheckResult instances.
-
-
Method Detail
-
getType
public java.lang.String getType()
Get the EPP response type associated withEPPEmailFwdCheckResp
.- Overrides:
getType
in classEPPResponse
- Returns:
- EPPEmailFwdCheckResp.ELM_NAME
-
getNamespace
public java.lang.String getNamespace()
Get the EPP command Namespace associated withEPPEmailFwdCheckResp
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Overrides:
getNamespace
in classEPPResponse
- Returns:
EPPEmailFwdMapFactory.NS
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPEmailFwdCheckResp
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
CloneEPPEmailFwdCheckResp
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPResponse
- Returns:
- clone of
EPPEmailFwdCheckResp
- 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 aEPPEmailFwdCheckResp
Response. There is oneEPPEmailFwdCheckResult
instance insomeResults
for each emailFwd requested in theEPPEmailFwdCheckCmd
Command.- Parameters:
someResults
- Vector ofEPPEmailFwdCheckResult
instances.
-
getCheckResults
public java.util.Vector getCheckResults()
Get the results of aEPPEmailFwdCheckResp
Response. There is oneEPPEmailFwdCheckResult
instance insomeResults
for each emailFwd requested in theEPPEmailFwdCheckResult
Command.- Returns:
- Vector of
EPPEmailFwdCheckResult
instances.
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPEmailFwdCheckResp
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
EPPEmailFwdCheckResp
instance. emailFwd - Throws:
EPPEncodeException
- Unable to encodeEPPEmailFwdCheckResp
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPEmailFwdCheckResp
attributes from the aElement DOM Element tree.- Overrides:
doDecode
in classEPPResponse
- Parameters:
aElement
- Root DOM Element to decodeEPPEmailFwdCheckResp
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
-