Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addFilters() - Method in class org.spincast.plugins.session.SpincastSessionFilterAdder
- after(RequestContext<?>) - Method in interface org.spincast.plugins.session.SpincastSessionFilter
- after(RequestContext<?>) - Method in class org.spincast.plugins.session.SpincastSessionFilterDefault
- apply(Module) - Method in class org.spincast.plugins.session.SpincastSessionPlugin
- applyRequiredPlugins(Module) - Method in class org.spincast.plugins.session.SpincastSessionPlugin
- applySpincastScheduledTasksPlugin(Module) - Method in class org.spincast.plugins.session.SpincastSessionPlugin
B
- before(RequestContext<?>) - Method in interface org.spincast.plugins.session.SpincastSessionFilter
- before(RequestContext<?>) - Method in class org.spincast.plugins.session.SpincastSessionFilterDefault
C
- configure() - Method in class org.spincast.plugins.session.SpincastSessionPluginModule
- createNewSession() - Method in interface org.spincast.plugins.session.SpincastSessionFactory
-
Creates a new session.
- createNewSession() - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Creates a new session.
- createNewSession() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- createNewSpincastSession() - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- createSession(String, Instant, Instant, JsonObject) - Method in interface org.spincast.plugins.session.SpincastSessionFactory
-
Creates a session from saved infos.
- createSession(String, Instant, Instant, JsonObject) - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Creates a session from infos, with existing attributes if any (
nullotherwise) - createSession(String, Instant, Instant, JsonObject) - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
D
- deleteCurrentSession() - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Deletes the current session in the request context, if any.
- deleteCurrentSession() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- deleteOldInactiveSession(int) - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- deleteOldInactiveSession(int) - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Deletes the deletes that were inactive for too long.
- deleteOldInactiveSession(int) - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- deleteOldInactiveSession(int) - Method in interface org.spincast.plugins.session.SpincastSessionRepository
-
Deletes the deletes that were inactive for too long.
- deleteSession(String) - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- deleteSession(String) - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Deletes a saved session.
- deleteSession(String) - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- deleteSession(String) - Method in interface org.spincast.plugins.session.SpincastSessionRepository
-
Deletes a saved session.
- deleteSessionIdOnUser() - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Deletes the session id on the user.
- deleteSessionIdOnUser() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- deserializeSession(String) - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
E
- executeSafe(JobExecutionContext) - Method in class org.spincast.plugins.session.SpincastSessionDeleteOldSessionsScheduledTask
G
- generateNewSessionId() - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Generates a new session id.
- generateNewSessionId() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- get() - Method in class org.spincast.plugins.session.config.SpincastSessionPluginScheduledTaskProviderDefault
- getAttributes() - Method in interface org.spincast.plugins.session.SpincastSession
-
Returns a mutable
JsonObjectrepresenting the attributes of the session. - getAttributes() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- getAttributesHash() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- getAttributesInitialHash() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- getAutoAddedFilterAfterPosition() - Method in interface org.spincast.plugins.session.config.SpincastSessionConfig
-
When the session filters are added automatically, this would be the position of the
afterfilter. - getAutoAddedFilterAfterPosition() - Method in class org.spincast.plugins.session.config.SpincastSessionConfigDefault
- getAutoAddedFilterBeforePosition() - Method in interface org.spincast.plugins.session.config.SpincastSessionConfig
-
When the session filters are added automatically, this would be the position of the
beforefilter. - getAutoAddedFilterBeforePosition() - Method in class org.spincast.plugins.session.config.SpincastSessionConfigDefault
- getCookieFactory() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- getCreationDate() - Method in interface org.spincast.plugins.session.SpincastSession
-
The Instant at which the session was created.
- getCreationDate() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- getCurrentSession() - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Gets the session of the current user, from the request context.
- getCurrentSession() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- getDefaultCookieRepositoryCookieName() - Method in interface org.spincast.plugins.session.config.SpincastSessionConfig
-
When the default
SpincastSessionRepositoryrepository is used (we suggest you bind a custom one, based on a database though!), this will be the name of the cookie used to saved the session, on the client. - getDefaultCookieRepositoryCookieName() - Method in class org.spincast.plugins.session.config.SpincastSessionConfigDefault
- getDeleteOldSessionsScheduledTaskRunEveryNbrMinutes() - Method in interface org.spincast.plugins.session.config.SpincastSessionConfig
-
The acheduled task to delete old sessions should run every X minutes.
- getDeleteOldSessionsScheduledTaskRunEveryNbrMinutes() - Method in class org.spincast.plugins.session.config.SpincastSessionConfigDefault
- getId() - Method in interface org.spincast.plugins.session.SpincastSession
-
The unique id of this session.
- getId() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- getId() - Method in class org.spincast.plugins.session.SpincastSessionPlugin
- getJsonManager() - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- getJsonManager() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- getJsonManager() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- getModificationDate() - Method in interface org.spincast.plugins.session.SpincastSession
-
The Instant at which the session was modified for the last time.
- getModificationDate() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- getPluginModule() - Method in class org.spincast.plugins.session.SpincastSessionPlugin
- getRequestContextProvider() - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- getRequestContextProvider() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- getRouter() - Method in class org.spincast.plugins.session.SpincastSessionFilterAdder
- getSavedSession(String) - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Gets a session from the database/data source.
- getSavedSession(String) - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- getSession(String) - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- getSession(String) - Method in interface org.spincast.plugins.session.SpincastSessionRepository
-
Gets a session from the database/data source.
- getSessionAttributeNameCreationDate() - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- getSessionAttributeNameId() - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- getSessionAttributeNameModificationDate() - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- getSessionIdCookieName() - Method in interface org.spincast.plugins.session.config.SpincastSessionConfig
-
The name of the cookie used to store the Session id, by default.
- getSessionIdCookieName() - Method in class org.spincast.plugins.session.config.SpincastSessionConfigDefault
- getSessionIdFromUserRequest(RequestContext<?>) - Method in class org.spincast.plugins.session.SpincastSessionFilterDefault
- getSessionMaxInactiveMinutes() - Method in interface org.spincast.plugins.session.config.SpincastSessionConfig
-
The number of minutes before an inactive session is deleted.
- getSessionMaxInactiveMinutes() - Method in class org.spincast.plugins.session.config.SpincastSessionConfigDefault
- getSpincastConfig() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- getSpincastSessionConfig() - Method in class org.spincast.plugins.session.config.SpincastSessionPluginScheduledTaskProviderDefault
- getSpincastSessionConfig() - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- getSpincastSessionConfig() - Method in class org.spincast.plugins.session.SpincastSessionDeleteOldSessionsScheduledTask
- getSpincastSessionConfig() - Method in class org.spincast.plugins.session.SpincastSessionFilterAdder
- getSpincastSessionConfig() - Method in class org.spincast.plugins.session.SpincastSessionFilterDefault
- getSpincastSessionConfig() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- getSpincastSessionConfigImplClass() - Method in class org.spincast.plugins.session.SpincastSessionPluginModule
- getSpincastSessionDeleteOldSessionsScheduledTask() - Method in class org.spincast.plugins.session.config.SpincastSessionPluginScheduledTaskProviderDefault
- getSpincastSessionFactory() - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- getSpincastSessionFactory() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- getSpincastSessionFilter() - Method in class org.spincast.plugins.session.SpincastSessionFilterAdder
- getSpincastSessionFilterAdderImplClass() - Method in class org.spincast.plugins.session.SpincastSessionPluginModule
- getSpincastSessionFilterImplClass() - Method in class org.spincast.plugins.session.SpincastSessionPluginModule
- getSpincastSessionManager() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- getSpincastSessionManager() - Method in class org.spincast.plugins.session.SpincastSessionDeleteOldSessionsScheduledTask
- getSpincastSessionManager() - Method in class org.spincast.plugins.session.SpincastSessionFilterDefault
- getSpincastSessionManagerImplClass() - Method in class org.spincast.plugins.session.SpincastSessionPluginModule
- getSpincastSessionPluginScheduledTaskProviderImplClass() - Method in class org.spincast.plugins.session.SpincastSessionPluginModule
- getSpincastSessionRepository() - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- getSpincastSessionRepositoryImplClass() - Method in class org.spincast.plugins.session.SpincastSessionPluginModule
- getSpincastUserSessionImplClass() - Method in class org.spincast.plugins.session.SpincastSessionPluginModule
- getTrigger() - Method in class org.spincast.plugins.session.SpincastSessionDeleteOldSessionsScheduledTask
- getUpdateNotDirtySessionPeriodInSeconds() - Method in interface org.spincast.plugins.session.config.SpincastSessionConfig
-
The number of seconds between two updates of the modification date of a session, wheen the session is not dirty.
- getUpdateNotDirtySessionPeriodInSeconds() - Method in class org.spincast.plugins.session.config.SpincastSessionConfigDefault
I
- init() - Method in class org.spincast.plugins.session.SpincastSessionFilterAdder
- invalidate() - Method in interface org.spincast.plugins.session.SpincastSession
-
Sets the session as "not valid anymore".
- invalidate() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- isAutoAddSessionFilters() - Method in interface org.spincast.plugins.session.config.SpincastSessionConfig
-
Should the required before and after filters be added automatically?
- isAutoAddSessionFilters() - Method in class org.spincast.plugins.session.config.SpincastSessionConfigDefault
- isAutoRegisterScheduledTaskToDeleteOldSessions() - Method in class org.spincast.plugins.session.config.SpincastSessionPluginScheduledTaskProviderDefault
- isDirty() - Method in interface org.spincast.plugins.session.SpincastSession
-
Was the session modified since it was loaded?
- isDirty() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- isForcedAsDirty() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- isInvalidated() - Method in interface org.spincast.plugins.session.SpincastSession
-
Has the session been invalidated?
- isInvalidated() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- isNew() - Method in interface org.spincast.plugins.session.SpincastSession
-
Returns
trueif the session has been created in the current request. - isNew() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- isSessionPermanentByDefault() - Method in interface org.spincast.plugins.session.config.SpincastSessionConfig
-
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).
- isSessionPermanentByDefault() - Method in class org.spincast.plugins.session.config.SpincastSessionConfigDefault
- isSkipResources() - Method in class org.spincast.plugins.session.SpincastSessionFilterDefault
- isUpdateModificationDateEvenIfNotDirty(SpincastSession) - Method in class org.spincast.plugins.session.SpincastSessionFilterDefault
L
- logger - Static variable in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- logger - Static variable in class org.spincast.plugins.session.SpincastSessionDeleteOldSessionsScheduledTask
- logger - Static variable in class org.spincast.plugins.session.SpincastSessionManagerDefault
- logger - Static variable in class org.spincast.plugins.session.SpincastSessionPlugin
O
- org.spincast.plugins.session - package org.spincast.plugins.session
- org.spincast.plugins.session.config - package org.spincast.plugins.session.config
- org.spincast.plugins.session.repositories - package org.spincast.plugins.session.repositories
P
- PLUGIN_ID - Static variable in class org.spincast.plugins.session.SpincastSessionPlugin
R
- REQUEST_CONTEXT_VARIABLE_SESSION - Static variable in class org.spincast.plugins.session.SpincastSessionManagerDefault
-
The name of the request context variable used to save the user session.
- ROUTE_ID_AFTER_FILTER - Static variable in interface org.spincast.plugins.session.SpincastSessionFilter
-
The route id of the after filter, if added automatically.
- ROUTE_ID_BEFORE_FILTER - Static variable in interface org.spincast.plugins.session.SpincastSessionFilter
-
The route id of the before filter, if added automatically.
S
- saveSession(SpincastSession) - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- saveSession(SpincastSession) - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Save session.
- saveSession(SpincastSession) - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- saveSession(SpincastSession) - Method in interface org.spincast.plugins.session.SpincastSessionRepository
-
Save a session.
- saveSessionIdOnUser(String, boolean) - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Will save the session id to the user (by default using a cookie).
- saveSessionIdOnUser(String, boolean) - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- saveSessionIdOnUser(RequestContext<?>, String, boolean) - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
- serializeSession(SpincastSession) - Method in class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
- setDirty() - Method in interface org.spincast.plugins.session.SpincastSession
-
This allows you to flag a session as being dirty, even if its attributes don't change.
- setDirty() - Method in class org.spincast.plugins.session.SpincastSessionDefault
- SpincastSession - Interface in org.spincast.plugins.session
-
The object representing the Session of a visitor.
- SpincastSessionConfig - Interface in org.spincast.plugins.session.config
-
Configurations for the Spincast Session plugin.
- SpincastSessionConfigDefault - Class in org.spincast.plugins.session.config
-
Default configurations for Spincast Session plugin.
- SpincastSessionConfigDefault() - Constructor for class org.spincast.plugins.session.config.SpincastSessionConfigDefault
- SpincastSessionDefault - Class in org.spincast.plugins.session
- SpincastSessionDefault(String, Instant, Instant, JsonObject, boolean, boolean, JsonManager, SpincastSessionManager) - Constructor for class org.spincast.plugins.session.SpincastSessionDefault
- SpincastSessionDefault(String, Instant, Instant, JsonObject, boolean, JsonManager, SpincastSessionManager) - Constructor for class org.spincast.plugins.session.SpincastSessionDefault
- SpincastSessionDefault(String, Instant, Instant, JsonObject, JsonManager, SpincastSessionManager) - Constructor for class org.spincast.plugins.session.SpincastSessionDefault
- SpincastSessionDefault(JsonManager, SpincastSessionManager) - Constructor for class org.spincast.plugins.session.SpincastSessionDefault
-
Constructor for a *new* session.
- SpincastSessionDeleteOldSessionsScheduledTask - Class in org.spincast.plugins.session
- SpincastSessionDeleteOldSessionsScheduledTask(SpincastSessionConfig, SpincastSessionManager) - Constructor for class org.spincast.plugins.session.SpincastSessionDeleteOldSessionsScheduledTask
- SpincastSessionFactory - Interface in org.spincast.plugins.session
- SpincastSessionFilter - Interface in org.spincast.plugins.session
-
You should add this filter with the "skipResourcesRequests()" options so it is ignored except for main routes.
- SpincastSessionFilterAdder - Class in org.spincast.plugins.session
- SpincastSessionFilterAdder(SpincastSessionConfig, Router<?, ?>, SpincastSessionFilter) - Constructor for class org.spincast.plugins.session.SpincastSessionFilterAdder
- SpincastSessionFilterDefault - Class in org.spincast.plugins.session
- SpincastSessionFilterDefault(SpincastSessionManager, SpincastSessionConfig) - Constructor for class org.spincast.plugins.session.SpincastSessionFilterDefault
- SpincastSessionManager - Interface in org.spincast.plugins.session
-
Manager for
SpincastSession. - SpincastSessionManagerDefault - Class in org.spincast.plugins.session
- SpincastSessionManagerDefault(SpincastSessionFactory, Provider<RequestContext<?>>, JsonManager, SpincastSessionConfig, SpincastSessionRepository, CookieFactory, SpincastConfig) - Constructor for class org.spincast.plugins.session.SpincastSessionManagerDefault
- SpincastSessionPlugin - Class in org.spincast.plugins.session
-
Spincast Session plugin.
- SpincastSessionPlugin() - Constructor for class org.spincast.plugins.session.SpincastSessionPlugin
- SpincastSessionPluginModule - Class in org.spincast.plugins.session
-
Spincast Session plugin module.
- SpincastSessionPluginModule() - Constructor for class org.spincast.plugins.session.SpincastSessionPluginModule
- SpincastSessionPluginScheduledTaskProvider - Interface in org.spincast.plugins.session.config
-
Provider for the plugin's scheduled tasks.
- SpincastSessionPluginScheduledTaskProviderDefault - Class in org.spincast.plugins.session.config
- SpincastSessionPluginScheduledTaskProviderDefault(SpincastSessionConfig, SpincastSessionDeleteOldSessionsScheduledTask) - Constructor for class org.spincast.plugins.session.config.SpincastSessionPluginScheduledTaskProviderDefault
- SpincastSessionRepository - Interface in org.spincast.plugins.session
-
The repository to CRUD the sessions.
- SpincastSessionRepositoryDefault - Class in org.spincast.plugins.session.repositories
-
The default implementation of
SpincastSessionRepositoryis to save the sessions in a cookie, on the user. - SpincastSessionRepositoryDefault(Provider<RequestContext<?>>, SpincastSessionConfig, SpincastSessionFactory, JsonManager) - Constructor for class org.spincast.plugins.session.repositories.SpincastSessionRepositoryDefault
T
- toString() - Method in class org.spincast.plugins.session.SpincastSessionDefault
U
- updateModificationDateAndSaveSession(SpincastSession) - Method in interface org.spincast.plugins.session.SpincastSessionManager
-
Saves a session, but update its modification date first.
- updateModificationDateAndSaveSession(SpincastSession) - Method in class org.spincast.plugins.session.SpincastSessionManagerDefault
All Classes and Interfaces|All Packages|Constant Field Values