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

Go to download

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







SpincastSession (org.spincast:spincast-framework 1.2.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
Interface SpincastSession






All Known Implementing Classes:
SpincastSessionDefault




public interface SpincastSession
The object representing the Session of a visitor.











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


JsonObject
getAttributes()
Returns a mutable JsonObject representing the
 attributes of the session.



Instant
getCreationDate()
The Instant at which the session was created.



String
getId()
The unique id of this session.



Instant
getModificationDate()
The Instant at which the session was modified
 for the last time.



void
invalidate()
Sets the session as "not valid anymore".



boolean
isDirty()
Was the session modified since it was loaded?



boolean
isInvalidated()
Has the session been invalidated?



boolean
isNew()
Returns true if the session
 has been created in the current request.



void
setDirty()
This allows you to flag a session as being
 dirty, even if its attributes don't change.
















Method Detail





getId
String getId()
The unique id of this session.







isNew
boolean isNew()
Returns true if the session
 has been created in the current request.







getAttributes
JsonObject getAttributes()
Returns a mutable JsonObject representing the
 attributes of the session. You can use this object
 to get/retrieve/delete attributes.







getCreationDate
Instant getCreationDate()
The Instant at which the session was created.







getModificationDate
Instant getModificationDate()
The Instant at which the session was modified
 for the last time.







isDirty
boolean isDirty()
Was the session modified since it was loaded?







setDirty
void setDirty()
This allows you to flag a session as being
 dirty, even if its attributes don't change.
 This will force the session to be saved in
 the database.







invalidate
void invalidate()
Sets the session as "not valid anymore".







isInvalidated
boolean isInvalidated()
Has the session been invalidated?













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
`JsonObject`	`getAttributes()` Returns a mutable `JsonObject` representing the attributes of the session.
`Instant`	`getCreationDate()` The Instant at which the session was created.
`String`	`getId()` The unique id of this session.
`Instant`	`getModificationDate()` The Instant at which the session was modified for the last time.
`void`	`invalidate()` Sets the session as "not valid anymore".
`boolean`	`isDirty()` Was the session modified since it was loaded?
`boolean`	`isInvalidated()` Has the session been invalidated?
`boolean`	`isNew()` Returns `true` if the session has been created in the current request.
`void`	`setDirty()` This allows you to flag a session as being dirty, even if its attributes don't change.