public.javadoc.org.spincast.plugins.session.config.SpincastSessionConfig.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







SpincastSessionConfig (org.spincast:spincast-framework 1.0.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.plugins.session.config
Interface SpincastSessionConfig






All Known Implementing Classes:
SpincastSessionConfigDefault




public interface SpincastSessionConfig
Configurations for the Spincast Session plugin.











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


int
getDeleteOldSessionsScheduledTaskRunEveryNbrMinutes()
The acheduled task to delete old sessions should run 
 every X minutes.



String
getSessionIdCookieName()
The name of the cookie used to store the
 Session id, by default.



int
getSessionMaxInactiveMinutes()
The number of minutes before
 an inactive session is deleted.



int
getUpdateNotDirtySessionPeriodInSeconds()
The number of seconds between two updates of the
 modification date of a session, wheen the session
 is not dirty.



boolean
isSessionPermanentByDefault()
When a cookie is automatically added to a
 visitor, should it be permanent (10 years)?
 Otherwise, it will be browser-session long
 only (the default).
















Method Detail





isSessionPermanentByDefault
boolean isSessionPermanentByDefault()
When a cookie is automatically added to a
 visitor, should it be permanent (10 years)?
 Otherwise, it will be browser-session long
 only (the default).







getSessionMaxInactiveMinutes
int getSessionMaxInactiveMinutes()
The number of minutes before
 an inactive session is deleted.
 
 Defaults to 7 days.







getDeleteOldSessionsScheduledTaskRunEveryNbrMinutes
int getDeleteOldSessionsScheduledTaskRunEveryNbrMinutes()
The acheduled task to delete old sessions should run 
 every X minutes.







getSessionIdCookieName
String getSessionIdCookieName()
The name of the cookie used to store the
 Session id, by default.







getUpdateNotDirtySessionPeriodInSeconds
int getUpdateNotDirtySessionPeriodInSeconds()
The number of seconds between two updates of the
 modification date of a session, wheen the session
 is not dirty.
 
 This value must be less than
 getSessionMaxInactiveMinutes() or active
 sessions will be deleted!
 

 Note that when something changes on the session 
 the session becomes dirty and is always 
 saved and an updated modification date.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

Modifier and Type	Method and Description
`int`	`getDeleteOldSessionsScheduledTaskRunEveryNbrMinutes()` The acheduled task to delete old sessions should run every X minutes.
`String`	`getSessionIdCookieName()` The name of the cookie used to store the Session id, by default.
`int`	`getSessionMaxInactiveMinutes()` The number of minutes before an inactive session is deleted.
`int`	`getUpdateNotDirtySessionPeriodInSeconds()` The number of seconds between two updates of the modification date of a session, wheen the session is not dirty.
`boolean`	`isSessionPermanentByDefault()` When a cookie is automatically added to a visitor, should it be permanent (10 years)? Otherwise, it will be browser-session long only (the default).