Package com.iizix.server.vsviewer
Class VSViewerTransactionProcessor
java.lang.Object
com.iizix.server.vsviewer.VSViewerTransactionProcessor
- All Implemented Interfaces:
ITransactionCreator
,ITransactionProcessor
,ITransactionSender
,IRootPropTransactionSender
public class VSViewerTransactionProcessor extends Object implements ITransactionProcessor, IRootPropTransactionSender
The TransactionProcessor contains all the code required to process transactions with the application being run for a single client reconnectable connection. If parallel client sessions is enabled or allowed, a single AppSessionGyro is shared.
- Author:
- Christopher Mindus
Method Summary
Modifier and TypeMethodDescriptionvoid
closeClient
(String msg) Sends an HTML message to be displayed on the client that will immediately close the connection.Creates a transaction with the configured write cache.getClientContextMenuReference
(UIContextMenu contextMenu) Gets the reference to use for a context menu.Gets the VS Viewer parameters.boolean
Verifies that the connection is established and not paused, reconnecting, etc.void
onConnection
(SessionTransMgr manager) Called when a connection is established.void
onDisposed
(SessionTransMgr manager) Called when a connection is disposed of.void
onPause
(SessionTransMgr manager) Called when a connection is paused.void
onReconnected
(SessionTransMgr manager) Called when a connection is reconnected.void
processTransaction
(SessionTransMgr manager, ReadTransaction trans) Process incoming transaction that itself can consist of several sub-transactions.void
sendTransaction
(SendTransaction trans) Sends the transaction to the remote party.void
showMessageInClient
(int severity, String heading, String msg) Sends an error message to be displayed on the client immediately.
Method Details
getVSViewerParams
Gets the VS Viewer parameters.onConnection
Called when a connection is established.- Specified by:
onConnection
in interfaceITransactionProcessor
onPause
Called when a connection is paused.- Specified by:
onPause
in interfaceITransactionProcessor
onReconnected
Called when a connection is reconnected.- Specified by:
onReconnected
in interfaceITransactionProcessor
onDisposed
Called when a connection is disposed of.- Specified by:
onDisposed
in interfaceITransactionProcessor
processTransaction
Process incoming transaction that itself can consist of several sub-transactions.Management transaction are not present here, but GConstants.TRANS_NEXT_SERIAL that should call
manager.onNextSerialTransaction();
.- Specified by:
processTransaction
in interfaceITransactionProcessor
- Parameters:
trans
- The transaction to process.
createTransaction
Creates a transaction with the configured write cache.- Specified by:
createTransaction
in interfaceITransactionCreator
- Returns:
- The new
Transaction
instance.
sendTransaction
Sends the transaction to the remote party.- Specified by:
sendTransaction
in interfaceIRootPropTransactionSender
- Specified by:
sendTransaction
in interfaceITransactionSender
- Parameters:
trans
- The transaction.
isConnected
public boolean isConnected()Verifies that the connection is established and not paused, reconnecting, etc.- Specified by:
isConnected
in interfaceIRootPropTransactionSender
- Returns:
- true if connected, false otherwise.
showMessageInClient
Sends an error message to be displayed on the client immediately.- Parameters:
severity
- The message severity (-1 none, 0=info, 1=warning, 2=error).heading
- The heading text.msg
- The message text.
closeClient
Sends an HTML message to be displayed on the client that will immediately close the connection.- Parameters:
msg
- The message text in HTML.
getClientContextMenuReference
Gets the reference to use for a context menu.- Specified by:
getClientContextMenuReference
in interfaceIRootPropTransactionSender
- Parameters:
contextMenu
- The context menu.- Returns:
- The reference to use, empty string for none (never null).