SessionData (Cameleon OSP Specification)

java.lang.Object
- de.must.markup.SessionData

All Implemented Interfaces:

DataObjectConstructionDetails
```
public class SessionData
extends java.lang.Object
implements DataObjectConstructionDetails
```
Container to share data between Session and Invokables. 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

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`actionForPost`
`int`	`activityNbr`
`java.lang.String`	`afterLoginJspName`
`java.lang.String`	`applicationTitle`
`java.lang.Class<? extends Invokable>`	`classToInvokeNext`
`java.lang.String`	`contextPath`
`int`	`dialogNbr`
`EntitlementStd`	`entitlement`
`GlobalStd`	`global`
`IdManager`	`idManager`
`java.lang.String`	`imageDirectory`
`JspSessionStd`	`jspSession`
`JspButler`	`lastProvidedButler`
`JspButler`	`lastRedirectingButler`
`Layout`	`layout`
`java.util.Locale`	`locale`
`LoggedInUser`	`loggedInUser`
`java.lang.String`	`loginJspName`
`MustMenuBar`	`menuBar`
`java.lang.String`	`messageForNextDialog`
`java.lang.String`	`realpath`
`GeneralizedRequest`	`request`
`boolean`	`sessionClosingRequested`
`SessionDataAddOn`	`sessionDataAddOn`
`java.lang.String`	`sessionId`
`int`	`stackPointer`
`MustToolBar`	`toolBar`
`boolean`	`transformAmp`
`java.lang.String`	`urlToBePresentedInNewWindowNextDialog`
`java.lang.String`	`userAgent`

Constructor Summary

Constructors
Constructor and Description
`SessionData()` Constructs a new SessionData object.
`SessionData(JspSessionStd jspSession)` Constructs a new SessionData object with reference to a JSP session.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`forceLocale(java.util.Locale locale)` Forces the locale to be provided as specified, no matter where the session is initialized from
`java.lang.String`	`getBaseURL()` Returns the base URL, which includes post action plus session identifier.
`java.sql.Connection`	`getConnection()` Returns the connection to use.
`ConnectionHolder`	`getConnectionHolder()` Returns the connection holder to use.
`java.lang.String`	`getCurrentURI(int windowNbr)` Returns the current URI.
`java.lang.String`	`getFrameworkResourceString(java.lang.String resourceKey)` Returns the framework resource of the specified key, which has to be a string.
`IdManager`	`getIdManager()` Returns the IdManager to use.
`java.lang.String`	`getImageDirectory()` Returns the image directory.
`java.lang.String`	`getPreviousURI(int windowNbr)` Returns the previous URI.
`java.lang.String`	`getRequestIP()`
`java.lang.String`	`getRequestIP(HttpServletRequest request)`
`java.lang.String`	`getResourceString(java.lang.String resourceKey)` Returns the individual application resource of the specified key, which has to be a string.
`java.lang.String`	`getUserName()` Returns the name of the logged in user or "" if no user is logged in.
`boolean`	`isMobile()`
`void`	`setConnection(ConnectionHolder connection)`
`protected void`	`setCurrentURI(java.lang.String currentURI, int windowNbr)` Method sets the current URI.
`protected void`	`setPreviousURI(java.lang.String previousURI, int windowNbr)` Sets the previous URI.
`void`	`setResourceBundle(java.util.ResourceBundle resourceBundle)` Sets the session's resource bundle.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - userAgent
```
public java.lang.String userAgent
```
  - dialogNbr
```
public int dialogNbr
```
  - global
```
public GlobalStd global
```
  - locale
```
public java.util.Locale locale
```
  - idManager
```
public IdManager idManager
```
  - loggedInUser
```
public LoggedInUser loggedInUser
```
  - transformAmp
```
public boolean transformAmp
```
  - actionForPost
```
public java.lang.String actionForPost
```
  - sessionId
```
public java.lang.String sessionId
```
  - contextPath
```
public java.lang.String contextPath
```
  - entitlement
```
public EntitlementStd entitlement
```
  - applicationTitle
```
public java.lang.String applicationTitle
```
  - menuBar
```
public MustMenuBar menuBar
```
  - toolBar
```
public MustToolBar toolBar
```
  - imageDirectory
```
public java.lang.String imageDirectory
```
  - classToInvokeNext
```
public java.lang.Class<? extends Invokable> classToInvokeNext
```
  - stackPointer
```
public int stackPointer
```
  - activityNbr
```
public int activityNbr
```
  - layout
```
public Layout layout
```
  - messageForNextDialog
```
public java.lang.String messageForNextDialog
```
  - urlToBePresentedInNewWindowNextDialog
```
public java.lang.String urlToBePresentedInNewWindowNextDialog
```
  - sessionClosingRequested
```
public boolean sessionClosingRequested
```
  - request
```
public GeneralizedRequest request
```
  - realpath
```
public java.lang.String realpath
```
  - jspSession
