se.entra.phantom.rapp

Class RAPPTransaction

java.lang.Object

se.entra.phantom.rapp.RAPPTransaction

public final class RAPPTransaction
extends Object

This class is a helper to handle creation of the XML request for the Remote Application interface.

It creates the XML framework and provides methods to add the actions to process for the transaction at both the "client" and the server side.

It can instantiate the complete tree of RAPPnnn classes from an XML document as well as to serialize itself to an XML document.

The RAPPTransaction instance is a list of actions that the "client" wishes the server application to execute. These actions are well specified using the classes:

• RAPPGlobVar
• RAPPCallObject
• RAPPCallHost
• RAPPCallClass

These classes in turn can contain a list of "elements", i.e. other RAPP-classes (that might in their turn have lists of classes, etc).

For a detailed description of the classes above, see the corresponding class.

See Also:

RemoteTransaction, RAPPGlobVar, RAPPCallObject, RAPPCallHost, RAPPCallClass

Field Summary

Fields

Modifier and Type	Field and Description
static int	CURRENT_VERSION The current version of the document transaction.
static boolean	generateComments This static variable indicates if XML comment generation for the transactions should be on or off.

Constructor Summary

Constructors

Constructor and Description
RAPPTransaction() Creates an empty request used to programmatically add actions for a request transaction.

Method Summary

Modifier and Type	Method and Description
void	addAction(RAPPAction action) Adds an action to the transaction.
void	addFinalAction(RAPPAction action) Adds a final action to the transaction.
static void	addNameSpaceItem(RAPPNameSpaceItem nameSpaceItem) Add namespace to static hashtable.
Document	createDocument(boolean doRequest, boolean doReply) Creates the XML document request and/or reply from all RAPP actions depending on the flags.
Document	createDocumentReply(boolean keepRequest) Creates the XML document reply from all RAPP actions.
Document	createDocumentRequest() Creates the XML document request from all RAPP actions.
Element	createElement(String name) Creates an Element to be used by callClass requests and replies.
void	createFromDocument(Document doc) Reinitializes this transaction to create the RAPP instance structure from an XML document from scratch.
static RAPPNameSpaceItem	createNameSpaceItem(Class<?> owner, String partURI, String prefix) Create namespace item.
RAPPAction	getAction(int index) Gets an action from an index.
int	getActionCount() Gets the current action count.
RAPPAction	getFinalAction(int index) Gets a final action from an index.
int	getFinalActionCount() Gets the current final action count.
String	toString() Converts this class into a string for testing purposes.
void	updateDocumentReply(boolean keepRequest) Updates the document that was used to initialize this class from the method createFromXML.
void	updateReplyFromDocument(Document doc) Updates this transaction instance with the reply from the document.

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_VERSION

public static final int CURRENT_VERSION

The current version of the document transaction. Any receiver of an XML document with an earlier version SHOULD be adaptive, i.e. be able to handle it. If e.g. the server receives an earlier version, the document sent back should have the same structure and version number as sent to it. If this is not feasible, the version should not be accepted.

The version has the format YYYYMM when the document structure was finally fixed.

The current version is 200209.

See Also:

Constant Field Values

generateComments

public static boolean generateComments

This static variable indicates if XML comment generation for the transactions should be on or off. Default is off.

Constructor Detail

RAPPTransaction

public RAPPTransaction()

Creates an empty request used to programmatically add actions for a request transaction. It is also used for recreation of the RAPP instance structure from an XML document.

Method Detail

createNameSpaceItem

public static RAPPNameSpaceItem createNameSpaceItem(Class<?> owner,
                                                    String partURI,
                                                    String prefix)

Create namespace item.

addNameSpaceItem

public static void addNameSpaceItem(RAPPNameSpaceItem nameSpaceItem)

Add namespace to static hashtable.

addAction

public void addAction(RAPPAction action)

Adds an action to the transaction.

addFinalAction

public void addFinalAction(RAPPAction action)

Adds a final action to the transaction.

getActionCount

public int getActionCount()

Gets the current action count.

getFinalActionCount

public int getFinalActionCount()

Gets the current final action count.

getAction

public RAPPAction getAction(int index)

Gets an action from an index. The method could throw an ArrayIndexOutOfBoundsException if the index is incorrect.

getFinalAction

public RAPPAction getFinalAction(int index)

Gets a final action from an index. The method could throw an ArrayIndexOutOfBoundsException if the index is incorrect.

createElement

public final Element createElement(String name)

Creates an Element to be used by callClass requests and replies. The Element is not added to the document until it is serialized to XML.

createDocumentRequest

public Document createDocumentRequest()

Creates the XML document request from all RAPP actions.

createDocumentReply

public Document createDocumentReply(boolean keepRequest)

Creates the XML document reply from all RAPP actions.

The flag keepRequest indicates if the request data should be kept in the document reply or not. This flag can be false to preserve e.g. the network bandwidth.

createDocument

public Document createDocument(boolean doRequest,
                               boolean doReply)

Creates the XML document request and/or reply from all RAPP actions depending on the flags.

This method is public only because of testing purposes.

createFromDocument

public void createFromDocument(Document doc)
                        throws SAXException

Reinitializes this transaction to create the RAPP instance structure from an XML document from scratch.

Throws:

SAXException - for errors in the document.

updateDocumentReply

public void updateDocumentReply(boolean keepRequest)

Updates the document that was used to initialize this class from the method createFromXML. This is used in the server to send back the same - but updated - document.

The flag keepRequest is used to keep the reply elements or if they should be removed. E.g. network bandwidth might be improved if this flag is false.

updateReplyFromDocument

public void updateReplyFromDocument(Document doc)
                             throws SAXException

Updates this transaction instance with the reply from the document. This is only possible if the original instance of the transaction matches the request in the document.

In other words, do NOT use this method for sessions that are disconnected and the same Java VM is not running the same instance of the original RAPPTransaction.

If this is not the case, an exception is thrown.

This is the most efficient way for a "permanent" connection to a server to retrieve the data.

During processing of this method, the reply values or the extending RAPPAction classes are modified in a thread-unsafe way. Thus, when calling this method, do not access reply data in the action classes.

Throws:

SAXException - for errors in the document.

toString

public String toString()

Converts this class into a string for testing purposes.

Overrides:

toString in class Object