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.
The Memory HTTP Session Manager stores sessions in memory and supports saving them to disk, either periodically or at shutdown. This feature is experimental and should not be used unless instructed to do so by UnboundID support.
Sessions are local to this Identity Broker instance only. Session failover between multiple Identity Broker instances is not supported. This session manager should not be used with a HTTP load balancer.
↓Parent Component
↓Properties
↓dsconfig Usage
The Memory HTTP Session Manager component inherits from the HTTP Session Manager
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ session-tracking-mode | |
| ↓ session-idle-time-limit | |
| ↓ idle-save-duration | |
| ↓ save-interval | |
| ↓ scavenge-interval | |
| ↓ save-directory |
| 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 |
| 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 |
| 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 |
| Description | Specifies the duration after which a session is deemed idle and saved to disk in order reduce session memory footprint. A duration of zero seconds indicates that sessions will not be idle saved. The session is idle saved by persisting it to disk and then clearing the session values attribute map. |
| Default Value | 0s |
| Allowed Values | A duration. Lower limit is 0 seconds. Upper limit is 2147483647 seconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The Memory HTTP Session Manager must be disabled and re-enabled for changes to this setting to take effect. Any HTTP connection handlers must be restarted before changes will take effect. |
| Description | Specifies the interval at which sessions are periodically saved to disk. A duration of zero seconds indicates that sessions will only be saved during shutdown. |
| Default Value | 0s |
| Allowed Values | A duration. Lower limit is 0 seconds. Upper limit is 2147483647 seconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The Memory HTTP Session Manager must be disabled and re-enabled for changes to this setting to take effect. Any HTTP connection handlers must be restarted before changes will take effect. |
| Description | Specifies the interval at which checks for expired sessions are performed. Specifies the recurring period that the scavenging task evaluates the state of a session periodically in the background. |
| Default Value | 30s |
| Allowed Values | A duration. Lower limit is 1 seconds. Upper limit is 2147483647 seconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The Memory HTTP Session Manager must be disabled and re-enabled for changes to this setting to take effect. Any HTTP connection handlers must be restarted before changes will take effect. |
| Description | Specifies the path to the directory where session information is to be written. This path may be either an absolute path or a path that is relative to the root of the Identity Broker instance. The Identity Broker must have permission to create new files in it. |
| Default Value | Sessions will not be saved to disk and will be lost when Identity Broker is shutdown. |
| Allowed Values | Unknown |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The Memory HTTP Session Manager must be disabled and re-enabled for changes to this setting to take effect. Any HTTP connection handlers must be restarted before changes will take effect. |
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 create a new Memory HTTP Session Manager:
dsconfig create-http-session-manager
--manager-name {name}
[--set {propertyName}:{propertyValue}] ...
To delete an existing HTTP Session Manager:
dsconfig delete-http-session-manager
--manager-name {name}