de.must.appletserver

Class SessionData

java.lang.Object

de.must.cst.SessionDataStd

de.must.appletserver.SessionData

All Implemented Interfaces:

ConnectionRecovery, DataObjectConstructionDetails, AppTextResource, BackendSessionResources, FrameworkTextResource, ImageResource, SessionResources

public class SessionData
extends SessionDataStd

Container to share data between Session and Remotables. Attributes to be shared are declared as public. Thus, they may be accessed as if they were in the respective class. (Since java doesn't provide a read-only pointer to an object, we found get/set formality useless here.) Contains methods to retrieve resources softly: Instead of throwing exceptions runtime errors are logged and the key is given back instead of the found resource. Session comprehensive data should be stored in de.must.middle.GlobalStd.

See Also:

GlobalStd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SessionData.ConditionalCallback
class	SessionData.Report
class	SessionData.ReportAsStream
class	SessionData.WordAccess

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	action
java.lang.String	actionSource
java.lang.String	appletCodebase
java.lang.String	clientVersion
java.lang.String	contextPath
ToAppletWriter	curOut
java.lang.String	currentConcerning The second level context criterion at server object construction time: @see Constants#SEARCH_LIST_DETAIL_GUI
java.lang.String	currentConcerningSubLevel The third level context criterion at server object construction time: @see Constants#SEARCH @see Constants#LIST @see Constants#DETAIL
java.lang.String	currentTitle The first level context criterion at server object construction time: the tab id or title of a window
EntitlementStd	entitlement
java.util.Vector<FileStreamTransfer>	fileStreamTransfers
java.lang.String	focusElementId
int	generalFontSizeToSet
int	generalFontSizeUsed
java.lang.String	generalUIFontNameToSet
IdManager	idManager
LoggedInUser	loggedInUser
boolean	logoutRequested
java.lang.String	loolAndFeelToSet
MustMenuBar	menuBar
java.lang.String	newHTMLDialog
java.util.Vector<SessionData.Report>	newReports
java.util.Vector<SessionData.WordAccess>	newWordAccess
java.util.Vector<java.lang.String>	nextOutputs
java.util.Hashtable<java.lang.String,HTMLDialog>	openHTMLDialogs
java.util.Vector<HalfDataComboBox>	outdatedContentComboBoxes
ParameterForUserStd	parameterForUser
java.util.Vector<ConversationMatter>	pendingInfosToPresent
java.util.HashMap<java.lang.String,FileOutputThread>	pendingOutput
java.util.HashMap<java.lang.String,StreamProvider>	pendingStreams
PopupMenu	popupMenu
GeneralizedRequest	request
java.util.Vector<ServerProcessControllerFrame>	serverProcessControllerFrames
java.lang.String	servletName
boolean	sessionInterfaceIsToBuild
protected java.util.ArrayList<java.lang.String>	tabIdsToBuild
java.lang.String	tabOrWinIdByApplet the tab ID/label or window id/title send by applet / identified by request.getParameter
java.lang.String	tempFolderName
boolean	terminationRequested
ProportionalListReportDirectly	threadToDo
MustToolBar	toolBar
int	transactionCounter
boolean	transformAmp
java.util.Vector<RemoteUserInterface>	windows

Fields inherited from class de.must.cst.SessionDataStd

language, locale

Constructor Summary

Constructors

Constructor and Description
SessionData() Constructs a new SessionData object.

Method Summary

Modifier and Type	Method and Description
void	add(FileStreamTransfer fileStreamTransfer)
void	add(ServerProcessControllerFrame serverProcessRunner)
void	addInfoToPresent(ConversationMatter matter) Adds a conversation matter to present remotely.
void	addOutdatedContentComboBox(HalfDataComboBox outdatedContentComboBox) Adds an out-dated content combo box to a queue for a former update of content and remote view.
void	addPendingStream(java.lang.String id, StreamProvider streamProvider)
void	addReportToPresent(java.lang.String reportFileName) Adds a report to present via temp folder.'
void	addRFIDEventListener(java.lang.String tabId, RFIDEventListener rfidEventListener, java.lang.String libraryID)
void	addTabIdToBuild(java.lang.String tabId) Adds a tab ID to the queue of tab IDs to build.
void	callIfTableContentHasBeenChanged(java.lang.String tableName, Callback callback)
void	clearRUIs() Clears buffer of the remote user interface mirror.
void	delegeteGlobalMessage(java.lang.String message) Delegates a message to the status label of the applets main window - suitable to inform about results of a process, e.g. a process which has been initialized by a parameter dialog, which is not available any more after execution.
boolean	deleteSessionTempDirIfExists()
java.lang.String	getAppResStr(java.lang.String resourceKey) Returns a text in the corresponding language according to the locale specific resource bundle.
java.sql.Connection	getConnection() Returns the connection to use.
ConnectionHolder	getConnectionHolder() Returns the connection holder to use.
RemoteUserInterface	getCurrentDialog()
IdManager	getIdManager() Returns the IdManager to use.
javax.swing.ImageIcon	getImageIcon(java.lang.String imageIconName) Returns an image loaded by name from typical images folder, e.g.
javax.swing.ImageIcon	getImageIconIndividual(java.lang.String imagePath) Returns image icons for path as specified - in opposite to getImageIcon, the image is searched absolutely respectively below current directory or the code base in case of applets.
InterruptibleProcessPool	getInterruptibleProcessPool()
RemoteUserInterface	getPreviousDialogToClose()
java.lang.String	getRealPath()
RFIDEventListener	getRFIDEventListener(java.lang.String tabId)
RemoteUserInterface	getRUI(java.lang.String tabId) Returns the server mirror of the remote user interface as specified.
java.lang.String	getSessionId()
java.lang.String	getSessionTempDir() Creates the session's temporary directory and returns it.
java.lang.String	getTempDirForClient()
java.lang.String	getTopLevelMessage() Returns the top level message.
java.lang.String	getUserName() Returns the name of the logged in user or "" if no user is logged in.
boolean	hasGotWordAPI()
void	iChangendTableContent(java.lang.String tableName)
boolean	isRunningInApplet()
void	register(RemoteUserInterface rui)
void	remove(FileStreamTransfer fileStreamTransfer)
void	remove(ServerProcessControllerFrame serverProcessRunner)
void	removeAll()
void	removeDataTableAdministration(DataTableAdministration table)
void	removeRFIDEventListener(java.lang.String tabId)
void	removeTab(java.lang.String tabId) Sends a command to the client to remove the tab as specified.
void	removeUserInterface(java.lang.String tabId) Removes the server mirror of the remote user interface.
void	resetTopLevelMessage() Resets the top level message, which is a good idea after sending it the applet.
void	setConnection(ConnectionHolder connection)
void	setCurrentDialog(RemoteUserInterface currentDialog)
void	setPreviousDialogToClose(RemoteUserInterface previousDialogToClose)
void	setRealPath(java.lang.String realPath)
void	setRFIDReadingSuspended(boolean rfidReadingSuspended)
protected void	setSessionId(java.lang.String sessionId)
void	writeItemId(java.lang.String label, java.lang.String medArtKb, java.lang.String libraryID)

Methods inherited from class de.must.cst.SessionDataStd

getFrameworkResourceString, getLanguage, getLocale, setLanguage, setLocale

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.must.dataobj.ConnectionRecovery

recover

Field Detail

clientVersion

public java.lang.String clientVersion

loolAndFeelToSet

public java.lang.String loolAndFeelToSet

generalUIFontNameToSet

public java.lang.String generalUIFontNameToSet

generalFontSizeToSet

public int generalFontSizeToSet

generalFontSizeUsed

public int generalFontSizeUsed

sessionInterfaceIsToBuild

public boolean sessionInterfaceIsToBuild

windows

public java.util.Vector<RemoteUserInterface> windows

fileStreamTransfers

public java.util.Vector<FileStreamTransfer> fileStreamTransfers

serverProcessControllerFrames

public java.util.Vector<ServerProcessControllerFrame> serverProcessControllerFrames

threadToDo

public ProportionalListReportDirectly threadToDo

tabOrWinIdByApplet

public java.lang.String tabOrWinIdByApplet

the tab ID/label or window id/title send by applet / identified by request.getParameter

tabIdsToBuild

protected java.util.ArrayList<java.lang.String> tabIdsToBuild

outdatedContentComboBoxes

public java.util.Vector<HalfDataComboBox> outdatedContentComboBoxes

newReports

public java.util.Vector<SessionData.Report> newReports

pendingOutput

public java.util.HashMap<java.lang.String,FileOutputThread> pendingOutput

pendingStreams

public java.util.HashMap<java.lang.String,StreamProvider> pendingStreams

newWordAccess

public java.util.Vector<SessionData.WordAccess> newWordAccess

pendingInfosToPresent

public java.util.Vector<ConversationMatter> pendingInfosToPresent

openHTMLDialogs

public java.util.Hashtable<java.lang.String,HTMLDialog> openHTMLDialogs

newHTMLDialog

public java.lang.String newHTMLDialog

transactionCounter

public int transactionCounter

idManager

public IdManager idManager

loggedInUser

public LoggedInUser loggedInUser

parameterForUser

public ParameterForUserStd parameterForUser

transformAmp

public boolean transformAmp

appletCodebase

public java.lang.String appletCodebase

servletName

public java.lang.String servletName

tempFolderName

public java.lang.String tempFolderName

action

public java.lang.String action

actionSource

public java.lang.String actionSource

focusElementId

public java.lang.String focusElementId

contextPath

public java.lang.String contextPath

entitlement

public EntitlementStd entitlement

menuBar

public MustMenuBar menuBar

toolBar

public MustToolBar toolBar

popupMenu

public PopupMenu popupMenu

request

public GeneralizedRequest request

nextOutputs

public java.util.Vector<java.lang.String> nextOutputs

logoutRequested

public boolean logoutRequested

terminationRequested

public boolean terminationRequested

curOut

public ToAppletWriter curOut

currentTitle

public java.lang.String currentTitle

The first level context criterion at server object construction time: the tab id or title of a window

currentConcerning

public java.lang.String currentConcerning

The second level context criterion at server object construction time: @see Constants#SEARCH_LIST_DETAIL_GUI

currentConcerningSubLevel

public java.lang.String currentConcerningSubLevel

The third level context criterion at server object construction time: @see Constants#SEARCH @see Constants#LIST @see Constants#DETAIL

Constructor Detail

SessionData

public SessionData()

Constructs a new SessionData object.

Method Detail

isRunningInApplet

public boolean isRunningInApplet()

addTabIdToBuild

public void addTabIdToBuild(java.lang.String tabId)

Adds a tab ID to the queue of tab IDs to build. Duplicate will be avoided. Also useful if dialog consequence should trigger some refresh, e.g. a list refresh

Parameters:

tabId - the ID of the tab to build

See Also:

DialogConsequence

add

public void add(FileStreamTransfer fileStreamTransfer)

remove

public void remove(FileStreamTransfer fileStreamTransfer)

add

public void add(ServerProcessControllerFrame serverProcessRunner)

remove

public void remove(ServerProcessControllerFrame serverProcessRunner)

register

public void register(RemoteUserInterface rui)

removeDataTableAdministration

public void removeDataTableAdministration(DataTableAdministration table)

removeAll

public void removeAll()

addOutdatedContentComboBox

public void addOutdatedContentComboBox(HalfDataComboBox outdatedContentComboBox)

Adds an out-dated content combo box to a queue for a former update of content and remote view.

Parameters:

outdatedContentComboBox - the combo box which is out of date because anyone modified content by adding, changing or removing items

addPendingStream

public void addPendingStream(java.lang.String id,
                             StreamProvider streamProvider)

delegeteGlobalMessage

public void delegeteGlobalMessage(java.lang.String message)

Delegates a message to the status label of the applets main window - suitable to inform about results of a process, e.g. a process which has been initialized by a parameter dialog, which is not available any more after execution.

Parameters:

message - the message to be presented in the status label of the applets main window

getTopLevelMessage

public java.lang.String getTopLevelMessage()

Returns the top level message.

Returns:

the top level message

resetTopLevelMessage

public void resetTopLevelMessage()

Resets the top level message, which is a good idea after sending it the applet.

addInfoToPresent

public void addInfoToPresent(ConversationMatter matter)

Adds a conversation matter to present remotely.

Parameters:

matter - the conversation matter to present

addReportToPresent

public void addReportToPresent(java.lang.String reportFileName)

Adds a report to present via temp folder.'

Parameters:

reportFileName -

setRealPath

public void setRealPath(java.lang.String realPath)

getRealPath

public java.lang.String getRealPath()

setSessionId

protected void setSessionId(java.lang.String sessionId)

getSessionId

public java.lang.String getSessionId()

getSessionTempDir

public java.lang.String getSessionTempDir()

Creates the session's temporary directory and returns it.

Returns:

the session's temporary directory

deleteSessionTempDirIfExists

public boolean deleteSessionTempDirIfExists()

getTempDirForClient

public java.lang.String getTempDirForClient()

hasGotWordAPI

public boolean hasGotWordAPI()

setConnection

public void setConnection(ConnectionHolder connection)

getConnection

public java.sql.Connection getConnection()

Returns the connection to use.

Returns:

the connection to use

getConnectionHolder

public ConnectionHolder getConnectionHolder()

Returns the connection holder to use.

Returns:

the connection holder to use

getIdManager

public IdManager getIdManager()

Returns the IdManager to use.

Returns:

the IdManager to use

getUserName

public java.lang.String getUserName()

Description copied from interface: BackendSessionResources

Returns the name of the logged in user or "" if no user is logged in.

Returns:

the name of the logged in user or "" if no user is logged in

setCurrentDialog

public void setCurrentDialog(RemoteUserInterface currentDialog)

getCurrentDialog

public RemoteUserInterface getCurrentDialog()

setPreviousDialogToClose

public void setPreviousDialogToClose(RemoteUserInterface previousDialogToClose)

getPreviousDialogToClose

public RemoteUserInterface getPreviousDialogToClose()

callIfTableContentHasBeenChanged

public void callIfTableContentHasBeenChanged(java.lang.String tableName,
                                             Callback callback)

iChangendTableContent

public void iChangendTableContent(java.lang.String tableName)

addRFIDEventListener

public void addRFIDEventListener(java.lang.String tabId,
                                 RFIDEventListener rfidEventListener,
                                 java.lang.String libraryID)

removeRFIDEventListener

public void removeRFIDEventListener(java.lang.String tabId)

getRFIDEventListener

public RFIDEventListener getRFIDEventListener(java.lang.String tabId)

writeItemId

public void writeItemId(java.lang.String label,
                        java.lang.String medArtKb,
                        java.lang.String libraryID)

setRFIDReadingSuspended

public void setRFIDReadingSuspended(boolean rfidReadingSuspended)

getAppResStr

public java.lang.String getAppResStr(java.lang.String resourceKey)

Description copied from interface: AppTextResource

Returns a text in the corresponding language according to the locale specific resource bundle.

Parameters:

resourceKey - the key of the resource to retrieve

Returns:

a text in the corresponding language according to the locale specific resource bundle

getImageIcon

public javax.swing.ImageIcon getImageIcon(java.lang.String imageIconName)

Description copied from interface: ImageResource

Returns an image loaded by name from typical images folder, e.g. /bin/images.

Parameters:

imageIconName - the name of image icon to load

Returns:

the loaded image

getImageIconIndividual

public javax.swing.ImageIcon getImageIconIndividual(java.lang.String imagePath)

Description copied from interface: ImageResource

Returns image icons for path as specified - in opposite to getImageIcon, the image is searched absolutely respectively below current directory or the code base in case of applets.

Parameters:

imagePath - the path of the image file to be loaded

Returns:

the image icon

getInterruptibleProcessPool

public InterruptibleProcessPool getInterruptibleProcessPool()

getRUI

public RemoteUserInterface getRUI(java.lang.String tabId)

Returns the server mirror of the remote user interface as specified.

Parameters:

tabId - the ID of the user interface to return

Returns:

the server mirror of the remote user interface as specified

removeUserInterface

public void removeUserInterface(java.lang.String tabId)

Removes the server mirror of the remote user interface.

Parameters:

tabId - the ID of the user interface to remove

removeTab

public void removeTab(java.lang.String tabId)

Sends a command to the client to remove the tab as specified.

Parameters:

tabId - the ID of the tab to remove

clearRUIs

public void clearRUIs()

Clears buffer of the remote user interface mirror.