org.alfresco.bm.common.session

Class AbstractSessionService

java.lang.Object

org.alfresco.bm.common.session.AbstractSessionService

All Implemented Interfaces:

SessionService

Direct Known Subclasses:

MongoSessionService

public abstract class AbstractSessionService
extends Object
implements SessionService

Abstract implemnetation for methods that don't persist or retrieve values directly.

Since:

1.4

Author:

Derek Hulley

Constructor Summary

Constructors

Constructor and Description
AbstractSessionService()

Method Summary

Modifier and Type	Method and Description
void	endSession(String sessionId) Mark a session as complete.
protected abstract SessionData	findSessionData(String sessionId) Find session data for the given ID
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
protected abstract String	newSession(SessionData sessionData) Persist session data.
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.
protected abstract boolean	updateSessionData(String sessionId, com.mongodb.DBObject data) Update session's client-provided data matching the ID.
protected abstract void	updateSessionEndTime(String sessionId, long endTime) Update session end time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.alfresco.bm.common.session.SessionService

clear, getActiveSessionsCount, getAllSessionsCount, getCompletedSessionsCount

Constructor Detail

AbstractSessionService

public AbstractSessionService()

Method Detail

newSession

protected abstract String newSession(SessionData sessionData)

Persist session data.

All session IDs must be unique.

findSessionData

protected abstract SessionData findSessionData(String sessionId)

Find session data for the given ID

Returns:

all the session info or null if not found

updateSessionEndTime

protected abstract void updateSessionEndTime(String sessionId,
                                             long endTime)

Update session end time.

updateSessionData

protected abstract boolean updateSessionData(String sessionId,
                                             com.mongodb.DBObject data)

Update session's client-provided data matching the ID.

Returns:

true if the session was updated

startSession

public String startSession(com.mongodb.DBObject data)

Description copied from interface: SessionService

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.

Specified by:

startSession in interface SessionService

Parameters:

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

Returns:

a new, unique session ID

endSession

public void endSession(String sessionId)

Description copied from interface: SessionService

Mark a session as complete.

Specified by:

endSession in interface SessionService

Parameters:

sessionId - the unique session ID

setSessionData

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

Description copied from interface: SessionService

Update or set the persistable data associated with a session

Specified by:

setSessionData in interface SessionService

Parameters:

sessionId - the unique session ID

data - any persistable session data (null allowed)

getSessionData

public com.mongodb.DBObject getSessionData(String sessionId)

Specified by:

getSessionData in interface SessionService

Parameters:

sessionId - the unique session ID

Returns:

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

getSessionStartTime

public long getSessionStartTime(String sessionId)

Description copied from interface: SessionService

Get the session start time

Specified by:

getSessionStartTime in interface SessionService

Parameters:

sessionId - the unique session ID

Returns:

the session start time or -1 if not started

getSessionEndTime

public long getSessionEndTime(String sessionId)

Description copied from interface: SessionService

Get the session end time

Specified by:

getSessionEndTime in interface SessionService

Parameters:

sessionId - the unique session ID

Returns:

the session start time or -1 if not ended

getSessionElapsedTime

public long getSessionElapsedTime(String sessionId)

Description copied from interface: SessionService

Get the session elapsed time

Specified by:

getSessionElapsedTime in interface SessionService

Parameters:

sessionId - the unique session ID

Returns:

the session elapsed time or -1 if not ended