SessionConfiguration (session-replacement 0.4.7 API)

java.lang.Object
- com.amadeus.session.SessionConfiguration

All Implemented Interfaces:

Serializable
```
public class SessionConfiguration
extends Object
implements Serializable
```
Main configuration parameters for the session management. This includes information if session can be distributed and default timeout.
The parameters are configured using following system properties:
com.amadeus.session.distributable set to true enables session to be stored in distributed storage.
com.amadeus.session.timeout specifies default session inactivity timeout in seconds. Default value is 1800 seconds.
com.amadeus.session.non-cachable specifies comma-separated list of session attributes that must be synchronized with repository. By default, this list is empty. com.amadeus.session.replication-trigger specifies repository behavior when accessing attributes. See SessionConfiguration.ReplicationTrigger enumeration for details. Default value is SessionConfiguration.ReplicationTrigger.SET_AND_NON_PRIMITIVE_GET.
com.amadeus.session.logging.mdc.enabled activates adding current session id to logging systems Mapped Diagnostic Context (MDC).
com.amadeus.session.logging.mdc.name specifies key used to store current session id to logging systems Mapped Diagnostic Context (MDC).

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SessionConfiguration.AttributeProvider` Attribute provider can be used via call to `initializeFrom(AttributeProvider)` to set up SessionConfiguration.
`static class`	`SessionConfiguration.ReplicationTrigger` Strategies for detecting when does an attribute change.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMMIT_ON_ALL_CONCURRENT` Specifies if commit should be done on all concurrent requests to session.
`static SessionConfiguration.ReplicationTrigger`	`DEFAULT_REPLICATION_TRIGGER` Default strategy for detecting that attribute changed.
`static String`	`DEFAULT_SESSION_ID_LENGTH` Default session id length when using `RandomIdProvider` is 30 bytes.
`static String`	`DEFAULT_SESSION_ID_NAME` Default name for the cookie or URL element.
`static String`	`DEFAULT_SESSION_NAMESPACE` Default session namespace is `default`
`static String`	`DEFAULT_SESSION_TIMEOUT` Default session timeout in seconds.
`static int`	`DEFAULT_SESSION_TIMEOUT_VALUE_NUM` Default session timeout is 30 minutes.
`static String`	`DEFAULT_SESSION_TIMESTAMP` Default session timestamp is `false`
`static String`	`DEFAULT_STICKY_SESSIONS` By default, sessions are sticky.
`static String`	`DELEGATE_WRITER` Set to `true` if session should delegate PrintWriter implementation to container.
`static String`	`DISABLED_SESSION` ServletContext parameter or system property disabled session management.
`static String`	`DISTRIBUTABLE_SESSION` Indicates if sessions can be distributed or not.
`static String`	`FORCE_DISTRIBUTABLE` Non-distributable web apps will be treated as distributable if this parameter is set to `true`.
`static String`	`INTERCEPT_LISTENERS` Specifies if listeners should be discovered using interception of native session.
`static String`	`LOG_MDC_SESSION_ENABLED` Is session id stored in logging MDC.
`static String`	`LOG_MDC_SESSION_NAME` The name of the logging MDC attribute where session id is stored.
`static String`	`LOGGING_MDC_DEFAULT_KEY` Default key used to store session id in logging system's MDC.
`static String`	`NODE_ID` System property containing the id of node.
`static String`	`NON_CACHEABLE_ATTRIBUTES` List of attributes that must be retrieved from repository (i.e.
`static String`	`PROVIDER_CONFIGURATION` ServletContext parameter or system property containing the configuration for the `SessionRepository`.
`static String`	`REPOSITORY_FACTORY_NAME` ServletContext parameter or system property containing the name of `SessionRepositoryFactory` implementation.
`static String`	`REUSE_CONCURRENT_SESSION` ServletContext parameter or system property activating sharing of instances of session during concurrent requests.
`static String`	`SESSION_ENCRYPTION_KEY` Specifies key to be used for encryption.
`static String`	`SESSION_HOST` Enables overriding the name of the host.
`static String`	`SESSION_ID_LENGTH` ServletContext parameter or system property specifying the length of the generates session ids.
`static String`	`SESSION_ID_NAME` ServletContext parameter or system property containing the name of the cookie or URL element for propagating session.
`static String`	`SESSION_ID_PROVIDER` ServletContext parameter or system property indicating what provider generates session ids.
`static String`	`SESSION_NAMESPACE` The namespace for sessions.
`static String`	`SESSION_PROPAGATOR_NAME` ServletContext parameter or system property containing the name of the `SessionTracking` implementation or value from `com.amadeus.session.servlet.SessionPropagation` enumeration.
`static String`	`SESSION_REPLICATION_TRIGGER` Strategy for for triggering replication.
`static String`	`SESSION_TIMESTAMP` Indicate if generated session prefixed with!Timestamp.
`static String`	`STICKY_SESSIONS` Activates sticky session strategy.

Constructor Summary

Constructors
Constructor and Description

SessionConfiguration()
Default constructor.

Constructors
Constructor and Description
`SessionConfiguration()` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttribute(String key, String defaultValue)` Returns value of attribute from attribute provider if it was supplied or from system property if it is not present or if there is no attribute provider
`String`	`getEncryptionKey()` Returns encryption key to use.
`String`	`getLoggingMdcKey()` Returns key used to store current session id to logging system's Mapped Diagnostic Context (MDC).
`int`	`getMaxInactiveInterval()` Returns maximum inactivity interval before session expires in seconds.
`String`	`getNamespace()` Namespace for session.
`String`	`getNode()` Returns id of the current node
`Set<String>`	`getNonCacheable()` Returns set of keys that should not be cached locally.
`static String`	`getPropertySecured(String key, String def)` Returns value of system property, and logs information if access to properties is protected.
`String`	`getProviderConfiguration()` Returns configuration string for the repository provider.
`SessionConfiguration.ReplicationTrigger`	`getReplicationTrigger()` Returns strategy used to detect if attribute changed.
`String`	`getRepositoryFactory()` Gets the class name or the unique identifier of the repository factory.
`String`	`getSessionIdName()` Returns name of identifier that is used to stored session id.
`String`	`getSessionTracking()` Returns class name or unique id of the session tracking.
`String`	`getTrueNamespace()` Returns configured namespace of the session (may be `null`).
`void`	`initializeFrom(SessionConfiguration.AttributeProvider provider)` Allows setting up configuration from external source.
`boolean`	`isAllowedCachedSessionReuse()` Returns `true` if multiple concurrent threads that operate on same session can re-use session from local cache.
`boolean`	`isCommitOnAllConcurrent()` Returns `true` if commit of attributes should be done on all concurrent requests to session.
`boolean`	`isDelegateWriter()`
`boolean`	`isDistributable()` Returns `true` if session can be stored remote repository.
`boolean`	`isForceDistributable()` Returns `true` if distribution/replication should be used even when web app is marked as non-distributable.
`boolean`	`isInterceptListeners()`
`boolean`	`isLoggingMdcActive()` Returns `true` if session information should be stored in logging systems Mapped Diagnostic Context (MDC).
`boolean`	`isSticky()` Returns `true` if sessions are sticky.
`boolean`	`isTimestampSufix()` Returns `true` if session id is expected to be suffixed by !timestamp.
`boolean`	`isUsingEncryption()` Returns `true` if session should be encrypted before storing in repository.
`void`	`setAllowedCachedSessionReuse(boolean allowedCachedSessionReuse)` Enables or disables sharing of session instances between multiple concurrent threads.
`void`	`setAttribute(String key, String value)` Sets attribute value.
`void`	`setCommitOnAllConcurrent(boolean commitOnAllConcurrent)` Controls if commit of attributes should be done on all concurrent requests to session.
`void`	`setDelegateWriter(boolean delegateWriter)`
`void`	`setDistributable(boolean distributable)` Sets whether session can be stored in remote repository.
`void`	`setEncryptionKey(String key)` Sets encryption key to use.
`void`	`setForceDistributable(boolean forceDistributable)` Sets whether distribution/replication should be used even when web app is marked as non-distributable.
`void`	`setInterceptListeners(boolean interceptListeners)`
`void`	`setLoggingMdcActive(boolean loggingMdcActive)` Sets whether session information should be stored in logging systems Mapped Diagnostic Context (MDC).
`void`	`setLoggingMdcKey(String loggingMdcKey)` Sets key used to store current session id to logging system's Mapped Diagnostic Context (MDC).
`void`	`setMaxInactiveInterval(int maxInactiveInterval)` Sets maximum inactivity interval before session expires
`void`	`setNamespace(String namespace)` Sets namespace of the session.
`void`	`setNode(String node)` Sets id of the node
`void`	`setNonCacheable(Set<String> nonCacheable)` Sets set of keys that should not be cached locally.
`void`	`setNonCacheable(String nonCacheableAttributesCsv)` Sets set of keys that should not be cached locally by extracting keys from comma-separated list provided as parameter.
`void`	`setProviderConfiguration(String providerConfiguration)` Sets configuration string for the repository provider.
`void`	`setReplicationTrigger(SessionConfiguration.ReplicationTrigger replicationTrigger)` Sets strategy used to detect if attribute changed.
`void`	`setRepositoryFactory(String repositoryFactory)` Sets the class name or the unique identifier of the repository factory.
`void`	`setSessionIdName(String sessionIdName)` Sets name of session identifier.
`void`	`setSessionTracking(String sessionTracking)` Sets class name or unique id of the session tracking.
`void`	`setSticky(boolean sticky)` Sets stickiness of sessions.
`void`	`setTimestampSufix(boolean timestamp)` Add timestamp suffix to session id if set to true.
`void`	`setUsingEncryption(boolean usingEncryption)` Sets whether the session data is stored in encrypted form in repository.
`String`	`toString()`

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

- Field Detail
  - DISTRIBUTABLE_SESSION
```
public static final String DISTRIBUTABLE_SESSION
```
    Indicates if sessions can be distributed or not.
    
    See Also:
    
    Constant Field Values
  - FORCE_DISTRIBUTABLE
```
public static final String FORCE_DISTRIBUTABLE
```
    Non-distributable web apps will be treated as distributable if this parameter is set to true.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SESSION_TIMEOUT
```
public static final String DEFAULT_SESSION_TIMEOUT
```
    Default session timeout in seconds.
    
    See Also:
    
    Constant Field Values
  - NON_CACHEABLE_ATTRIBUTES
```
public static final String NON_CACHEABLE_ATTRIBUTES
```
    List of attributes that must be retrieved from repository (i.e. they can't be cached locally).
    
    See Also:
    
    Constant Field Values
  - SESSION_REPLICATION_TRIGGER
```
public static final String SESSION_REPLICATION_TRIGGER
```
    Strategy for for triggering replication. See SessionConfiguration.ReplicationTrigger enumeration.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REPLICATION_TRIGGER
```
public static final SessionConfiguration.ReplicationTrigger DEFAULT_REPLICATION_TRIGGER
```
    Default strategy for detecting that attribute changed.
  - LOG_MDC_SESSION_ENABLED
```
public static final String LOG_MDC_SESSION_ENABLED
```
    Is session id stored in logging MDC.
    
    See Also:
    
    Constant Field Values
  - LOG_MDC_SESSION_NAME
```
public static final String LOG_MDC_SESSION_NAME
```
    The name of the logging MDC attribute where session id is stored.
    
    See Also:
    
    Constant Field Values
  - LOGGING_MDC_DEFAULT_KEY
```
public static final String LOGGING_MDC_DEFAULT_KEY
```
    Default key used to store session id in logging system's MDC.
    
    See Also:
    
    Constant Field Values
  - STICKY_SESSIONS
```
public static final String STICKY_SESSIONS
```
    Activates sticky session strategy. When activated, implementation should try to handle all session activity on the last node that processed client request that impacts the session.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_STICKY_SESSIONS
```
public static final String DEFAULT_STICKY_SESSIONS
```
    By default, sessions are sticky.
    
    See Also:
    
    Constant Field Values
  - SESSION_NAMESPACE
```
public static final String SESSION_NAMESPACE
```
    The namespace for sessions. It is best practice to have sessions in different applications or webapps should having different namespaces. If applications want to share sessions, then they can use same namespace. In case of webapps, namespace can be defined using servlet init parameter, or if not present, the context name of the webapp is used as namespace.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SESSION_NAMESPACE
```
public static final String DEFAULT_SESSION_NAMESPACE
```
    Default session namespace is default
    
    See Also:
    
    Constant Field Values
  - SESSION_TIMESTAMP
```
public static final String SESSION_TIMESTAMP
```
    Indicate if generated session prefixed with!Timestamp.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SESSION_TIMESTAMP
```
public static final String DEFAULT_SESSION_TIMESTAMP
```
    Default session timestamp is false
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SESSION_TIMEOUT_VALUE_NUM
```
public static final int DEFAULT_SESSION_TIMEOUT_VALUE_NUM
```
    Default session timeout is 30 minutes.
    
    See Also:
    
    Constant Field Values
  - SESSION_HOST
```
public static final String SESSION_HOST
```
    Enables overriding the name of the host. By default it is retrieved from environment. See initNode() for details.
    
    See Also:
    
    Constant Field Values
  - PROVIDER_CONFIGURATION
```
public static final String PROVIDER_CONFIGURATION
```
    ServletContext parameter or system property containing the configuration for the SessionRepository. See each implementation for detailed format. By convention, items in the format are separated by commas.
    
    See Also:
    
    Constant Field Values
  - REPOSITORY_FACTORY_NAME
```
public static final String REPOSITORY_FACTORY_NAME
```
    ServletContext parameter or system property containing the name of SessionRepositoryFactory implementation. The value is either name of the class or registered repository name such as redis, in-memory
    
    See Also:
    
    Constant Field Values
  - SESSION_PROPAGATOR_NAME
```
public static final String SESSION_PROPAGATOR_NAME
```
    ServletContext parameter or system property containing the name of the SessionTracking implementation or value from com.amadeus.session.servlet.SessionPropagation enumeration.
    
    See Also:
    
    Constant Field Values
  - SESSION_ID_NAME
```
public static final String SESSION_ID_NAME
```
    ServletContext parameter or system property containing the name of the cookie or URL element for propagating session.
    
    See Also:
    
    DEFAULT_SESSION_ID_NAME, Constant Field Values
  - DEFAULT_SESSION_ID_NAME
```
public static final String DEFAULT_SESSION_ID_NAME
```
    Default name for the cookie or URL element.
    
    See Also:
    
    SESSION_ID_NAME, Constant Field Values
  - NODE_ID
```
public static final String NODE_ID
```
    System property containing the id of node.
    
    See Also:
    
    Constant Field Values
  - DISABLED_SESSION
```
public static final String DISABLED_SESSION
```
    ServletContext parameter or system property disabled session management.
    
    See Also:
    
    Constant Field Values
  - REUSE_CONCURRENT_SESSION
```
public static final String REUSE_CONCURRENT_SESSION
```
    ServletContext parameter or system property activating sharing of instances of session during concurrent requests.
    
    See Also:
    
    Constant Field Values
  - SESSION_ID_PROVIDER
```
public static final String SESSION_ID_PROVIDER
```
    ServletContext parameter or system property indicating what provider generates session ids.
    
    See Also:
    
    Constant Field Values
  - SESSION_ID_LENGTH
```
public static final String SESSION_ID_LENGTH
```
    ServletContext parameter or system property specifying the length of the generates session ids. Used in RandomIdProvider.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SESSION_ID_LENGTH
```
public static final String DEFAULT_SESSION_ID_LENGTH
```
    Default session id length when using RandomIdProvider is 30 bytes.
    
    See Also:
    
    Constant Field Values
  - INTERCEPT_LISTENERS
```
public static final String INTERCEPT_LISTENERS
```
    Specifies if listeners should be discovered using interception of native session.
    
    See Also:
    
    Constant Field Values
  - COMMIT_ON_ALL_CONCURRENT
```
public static final String COMMIT_ON_ALL_CONCURRENT
```
    Specifies if commit should be done on all concurrent requests to session.
    
    See Also:
    
    Constant Field Values
  - SESSION_ENCRYPTION_KEY
```
public static final String SESSION_ENCRYPTION_KEY
```
    Specifies key to be used for encryption. When present activates encryption automatically. If key specifies a URL, key will be loaded from specified address. Otherwise it is treated literally.
    
    See Also:
    
    Constant Field Values
  - DELEGATE_WRITER
```
public static final String DELEGATE_WRITER
```
    Set to true if session should delegate PrintWriter implementation to container. By default it is false and session replacer provides it's own implementation.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SessionConfiguration
```
public SessionConfiguration()
```
    Default constructor.
- Method Detail
  - setEncryptionKey
```
public void setEncryptionKey(String key)
```
    Sets encryption key to use. If key is null, encryption is deactivated.
    
    Parameters:
    
    key - encryption key to use or null
  - initializeFrom
```
public void initializeFrom(SessionConfiguration.AttributeProvider provider)
```
    Allows setting up configuration from external source. It is expected that external source offers the same attributes as the ones read from system properties.
    
    Parameters:
    
    provider - the external source for attributes
  - getMaxInactiveInterval
```
public int getMaxInactiveInterval()
```
    Returns maximum inactivity interval before session expires in seconds.
    
    Returns:
    
    maximum inactivity interval
  - setMaxInactiveInterval
```
public void setMaxInactiveInterval(int maxInactiveInterval)
```
    Sets maximum inactivity interval before session expires
    
    Parameters:
    
    maxInactiveInterval - inactivity interval in seconds
  - isDistributable
```
public boolean isDistributable()
```
    Returns true if session can be stored remote repository.
    
    Returns:
    
    true if session can be stored remote repository
  - setDistributable
```
public void setDistributable(boolean distributable)
```
    Sets whether session can be stored in remote repository.
    
    Parameters:
    
    distributable - true if session can be stored remote repository
  - getNonCacheable
```
public Set<String> getNonCacheable()
```
    Returns set of keys that should not be cached locally.
    
    Returns:
    
    set of attribute names that can't be cached locally
  - setNonCacheable
```
public void setNonCacheable(Set<String> nonCacheable)
```
    Sets set of keys that should not be cached locally.
    
    Parameters:
    
    nonCacheable - set of attribute names that can't be cached locally
  - setNonCacheable
```
public void setNonCacheable(String nonCacheableAttributesCsv)
```
    Sets set of keys that should not be cached locally by extracting keys from comma-separated list provided as parameter.
    
    Parameters:
    
    nonCacheableAttributesCsv - list of non cacheable attributes in comma-separated list
  - getReplicationTrigger
```
public SessionConfiguration.ReplicationTrigger getReplicationTrigger()
```
    Returns strategy used to detect if attribute changed.
    
    Returns:
    
    the current replication strategy
  - setReplicationTrigger
```
public void setReplicationTrigger(SessionConfiguration.ReplicationTrigger replicationTrigger)
```
    Sets strategy used to detect if attribute changed.
    
    Parameters:
    
    replicationTrigger - new replication strategy to use
  - isLoggingMdcActive
```
public boolean isLoggingMdcActive()
```
    Returns true if session information should be stored in logging systems Mapped Diagnostic Context (MDC).
    
    Returns:
    
    true if session information should be stored in MDC
  - setLoggingMdcActive
```
public void setLoggingMdcActive(boolean loggingMdcActive)
```
    Sets whether session information should be stored in logging systems Mapped Diagnostic Context (MDC).
    
    Parameters:
    
    loggingMdcActive - true if logging should add information to MDC
  - getLoggingMdcKey
```
public String getLoggingMdcKey()
```
    Returns key used to store current session id to logging system's Mapped Diagnostic Context (MDC).
    
    Returns:
    
    the key used for session id during logging
  - setLoggingMdcKey
```
public void setLoggingMdcKey(String loggingMdcKey)
```
    Sets key used to store current session id to logging system's Mapped Diagnostic Context (MDC).
    
    Parameters:
    
    loggingMdcKey - the key value to use. If value is null, LOGGING_MDC_DEFAULT_KEY is used as key
  - isSticky
```
public boolean isSticky()
```
    Returns true if sessions are sticky. Sticky sessions should be expired on the last node that used them.
    
    Returns:
    
    true if session is sticky
  - setSticky
```
public void setSticky(boolean sticky)
```
    Sets stickiness of sessions. See isSticky().
    
    Parameters:
    
    sticky - true if session is stick
  - isTimestampSufix
```
public boolean isTimestampSufix()
```
    Returns true if session id is expected to be suffixed by !timestamp.
    
    Returns:
    
    true if session id to be suffixed by !timestamp.
  - setTimestampSufix
```
public void setTimestampSufix(boolean timestamp)
```
    Add timestamp suffix to session id if set to true. See isTimestampSufix().
    
    Parameters:
    
    timestamp - true if session is expected to be suffixed by timestamp
  - getNode
```
public String getNode()
```
    Returns id of the current node
    
    Returns:
    
    id/name of the current node
  - setNode
```
public void setNode(String node)
```
    Sets id of the node
    
    Parameters:
    
    node - id/name of the current node
  - getNamespace
```
public String getNamespace()
```
    Namespace for session. It will never be null (if null, value default).
    
    Returns:
    
    namespace for session
  - getTrueNamespace
```
public String getTrueNamespace()
```
    Returns configured namespace of the session (may be null).
    
    Returns:
    
    the truely configured name of the session
  - setNamespace
```
public void setNamespace(String namespace)
```
    Sets namespace of the session.
    
    Parameters:
    
    namespace - name to use
  - getProviderConfiguration
```
public String getProviderConfiguration()
```
    Returns configuration string for the repository provider.
    
    Returns:
    
    provider configuration string
  - setProviderConfiguration
```
public void setProviderConfiguration(String providerConfiguration)
```
    Sets configuration string for the repository provider.
    
    Parameters:
    
    providerConfiguration - the string used to configure provider
  - getRepositoryFactory
```
public String getRepositoryFactory()
```
    Gets the class name or the unique identifier of the repository factory.
    
    Returns:
    
    name of the repository factory
  - setRepositoryFactory
```
public void setRepositoryFactory(String repositoryFactory)
```
    Sets the class name or the unique identifier of the repository factory.
    
    Parameters:
    
    repositoryFactory - the name of the repository factory
  - getSessionTracking
```
public String getSessionTracking()
```
    Returns class name or unique id of the session tracking. SessionTracking is the class responsible for reading and propagating session id.
    
    Returns:
    
    the name of the session tracking class
  - setSessionTracking
```
public void setSessionTracking(String sessionTracking)
```
    Sets class name or unique id of the session tracking. See getSessionTracking().
    
    Parameters:
    
    sessionTracking - the unique id or name of the session tracking class
  - getSessionIdName
```
public String getSessionIdName()
```
    Returns name of identifier that is used to stored session id. E.g. this will be cookie name if session uses cookie propagation.
    
    Returns:
    
    the session identifier
  - setSessionIdName
```
public void setSessionIdName(String sessionIdName)
```
    Sets name of session identifier.
    
    Parameters:
    
    sessionIdName - new session identifier
  - isAllowedCachedSessionReuse
```
public boolean isAllowedCachedSessionReuse()
```
    Returns true if multiple concurrent threads that operate on same session can re-use session from local cache.
    
    Returns:
    
    true if concurrent threads can access same session
  - setAllowedCachedSessionReuse
```
public void setAllowedCachedSessionReuse(boolean allowedCachedSessionReuse)
```
    Enables or disables sharing of session instances between multiple concurrent threads.
    
    Parameters:
    
    allowedCachedSessionReuse - true if concurrent threads can access same session
  - getPropertySecured
```
public static String getPropertySecured(String key,
                                        String def)
```
    Returns value of system property, and logs information if access to properties is protected.
    
    Parameters:
    
    key - property key
    
    def - default value for property
    
    Returns:
    
    value of the property or default value if property is not defined or if access is protected
  - getAttribute
```
public String getAttribute(String key,
                           String defaultValue)
```
    Returns value of attribute from attribute provider if it was supplied or from system property if it is not present or if there is no attribute provider
    
    Parameters:
    
    key - key that identifies attribute or system property
    
    defaultValue - default value for key
    
    Returns:
    
    value of the attribute, or property, or default value if it was not defined or if access is protected
  - setAttribute
```
public void setAttribute(String key,
                         String value)
```
    Sets attribute value. Used to add configuration items not supported by SessionConfiguration.
    
    Parameters:
    
    key - the name of the attribute
    
    value - the value of the attribute
  - isInterceptListeners
```
public boolean isInterceptListeners()
```
    Returns:
    
    the interceptListeners
  - setInterceptListeners
```
public void setInterceptListeners(boolean interceptListeners)
```
    Parameters:
    
    interceptListeners - the interceptListeners to set
  - isForceDistributable
```
public boolean isForceDistributable()
```
    Returns true if distribution/replication should be used even when web app is marked as non-distributable.
    
    Returns:
    
    true if distribution/replication should be used even when web app is marked as non-distributable.
  - setForceDistributable
```
public void setForceDistributable(boolean forceDistributable)
```
    Sets whether distribution/replication should be used even when web app is marked as non-distributable.
    
    Parameters:
    
    forceDistributable - true if distribution/replication should be used even when web app is marked as non-distributable.
  - isCommitOnAllConcurrent
```
public boolean isCommitOnAllConcurrent()
```
    Returns true if commit of attributes should be done on all concurrent requests to session.
    
    Returns:
    
    true if commit should be done on all concurrent requests
  - setCommitOnAllConcurrent
```
public void setCommitOnAllConcurrent(boolean commitOnAllConcurrent)
```
    Controls if commit of attributes should be done on all concurrent requests to session.
    
    Parameters:
    
    commitOnAllConcurrent - true if commit should be done on all concurrent requests
  - isUsingEncryption
```
public boolean isUsingEncryption()
```
    Returns true if session should be encrypted before storing in repository.
    
    Returns:
    
    true if session should be encrypted before storing in repository
  - setUsingEncryption
```
public void setUsingEncryption(boolean usingEncryption)
```
    Sets whether the session data is stored in encrypted form in repository. If set to true, encryption key must be set also.
    
    Parameters:
    
    usingEncryption - true if session data is stored in encrypted form
  - getEncryptionKey
```
public String getEncryptionKey()
```
    Returns encryption key to use. If encryption is disabled, returns null.
    
    Returns:
    
    the encryption key
  - isDelegateWriter
```
public boolean isDelegateWriter()
```
  - setDelegateWriter
```
public void setDelegateWriter(boolean delegateWriter)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SessionConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DISTRIBUTABLE_SESSION

FORCE_DISTRIBUTABLE

DEFAULT_SESSION_TIMEOUT

NON_CACHEABLE_ATTRIBUTES

SESSION_REPLICATION_TRIGGER

DEFAULT_REPLICATION_TRIGGER

LOG_MDC_SESSION_ENABLED

LOG_MDC_SESSION_NAME

LOGGING_MDC_DEFAULT_KEY

STICKY_SESSIONS

DEFAULT_STICKY_SESSIONS

SESSION_NAMESPACE

DEFAULT_SESSION_NAMESPACE

SESSION_TIMESTAMP

DEFAULT_SESSION_TIMESTAMP

DEFAULT_SESSION_TIMEOUT_VALUE_NUM

SESSION_HOST

PROVIDER_CONFIGURATION

REPOSITORY_FACTORY_NAME

SESSION_PROPAGATOR_NAME

SESSION_ID_NAME

DEFAULT_SESSION_ID_NAME

NODE_ID

DISABLED_SESSION

REUSE_CONCURRENT_SESSION

SESSION_ID_PROVIDER

SESSION_ID_LENGTH

DEFAULT_SESSION_ID_LENGTH

INTERCEPT_LISTENERS

COMMIT_ON_ALL_CONCURRENT

SESSION_ENCRYPTION_KEY

DELEGATE_WRITER

Constructor Detail

SessionConfiguration

Method Detail

setEncryptionKey

initializeFrom

getMaxInactiveInterval

setMaxInactiveInterval

isDistributable

setDistributable

getNonCacheable

setNonCacheable

setNonCacheable

getReplicationTrigger

setReplicationTrigger

isLoggingMdcActive

setLoggingMdcActive

getLoggingMdcKey

setLoggingMdcKey

isSticky

setSticky

isTimestampSufix

setTimestampSufix

getNode

setNode

getNamespace

getTrueNamespace

setNamespace

getProviderConfiguration

setProviderConfiguration

getRepositoryFactory

setRepositoryFactory

getSessionTracking

setSessionTracking

getSessionIdName

setSessionIdName

isAllowedCachedSessionReuse

setAllowedCachedSessionReuse

getPropertySecured

getAttribute

setAttribute

isInterceptListeners