se.entra.phantom.rapp

Class RemoteTransaction

java.lang.Object

se.entra.phantom.rapp.RemoteTransaction

public final class RemoteTransaction
extends Object

Use an instance of this class to send and receive transactions over the Remote Application interface.

Request/reply transactions are stored in an XML document, allowing a flexible application interaction. See the class se.entra.phantom.server.DefaultRemoteApplication for the definition of the XML document format.

This class also supports sending all transaction strings and characters as unicode strings. If this is required, call the method setUnicodeTransactions. This should normally not be needed as transactions are checked for correct code page, but is supported here for compatibility with the Server.

See Also:

RemoteApplication, SSLRemoteApplication, DefaultRemoteApplication

Constructor Summary

Constructors

Constructor and Description
RemoteTransaction() Create a new instance of the class.
RemoteTransaction(RAPPTransaction transaction) Creates a new transaction instance for a Request for the Remote Application in a RAPPTransaction instance.

Method Summary

Modifier and Type	Method and Description
static String	documentToString(Document document) Converts a Document to String (in XML).
Document	getDocument() Gets the contents of this transaction as an XML Document.
RAPPTransaction	getTransaction() Creates a complete new instance of RAPPTransaction from the XML document contents received from the server.
void	setContents(Document document) Sets the contents of the transaction as a String.
void	setContents(String xmlString) Sets the contents of the transaction as a String.
void	setRequest(RAPPTransaction transaction) Sets the request contents of the transaction.
static Document	stringToDocument(String xmlDocument) Converts a String (in XML) to a Document.
String	toString() Gets the contents of this transaction as an XML String.
void	updateTransaction(RAPPTransaction transaction) Updates the RAPPTransaction instance with the XML document contents received from the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteTransaction

public RemoteTransaction()

Create a new instance of the class. Never reuse an instance for several messages (i.e. you have to create new instances for each request/reply.

RemoteTransaction

public RemoteTransaction(RAPPTransaction transaction)
                  throws IOException

Creates a new transaction instance for a Request for the Remote Application in a RAPPTransaction instance.

Note: This method DOES NOT serialize reply data to the Document.

Throws:

IOException - for errors in the StringWriter used when streaming the Document as a stream.

Method Detail

setContents

public final void setContents(String xmlString)

Sets the contents of the transaction as a String. This string must be a valid XML document.

setContents

public final void setContents(Document document)
                       throws IOException

Sets the contents of the transaction as a String. This string must be a valid XML document.

Throws:

IOException - for errors in the StringWriter used when streaming the Document as a stream.

setRequest

public final void setRequest(RAPPTransaction transaction)
                      throws IOException

Sets the request contents of the transaction. This method is used by the Remote Application to initialize the transaction with a request from a RAPPTransaction instance.

Note: This method DOES NOT serialize reply data to the Document.

Throws:

IOException - for errors in the StringWriter used when streaming the Document as a stream.

documentToString

public static final String documentToString(Document document)
                                     throws IOException

Converts a Document to String (in XML).

Throws:

IOException - for errors in the StringWriter used when streaming the Document as a stream.

stringToDocument

public static final Document stringToDocument(String xmlDocument)
                                       throws IOException,
                                              SAXException

Converts a String (in XML) to a Document.

Returns:

Document, the converted String as an XML Document.

Throws:

IOException - for errors in the StringReader used when parsing the xmlDocument as a stream.

SAXException - for errors in parsing the xmlDocument to a org.w3c.dom.Document.

toString

public final String toString()

Gets the contents of this transaction as an XML String.

If no document contents has been set by a previous call to setContents, a NullPointerException is thrown.

Overrides:

toString in class Object

getDocument

public final Document getDocument()
                           throws IOException,
                                  SAXException

Gets the contents of this transaction as an XML Document.

In this implementation, this method converts the reply from toString and then converts this String to a Document for each call.

If no document contents has been set by a previous call to setContents, a NullPointerException is thrown.

Returns:

Document, the transaction as an XML Document.

Throws:

IOException - for errors in the StringReader used when parsing the xmlDocument as a stream.

SAXException - for errors in parsing the xmlDocument to a org.w3c.dom.Document.

updateTransaction

public final void updateTransaction(RAPPTransaction transaction)
                             throws IOException,
                                    SAXException

Updates the RAPPTransaction instance with the XML document contents received from the server.

This method should be used for a non-disconnect session when the instance of the request transaction is still instantiated in a variable in the Remote Application.

Throws:

IOException - for errors in the StringReader used when parsing the xmlDocument as a stream.

SAXException - for errors in parsing the xmlDocument to a org.w3c.dom.Document.

See Also:

RAPPTransaction.updateReplyFromDocument(org.w3c.dom.Document)

getTransaction

public final RAPPTransaction getTransaction()
                                     throws IOException,
                                            SAXException

Creates a complete new instance of RAPPTransaction from the XML document contents received from the server.

This method is used for sessions that drop the connection and does not have the instance variable for the initial request transaction.

The transaction created by this method must then be traversed by the caller in order to extract the action replies.

Throws:

IOException - for errors in the StringReader used when parsing the xmlDocument as a stream.

SAXException - for errors in parsing the xmlDocument to a org.w3c.dom.Document.

See Also:

RAPPTransaction.getAction(int), RAPPTransaction.getFinalAction(int), RAPPTransaction.getActionCount(), RAPPTransaction.getFinalActionCount(), RAPPTransaction.createFromDocument(org.w3c.dom.Document)