com.neulevel.epp.core.response
Class EppResponse

java.lang.Object
  com.neulevel.epp.core.EppEntity
      com.neulevel.epp.core.response.EppResponse

public class EppResponse
extends EppEntity

This EppResponse class implements EPP Response entity.

Version:

$Revision: 1.2 $ $Date: 2006/03/01 01:35:38 $

Author:

Ning Zhang ning.zhang@neustar.com

Constructor Summary

EppResponse()

Method Summary

void	addExtension(org.w3c.dom.Element ext) Adds an optional extension object
void	addExtension(EppExtension ext) Adds an optional extension object
void	addResult(EppResult result) Adds a result object
static EppEntity	fromXML(org.w3c.dom.Node root) Converts an XML element into an EppResponse object.
java.util.Vector	getExtension() Gets the list of extension objects, either EppUnspec, or DOM Element
java.lang.String	getMessageId() Gets the id of the message polled from the message queue.
int	getMessageQueued() Gets number of messages queued
java.util.Calendar	getMessageQueueUpdated() Gets the timestamp of the message queue updated by the server
java.lang.String	getMessageText() Gets the text of the message polled from the message queue.
EppResponseData	getResponseData() Gets response data
java.util.Vector	getResult() Gets result
EppTransactionId	getTransactionId() Gets transaction id from the registrar client
EppUnspec	getUnspec() Gets optional unspecified object - for backward compatibility
void	setMessageId(java.lang.String id) Sets the id of the message polled from the message queue.
void	setMessageQueued(int number) Sets number of messages queued
void	setMessageQueueUpdated(java.util.Calendar cal) Sets the timestamp of the message queue updated by the server
void	setMessageText(java.lang.String msg) Sets the text of the message polled from the message queue.
void	setResponseData(EppResponseData data) Sets response data
void	setTransactionId(EppTransactionId xid) Sets transaction id
void	setUnspec(EppUnspec unspec) Sets optional unspecified object - for backward compatibility
boolean	success() Checks if the EPP Response is for a completed operation without any error
java.lang.String	toString()
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc, java.lang.String tag) Converts the EppResponse object into an XML element

Methods inherited from class com.neulevel.epp.core.EppEntity

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EppResponse

public EppResponse()

Method Detail

getResult

public java.util.Vector getResult()

Gets result

addResult

public void addResult(EppResult result)

Adds a result object

getMessageId

public java.lang.String getMessageId()

Gets the id of the message polled from the message queue.

This is the replacement of EppResultMessage.getId() in EPP-04

Since:

EPP-1.0

setMessageId

public void setMessageId(java.lang.String id)

Sets the id of the message polled from the message queue.

This is the replacement of EppResultMessage.setId() in EPP-04

Since:

EPP-1.0

getMessageText

public java.lang.String getMessageText()

Gets the text of the message polled from the message queue.

Since:

EPP-1.0

setMessageText

public void setMessageText(java.lang.String msg)

Sets the text of the message polled from the message queue.

Since:

EPP-1.0

getMessageQueued

public int getMessageQueued()

Gets number of messages queued

setMessageQueued

public void setMessageQueued(int number)

Sets number of messages queued

getMessageQueueUpdated

public java.util.Calendar getMessageQueueUpdated()

Gets the timestamp of the message queue updated by the server

setMessageQueueUpdated

public void setMessageQueueUpdated(java.util.Calendar cal)

Sets the timestamp of the message queue updated by the server

getResponseData

public EppResponseData getResponseData()

Gets response data

setResponseData

public void setResponseData(EppResponseData data)

Sets response data

getUnspec

public EppUnspec getUnspec()

Gets optional unspecified object - for backward compatibility

setUnspec

public void setUnspec(EppUnspec unspec)

Sets optional unspecified object - for backward compatibility

getExtension

public java.util.Vector getExtension()

Gets the list of extension objects, either EppUnspec, or DOM Element

addExtension

public void addExtension(EppExtension ext)

Adds an optional extension object

addExtension

public void addExtension(org.w3c.dom.Element ext)

Adds an optional extension object

getTransactionId

public EppTransactionId getTransactionId()

Gets transaction id from the registrar client

setTransactionId

public void setTransactionId(EppTransactionId xid)

Sets transaction id

success

public boolean success()

Checks if the EPP Response is for a completed operation without any error

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc,
                                 java.lang.String tag)

Converts the EppResponse object into an XML element

Specified by:

toXML in class EppEntity

Parameters:

doc - the XML Document object

tag - the tag/element name for the EppResponse object

Returns:

an Element object

fromXML

public static EppEntity fromXML(org.w3c.dom.Node root)

Converts an XML element into an EppResponse object. The caller of this method must make sure that the root node is of the EPP responseType.

Parameters:

root - root node for an EppResponse object in XML format

Returns:

an EppResponse object, or null if the node is invalid

toString

public java.lang.String toString()

Specified by:

toString in class EppEntity