This topic is regarding sessions in the IS and the properties relevant for enabling session persistence for these sessions. This is particularly useful when the remember me option is selected when logging into either the service provider or the WSO2 Identity Server.
The following configuration found in the <IS_HOME>/repository/conf/identity/identity.xml
file, under the the Server
and JDBCPersistenceManager
elements is used to enable session persistence.
<SessionDataPersist> <Enable>true</Enable> <Temporary>false</Temporary> <PoolSize>100</PoolSize> <SessionDataCleanUp> <Enable>true</Enable> <CleanUpTimeout>20160</CleanUpTimeout> <CleanUpPeriod>1140</CleanUpPeriod> </SessionDataCleanUp> <OperationDataCleanUp> <Enable>true</Enable> <CleanUpPeriod>720</CleanUpPeriod> </OperationDataCleanUp> </SessionDataPersist>
The following table describes the elements of the configurations mentioned above.
Configuration element | Description |
---|---|
Enable | This enables the persistence of session data. Therefore, this must be configured to |
Temporary | Setting this to |
PoolSize | To improve performance, OAuth2 access tokens are persisted asynchronously in the database using a thread pool. This value refers to the number of threads in that thread pool. |
SessionDataCleanUp | This section of the configuration is related to the cleaning up of session data. |
Enable | Selecting true here enables the cleanup task and ensures that it starts running. |
CleanUpTimeOut | This is the timeout value (in minutes) of the session data that is removed by the cleanup task. The default value is 2 weeks. |
CleanUpPeriod | This is the time period (in minutes) that the cleanup task would run. The default value is 1 day. |
OperationDataCleanUp | This section of the configuration is related to the cleaning up of operation data. |
Note: To work with Single Sign-On you must have session persistence enabled.
- See Single Sign-On for more information.