com.groiss.org
Class UserSessionManager

java.lang.Object
  com.groiss.org.UserSessionManager

All Implemented Interfaces:

com.groiss.servlet.impl.UserSessionManager, EventListener, HttpSessionAttributeListener, HttpSessionListener

public class UserSessionManager
extends Object
implements HttpSessionListener, HttpSessionAttributeListener, com.groiss.servlet.impl.UserSessionManager

Maintains user sessions

Field Summary

static short	INFO
static short	WARNING

Constructor Summary

UserSessionManager()

Method Summary

static boolean	addPendingAction(short type, String id, String message) Add a pending action to the user session which is visible later via an icon in the toolbar.
static boolean	addRestartAction() This method calls addPendingAction with the parameters WARNING, restart, and an appropriate message for the restart.
void	attributeAdded(HttpSessionBindingEvent arg0)
void	attributeRemoved(HttpSessionBindingEvent arg0)
void	attributeReplaced(HttpSessionBindingEvent ev)
static void	deleteUserSessions(int days) Delete all sessions older than the given dates
static List<com.groiss.org.impl.UserSession>	getActiveSessions() return the list of users currently logged in
static List<com.groiss.org.impl.UserSession>	getActiveSessions(String node) return the list of users currently logged in at a node
static List<com.groiss.org.impl.UserSession>	getConcurrentSessions() return the list of userssessions which count for concurrent licenses
static int	getConcurrentUsers()
static String	getLoginMessage()
static int	getMaxConcurrent(Date since, Date until)
static IUserSession	getSessionById(String sessionId) called when session are read from dumped file after restart.
static List<com.groiss.org.impl.UserSession>	getSessions(Boolean active, Date since, Date until, com.dec.avw.core.User u) The sessions selected by date and/or user.
static boolean	hasPendingAction(short type, String id) Check if a pending action has been added to the user session.
static void	init()
static void	initSessions() On startup set namedUsers and put user session in httpSessions
boolean	isActiveSession(String id)
static boolean	isLoggedIn(com.dec.avw.core.User user)
static boolean	isLoginAllowed()
static String	login(com.dec.avw.core.User user, String ip) Called on login of a user
static String	login(com.dec.avw.core.User user, String ip, boolean interactive, short sessiontype)
static void	logout(String sessionId) End the session with the given session id (if session is already finished, do nothing).
static void	logout(com.groiss.org.impl.UserSession ss) End the session (if session is already finished, do nothing).
static void	removeInactiveSessions() Performs a logout for all users, where the http session is expired.
static void	removePendindActions()
static void	removePendingAction(short type, String id)
static void	removeSession(String sessionId)
void	sessionCreated(HttpSessionEvent e)
void	sessionDestroyed(HttpSessionEvent e)
static void	setLoginAllowed(boolean allow, String message)
static void	setSessionEventHandler(com.groiss.org.impl.UserSessionEventHandler seh)
static void	updateLastAccessOnSessions()

Methods inherited from class java.lang.Object

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

Field Detail

INFO

public static final short INFO

See Also:

Constant Field Values

WARNING

public static final short WARNING

See Also:

Constant Field Values

Constructor Detail

UserSessionManager

public UserSessionManager()

Method Detail

init

public static void init()

login

public static String login(com.dec.avw.core.User user,
                           String ip)

Called on login of a user

Returns:

the session id

setSessionEventHandler

public static void setSessionEventHandler(com.groiss.org.impl.UserSessionEventHandler seh)

login

public static String login(com.dec.avw.core.User user,
                           String ip,
                           boolean interactive,
                           short sessiontype)

getSessionById

public static IUserSession getSessionById(String sessionId)
                                   throws Exception

called when session are read from dumped file after restart.

Throws:

Exception

logout

public static void logout(String sessionId)
                   throws Exception

End the session with the given session id (if session is already finished, do nothing).

Throws:

Exception

logout

public static void logout(com.groiss.org.impl.UserSession ss)
                   throws Exception

End the session (if session is already finished, do nothing).

Throws:

Exception

removeSession

public static void removeSession(String sessionId)

getActiveSessions

public static List<com.groiss.org.impl.UserSession> getActiveSessions()

return the list of users currently logged in

getActiveSessions

public static List<com.groiss.org.impl.UserSession> getActiveSessions(String node)

return the list of users currently logged in at a node

getConcurrentSessions

public static List<com.groiss.org.impl.UserSession> getConcurrentSessions()

return the list of userssessions which count for concurrent licenses

getMaxConcurrent

public static int getMaxConcurrent(Date since,
                                   Date until)

getSessions

public static List<com.groiss.org.impl.UserSession> getSessions(Boolean active,
                                                                Date since,
                                                                Date until,
                                                                com.dec.avw.core.User u)

The sessions selected by date and/or user. All params may be null.

Parameters:

active - if True show only active users

since - login since this timestamp

until - logins until this timestamp

u - only for this user

Returns:

isLoggedIn

public static boolean isLoggedIn(com.dec.avw.core.User user)

setLoginAllowed

public static void setLoginAllowed(boolean allow,
                                   String message)
                            throws IOException

Throws:

IOException

getConcurrentUsers

public static int getConcurrentUsers()

isLoginAllowed

public static boolean isLoginAllowed()

getLoginMessage

public static String getLoginMessage()

removeInactiveSessions

public static void removeInactiveSessions()

Performs a logout for all users, where the http session is expired. Necessary when session have been loaded by this class but not via http-server

updateLastAccessOnSessions

public static void updateLastAccessOnSessions()

initSessions

public static void initSessions()

On startup set namedUsers and put user session in httpSessions

sessionCreated

public void sessionCreated(HttpSessionEvent e)

Specified by:

sessionCreated in interface HttpSessionListener

sessionDestroyed

public void sessionDestroyed(HttpSessionEvent e)

Specified by:

sessionDestroyed in interface HttpSessionListener

attributeAdded

public void attributeAdded(HttpSessionBindingEvent arg0)

Specified by:

attributeAdded in interface HttpSessionAttributeListener

attributeRemoved

public void attributeRemoved(HttpSessionBindingEvent arg0)

Specified by:

attributeRemoved in interface HttpSessionAttributeListener

attributeReplaced

public void attributeReplaced(HttpSessionBindingEvent ev)

Specified by:

attributeReplaced in interface HttpSessionAttributeListener

deleteUserSessions

public static void deleteUserSessions(int days)
                               throws Exception

Delete all sessions older than the given dates

Throws:

Exception

addPendingAction

public static boolean addPendingAction(short type,
                                       String id,
                                       String message)

Add a pending action to the user session which is visible later via an icon in the toolbar.

Parameters:

type - either INFO or WARNING

id - the id of the action, it is used to remove actions.

message - the already translated message a HTML text

Returns:

true if the action was possible

hasPendingAction

public static boolean hasPendingAction(short type,
                                       String id)

Check if a pending action has been added to the user session.

Parameters:

type - either INFO or WARNING

id - the id of the action.

Returns:

true if the action already has been in the user session.

addRestartAction

public static boolean addRestartAction()

This method calls addPendingAction with the parameters WARNING, restart, and an appropriate message for the restart. It remove all other pending actions (not infos).

Returns:

true if the action was possible

removePendingAction

public static void removePendingAction(short type,
                                       String id)

removePendindActions

public static void removePendindActions()

isActiveSession

public boolean isActiveSession(String id)

Specified by:

isActiveSession in interface com.groiss.servlet.impl.UserSessionManager