SessionManager


This type is a class for model objects.

Configuration for session support in the Web container. When configuring the Session Manager, you can specify: ?Whether to enable sessions ?How to convey session IDs to servlets (cookies or URL rewriting) ?AE: Whether to save session data in a database during execution (persistent sessions) ?Whether to add session IDs to URLs in transition from HTTP to HTTPS and back (protocol switch rewriting)

.

Package: webcontainer
Supertype: Service

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Reference attributes having this type:
  ApplicationConfig.sessionManagement
  WebModuleConfig.sessionManagement



Attributes Summary
enableUrlRewriting : EBoolean Specifies whether the Session Manager uses rewritten URLs to carry the session IDs. If URL rewriting is enabled, the Session Manager recognizes session IDs that arrive in the URL and, if necessary, rewrites the URL to send the session IDs.
enableCookies : EBoolean Whether session tracking will use cookies to carry session IDs. If cookies are enabled, session tracking will recognize session IDs that arrive as cookies and try to use cookies for sending session IDs. If cookies are not enabled, session tracking will use URL rewriting instead of cookies (if URL rewriting is enabled). Enabling cookies takes precedence over URL rewriting.
enableSSLTracking : EBoolean Whether session tracking uses SSL to carry session IDs. Enabling SSL tracking takes precedence over cookie-based session tracking.
enableProtocolSwitchRewriting : EBoolean Whether the session ID is added to a URL when the URL requires a switch from HTTP to HTTPS or from HTTPS to HTTP. If rewriting is enabled, the session ID is required in order to go between HTTP and HTTPS.
sessionPersistenceMode : SessionPersistenceKind When enabled, the session manager will persist session information into the datasource specified by the datasourceConnection settings. Specifies whether to save session data in a database, or discard the session data when the server shuts down. True - The session data is stored in a database False - The session data is kept in memory for a single instance of the servlet engine For changes to take effect, this property requires stopping and restarting the application server with which the session manager is associated.
enableSecurityIntegration : EBoolean When security integration is enabled, the Session Manager will associate the identity of users with their HTTP sessions.
allowSerializedSessionAccess : EBoolean By default, access to session is concurrent. When true, this option forces all session access by an application to be serialized, so that the web container can manage conconcurrency control to session data; rather than forcing customers to code access control logic in their applications.
maxWaitTime : EInt Maximum amount of time (in milliseconds) that a request thread which is waiting to access the session will be blocked.
accessSessionOnTimeout : EBoolean What happens if max wait time has been reached for a request thread. If true, the thread is allowed to access the session; if false, an exception is thrown to the web application.
defaultCookieSettings : Cookie @ Session tracking through HTTP cookies is the most used session tracking mechanism and is required to be supported by all servlet containers. The container sends a cookie to the client. The client will then return the cookie on each subsequent request to the server unambiguously associating the request with a session. The name of the session tracking cookie must be JSESSIONID.
sessionDatabasePersistence : SessionDatabasePersistence @ Specifies information about the data source that the session manager will use to obtain database connections.
tuningParams : TuningParams @ Tuning parameters for session management.
sessionDRSPersistence : DRSSettings @ Specifies information required for memory-to-memory replication of session objects. Identifies the Replication Domain and the Replication Mode, one of "Client only", "Server only", or "Both client and server", to be used for memory-to-memory replication of session objects.



Attribute Details

enableUrlRewriting  -  Specifies whether the Session Manager uses rewritten URLs to carry the session IDs. If URL rewriting is enabled, the Session Manager recognizes session IDs that arrive in the URL and, if necessary, rewrites the URL to send the session IDs.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableCookies  -  Whether session tracking will use cookies to carry session IDs. If cookies are enabled, session tracking will recognize session IDs that arrive as cookies and try to use cookies for sending session IDs. If cookies are not enabled, session tracking will use URL rewriting instead of cookies (if URL rewriting is enabled). Enabling cookies takes precedence over URL rewriting.
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableSSLTracking  -  Whether session tracking uses SSL to carry session IDs. Enabling SSL tracking takes precedence over cookie-based session tracking.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableProtocolSwitchRewriting  -  Whether the session ID is added to a URL when the URL requires a switch from HTTP to HTTPS or from HTTPS to HTTP. If rewriting is enabled, the session ID is required in order to go between HTTP and HTTPS.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

sessionPersistenceMode  -  When enabled, the session manager will persist session information into the datasource specified by the datasourceConnection settings. Specifies whether to save session data in a database, or discard the session data when the server shuts down. True - The session data is stored in a database False - The session data is kept in memory for a single instance of the servlet engine For changes to take effect, this property requires stopping and restarting the application server with which the session manager is associated.
    Data Type: SessionPersistenceKind
    Default value:  unspecified
    Allowed values:
        0 - NONE
        1 - DATABASE
        2 - DATA_REPLICATION
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableSecurityIntegration  -  When security integration is enabled, the Session Manager will associate the identity of users with their HTTP sessions.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

allowSerializedSessionAccess  -  By default, access to session is concurrent. When true, this option forces all session access by an application to be serialized, so that the web container can manage conconcurrency control to session data; rather than forcing customers to code access control logic in their applications.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

maxWaitTime  -  Maximum amount of time (in milliseconds) that a request thread which is waiting to access the session will be blocked.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

accessSessionOnTimeout  -  What happens if max wait time has been reached for a request thread. If true, the thread is allowed to access the session; if false, an exception is thrown to the web application.
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

defaultCookieSettings  -  Session tracking through HTTP cookies is the most used session tracking mechanism and is required to be supported by all servlet containers. The container sends a cookie to the client. The client will then return the cookie on each subsequent request to the server unambiguously associating the request with a session. The name of the session tracking cookie must be JSESSIONID.
    Reference Type: Cookie @
    Containment:  true
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

sessionDatabasePersistence  -  Specifies information about the data source that the session manager will use to obtain database connections.
    Reference Type: SessionDatabasePersistence @
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

tuningParams  -  Tuning parameters for session management.
    Reference Type: TuningParams @
    Containment:  true
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

sessionDRSPersistence  -  Specifies information required for memory-to-memory replication of session objects. Identifies the Replication Domain and the Replication Mode, one of "Client only", "Server only", or "Both client and server", to be used for memory-to-memory replication of session objects.
    Reference Type: DRSSettings @
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false



(C) COPYRIGHT International Business Machines Corp. 1996-2006