```
public JspSessionStd jspSession
```
  - lastRedirectingButler
```
public JspButler lastRedirectingButler
```
  - lastProvidedButler
```
public JspButler lastProvidedButler
```
  - loginJspName
```
public java.lang.String loginJspName
```
  - afterLoginJspName
```
public java.lang.String afterLoginJspName
```
  - sessionDataAddOn
```
public SessionDataAddOn sessionDataAddOn
```
- Constructor Detail
  - SessionData
```
public SessionData()
```
    Constructs a new SessionData object.
  - SessionData
```
public SessionData(JspSessionStd jspSession)
```
    Constructs a new SessionData object with reference to a JSP session.
- Method Detail
  - getBaseURL
```
public java.lang.String getBaseURL()
```
    Returns the base URL, which includes post action plus session identifier.
    
    Returns:
    
    the base URL
  - getImageDirectory
```
public java.lang.String getImageDirectory()
```
    Returns the image directory.
    
    Returns:
    
    the image directory
  - isMobile
```
public boolean isMobile()
```
  - setResourceBundle
```
public void setResourceBundle(java.util.ResourceBundle resourceBundle)
```
    Sets the session's resource bundle.
    
    Parameters:
    
    resourceBundle - the session's resource bundle
  - getResourceString
```
public java.lang.String getResourceString(java.lang.String resourceKey)
```
    Returns the individual application resource of the specified key, which has to be a string.
    
    Parameters:
    
    resourceKey - the key of the resource to retrieve
    
    Returns:
    
    the found resource
  - getFrameworkResourceString
```
public java.lang.String getFrameworkResourceString(java.lang.String resourceKey)
```
    Returns the framework resource of the specified key, which has to be a string.
    
    Parameters:
    
    resourceKey - the key of the resource to retrieve
    
    Returns:
    
    the found resource
  - forceLocale
```
public void forceLocale(java.util.Locale locale)
```
    Forces the locale to be provided as specified, no matter where the session is initialized from
    
    Parameters:
    
    locale - the forced locale
  - setConnection
```
public void setConnection(ConnectionHolder connection)
```
  - getConnection
```
public java.sql.Connection getConnection()
```
    Returns the connection to use.
    
    Specified by:
    
    getConnection in interface DataObjectConstructionDetails
    
    Returns:
    
    the connection to use
  - getConnectionHolder
```
public ConnectionHolder getConnectionHolder()
```
    Returns the connection holder to use.
    
    Returns:
    
    the connection holder to use
  - setCurrentURI
```
protected void setCurrentURI(java.lang.String currentURI,
                             int windowNbr)
```
    Method sets the current URI.
    
    Parameters:
    
    currentURI - the current URI to set
    
    windowNbr - the number of the relevant window (window separating must be true)
  - getCurrentURI
```
public java.lang.String getCurrentURI(int windowNbr)
```
    Returns the current URI.
    
    Parameters:
    
    windowNbr - the number of the relevant window (window separating must be true)
    
    Returns:
    
    the current URI
  - setPreviousURI
```
protected void setPreviousURI(java.lang.String previousURI,
                              int windowNbr)
```
    Sets the previous URI.
    
    Parameters:
    
    previousURI - the previous URI to set
    
    windowNbr - the number of the relevant window (window separating must be true)
  - getPreviousURI
```
public java.lang.String getPreviousURI(int windowNbr)
```
    Returns the previous URI.
    
    Parameters:
    
    windowNbr - the number of the relevant window (window separating must be true)
    
    Returns:
    
    the previous URI
  - getIdManager
```
public IdManager getIdManager()
```
    Returns the IdManager to use.
    
    Specified by:
    
    getIdManager in interface DataObjectConstructionDetails
    
    Returns:
    
    the IdManager to use
  - getUserName
```
public java.lang.String getUserName()
```
    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
  - getRequestIP
```
public java.lang.String getRequestIP()
```
  - getRequestIP
```
public java.lang.String getRequestIP(HttpServletRequest request)
```

Class SessionData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

userAgent

dialogNbr

global

locale

idManager

loggedInUser

transformAmp

actionForPost

sessionId

contextPath

entitlement

applicationTitle

menuBar

toolBar

imageDirectory

classToInvokeNext

stackPointer

activityNbr

layout

messageForNextDialog

urlToBePresentedInNewWindowNextDialog

sessionClosingRequested

request

realpath

jspSession

lastRedirectingButler

lastProvidedButler

loginJspName

afterLoginJspName

sessionDataAddOn

Constructor Detail

SessionData

SessionData

Method Detail

getBaseURL

getImageDirectory

isMobile

setResourceBundle

getResourceString

getFrameworkResourceString

forceLocale

setConnection

getConnection

getConnectionHolder

setCurrentURI

getCurrentURI

setPreviousURI

getPreviousURI

getIdManager

getUserName

getRequestIP

getRequestIP