Identity Broker Documentation Index
Configuration Reference Home

HTTP Session Manager

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.

Note: this is an abstract component that cannot be instantiated.

HTTP Session Manager are responsible for managing the HTTP sessions for a HTTP Connection Handler. This feature is experimental and should not be used unless instructed to do so by UnboundID support.

Direct Subcomponents
Relations to This Component
Properties
dsconfig Usage

Direct Subcomponents

The following HTTP Session Manager are available in the server :

These HTTP Session Manager inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to HTTP Session Manager:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ session-tracking-mode
↓ session-idle-time-limit

Basic Properties

description

Description
A description for this HTTP Session Manager
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

session-tracking-mode

Description
Specifies the mechanism used to track HTTP sessions between subsequent requests. Use of cookies is the most common and simplest way to track HTTP sessions. In such a case the server will send a cookie with the session ID to the client so that the session will be recognized in subsequent requests. However, some clients may not support cookies and end users may disable their use in browsers. In such cases URL rewriting can be used as a workaround which will include the session ID as a query parameter in the request URL. Not only will the session ID be visible to end users, all web application and HTTP servlet extensions must include the session ID when generating URLs. The additional security risk and possible extra programming necessary should be considered when deciding whether to support URL rewriting.
Default Value
cookie
url
Allowed Values
cookie - Sessions will be tracked using HTTP cookies.

url - Sessions will be tracked using URL rewriting.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

session-idle-time-limit

Description
Specifies the maximum length of time that a session may be idle before it expires and is invalidated. A duration of zero hours indicates that sessions will never expire.
Default Value
24h
Allowed Values
A duration. Lower limit is 0 seconds. Upper limit is 2147483647 seconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured HTTP Session Manager:

dsconfig list-http-session-manager
     [--property {propertyName}] ...

To view the configuration for an existing HTTP Session Manager:

dsconfig get-http-session-manager-prop
     --manager-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing HTTP Session Manager:

dsconfig set-http-session-manager-prop
     --manager-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To delete an existing HTTP Session Manager:

dsconfig delete-http-session-manager
     --manager-name {name}