org.alfresco.bm.common.session

Interface SessionService

All Known Implementing Classes:

AbstractSessionService, MongoSessionService

public interface SessionService

Service providing access and management of SessionData.

Since:

1.4

Author:

Derek Hulley

Method Summary

Modifier and Type	Method and Description
boolean	clear() Clears all recorded data
void	endSession(String sessionId) Mark a session as complete.
long	getActiveSessionsCount() Returns a number of active sessions, i.e.
long	getAllSessionsCount() Returns a number of sessions, active or otherwise
long	getCompletedSessionsCount() Returns a number of completed sessions, i.e.
com.mongodb.DBObject	getSessionData(String sessionId)
long	getSessionElapsedTime(String sessionId) Get the session elapsed time
long	getSessionEndTime(String sessionId) Get the session end time
long	getSessionStartTime(String sessionId) Get the session start time
void	setSessionData(String sessionId, com.mongodb.DBObject data) Update or set the persistable data associated with a session
String	startSession(com.mongodb.DBObject data) Starts a new session, persisting the given data and giving back a unique session ID.

Method Detail

startSession

String startSession(com.mongodb.DBObject data)

Starts a new session, persisting the given data and giving back a unique session ID. The session start time is marked with the current time.

Parameters:

data - a map of session data to be stored (null allowed)

Returns:

a new, unique session ID

endSession

void endSession(String sessionId)

Mark a session as complete.

Parameters:

sessionId - the unique session ID

Throws:

IllegalStateException - if the session has already been ended

RuntimeException - if the session ID is invalid

setSessionData

void setSessionData(String sessionId,
                    com.mongodb.DBObject data)

Update or set the persistable data associated with a session

Parameters:

sessionId - the unique session ID

data - any persistable session data (null allowed)

Throws:

RuntimeException - if the session ID is invalid

getSessionData

com.mongodb.DBObject getSessionData(String sessionId)

Parameters:

sessionId - the unique session ID

Returns:

any data associated with the session or null if there was none

Throws:

RuntimeException - if the session ID is invalid

getSessionStartTime

long getSessionStartTime(String sessionId)

Get the session start time

Parameters:

sessionId - the unique session ID

Returns:

the session start time or -1 if not started

Throws:

RuntimeException - if the session ID is invalid

getSessionEndTime

long getSessionEndTime(String sessionId)

Get the session end time

Parameters:

sessionId - the unique session ID

Returns:

the session start time or -1 if not ended

Throws:

RuntimeException - if the session ID is invalid

getSessionElapsedTime

long getSessionElapsedTime(String sessionId)

Get the session elapsed time

Parameters:

sessionId - the unique session ID

Returns:

the session elapsed time or -1 if not ended

Throws:

RuntimeException - if the session ID is invalid

getActiveSessionsCount

long getActiveSessionsCount()

Returns a number of active sessions, i.e. where endTime = -1

getCompletedSessionsCount

long getCompletedSessionsCount()

Returns a number of completed sessions, i.e. where endTime > 0

getAllSessionsCount

long getAllSessionsCount()

Returns a number of sessions, active or otherwise

clear

boolean clear()

Clears all recorded data

Returns:

true if success, false else

Since:

2.1.4