TuneParams
Tuning parameters for session support.
Attributes Summary
usingMultiRowSchema Whether to place each instance of application data in a separate row in the database, allowing larger amounts of data to be stored for each session. maxInMemorySessionCount Number of sessions to maintain in memory. allowOverflow Whether to allow the number of sessions in memory to exceed the value specified by Max In Memory Session Count property. scheduleInvalidation Enables the scheduled invalidation process for cleaning up the invalidated HttpSessions from the sessions database. writeFrequency When the session is written to the database. writeInterval If the Write Frequency is specified as TIME_BASED_WRITE, this value specifies how often the session data will be written to the database. writeContents Whether only updated attributes should be written to the database. invalidationTimeout Specifies how long a session is allowed to go unused before it will be considered valid no longer. invalidationSchedule
Attribute Details
usingMultiRowSchema
Whether to place each instance of application data in a separate row in the database, allowing larger amounts of data to be stored for each session. This can yield better performance in certain usage scenarios. If using multirow schema is not enabled, instances of application data can be placed in the same row.
Data type: Boolean
Default value: false
maxInMemorySessionCount
Number of sessions to maintain in memory. The meaning differs depending on whether you are using in-memory or persistent sessions.For in-memory sessions, this value specifies the number of sessions in the base session table. Use the Allow Overflow property to specify whether to limit sessions to this number for the entire Session Manager, or allow additional sessions to be stored in secondary tables. For persistent sessions, this value specifies the size of the general cache. If the Cache property is enabled, the Max In-Memory Session Count specifies how many session updates will be cached before the Session Manager reverts to reading session updates from the database automatically.This value holds when you are using in-memory sessions, persistent sessions with caching, or persistent sessions with manual updates. (The manual update cache keeps the last n time stamps representing "last access" times, with n being the Max In-Memory Session Count value).
Data type: Integer
Default value: 1000
allowOverflow
Whether to allow the number of sessions in memory to exceed the value specified by Max In Memory Session Count property.
Data type: Boolean
Default value: true
scheduleInvalidation
Enables the scheduled invalidation process for cleaning up the invalidated HttpSessions from the sessions database. When enabled, this setting specifies the two hours of a day in which the invalidator process cleans up the invalidated persistent sessions in the database.
Data type: Boolean
Default value: false
writeFrequency
When the session is written to the database. If you specify END_OF_ SERVLET_SERVICE, a session is written to the database after the servlet completes execution. If you specify MANUAL_UPDATE, programmatic sync on the IBMSession object is required in order to write the session data to the database. If you specify TIME_BASED_WRITE, session data is written to the database based on the specified Write Interval value.
Data type: WriteFrequencyEnum
Default value: unspecified
Allowed Values: END_OF_SERVLET_SERVICE MANUAL_UPDATE TIME_BASED_WRITE
writeInterval
If the Write Frequency is specified as TIME_BASED_WRITE, this value specifies how often the session data will be written to the database. The value must be a number of seconds, specified as a positive integer in the range from 5 to 9999. At minimum, a configured Invalidation Timeout should be twice as large as the configured write interval.
Data type: Integer
Default value: 120
writeContents
Whether only updated attributes should be written to the database. Otherwise, all of the session attributes will be written to the database, whether or not they have changed.
Data type: WriteContentsEnum
Default value: unspecified
Allowed Values: ONLY_UPDATED_ATTRIBUTES ALL_SESSION_ATTRIBUTES
invalidationTimeout
Specifies how long a session is allowed to go unused before it will be considered valid no longer. The value is in minutes. Use a -1 to specify that the session will not be invalidated.The value of this setting is used as a default when the session timeout is not specified in a Web module deployment descriptor.Note, to preserve performance, the invalidation timer is not accurate "to the second." It is safe to assume that the timer is accurate to within two minutes. When the Write Frequency is time based, this value should be at least twice as large as the write interval.TuningParams.maxInMemorySessionCount.description=Specifies the maximum number of sessions to maintain in memory.The meaning differs depending on whether you are using in-memory or persistent sessions. For in-memory sessions, this value specifies the number of sessions in the base session table. Use the Allow Overflow property to specify whether to limit sessions to this number for the entire Session Manager, or to allow additional sessions to be stored in secondary tables.For persistent sessions, this value specifies the size of the general cache. If the Cache property is enabled, this value specifies how many session updates will be cached before the Session Manager reverts to reading session updates from the database automatically.This value holds when you are using in-memory sessions, persistent sessions with caching, or persistent sessions with manual updates. (The manual update cache keeps the last n time stamps representing "last access" times, with n being the Max In Memory Session Count value).
Data type: Integer
Default value: 30
invalidationSchedule
Data type: InvalidationSchedule