Package de.uplanet.lucy.server.portalserver

Class LoggedOnUsers

java.lang.Object

de.uplanet.lucy.server.portalserver.LoggedOnUsers

@Scriptable
public final class LoggedOnUsers
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static IFilter<IUser>	FILTER_ACCEPT_ALL
static IFilter<IUser>	FILTER_ACCEPT_ANONYMOUS

Method Summary

Modifier and Type	Method	Description
static int	getActiveSessionCount()	Get the number of active sessions.
static List<IUser>	getLoggedOnUsers(boolean p_bIncludeAnonymous)	Get a list of users that are currently logged in.
static List<IUser>	getLoggedOnUsers(boolean p_bIncludeAnonymous, groovy.lang.Closure<?> p_closure)	Get a list of users that are currently logged in.
static List<IUser>	getLoggedOnUsers(IFilter<IUser> p_filter, boolean p_bIncludeAnonymous)	Get a list of users that are currently logged in.
static List<IUser>	getLoggedOnUsersDistinct()	Get a distinct list of non-anonymous users that are currently logged in.
static List<IUser>	getLoggedOnUsersDistinct(IFilter<IUser> p_filter)	Get a distinct list of non-anonymous users that pass the given filter and that are currently logged in.
static List<IUser>	getLoggedOnUsersDistinct(groovy.lang.Closure<?> p_closure)	Get a distinct list of non-anonymous users that pass the given filter and that are currently logged in.
static int	getNonAnonymousActiveSessionCount()	Get the number of non-anonymous active sessions.
static boolean	isUserOnline(String p_strUserId)	Test if the specified user is online, i.e.

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_ACCEPT_ALL

public static final IFilter<IUser> FILTER_ACCEPT_ALL

FILTER_ACCEPT_ANONYMOUS

public static final IFilter<IUser> FILTER_ACCEPT_ANONYMOUS

Method Detail

getActiveSessionCount

public static int getActiveSessionCount()

Get the number of active sessions.

Returns:

The number of active sessions.

getNonAnonymousActiveSessionCount

public static int getNonAnonymousActiveSessionCount()

Get the number of non-anonymous active sessions.

Returns:

The number of active sessions.

isUserOnline

public static boolean isUserOnline(String p_strUserId)

Test if the specified user is online, i.e. if she or he has an associated session.

Parameters:

p_strUserId - The user's unique identifier.

Returns:

true if the user is online, false otherwise.

getLoggedOnUsers

public static List<IUser> getLoggedOnUsers(boolean p_bIncludeAnonymous)

Get a list of users that are currently logged in.

If a user is logged in multiple times, the list contains an entry for each active user session.

Parameters:

p_bIncludeAnonymous - true if the list should include anonymous users, or false otherwise.

Returns:

The (possibly empty) list of requested users.

getLoggedOnUsers

public static List<IUser> getLoggedOnUsers(boolean p_bIncludeAnonymous,
                                           groovy.lang.Closure<?> p_closure)

Get a list of users that are currently logged in.

If a user is logged in multiple times, the list contains an entry for each active user session.

Parameters:

p_bIncludeAnonymous - true if the list should include anonymous users, or false otherwise.

p_closure - A closure that filters users.

Returns:

The (possibly empty) list of requested users.

getLoggedOnUsers

public static List<IUser> getLoggedOnUsers(IFilter<IUser> p_filter,
                                           boolean p_bIncludeAnonymous)

Get a list of users that are currently logged in.

If a user is logged in multiple times, the list contains an entry for each active user session.

Parameters:

p_bIncludeAnonymous - true if the list should include anonymous users, or false otherwise.

p_filter - A filter for users.

Returns:

The (possibly empty) list of requested users.

getLoggedOnUsersDistinct

public static List<IUser> getLoggedOnUsersDistinct()

Get a distinct list of non-anonymous users that are currently logged in.

Returns:

The (possibly empty) list of requested users.

getLoggedOnUsersDistinct

public static List<IUser> getLoggedOnUsersDistinct(groovy.lang.Closure<?> p_closure)

Get a distinct list of non-anonymous users that pass the given filter and that are currently logged in.

Parameters:

p_closure - A closure that filters users.

Returns:

The (possibly empty) list of requested users.

getLoggedOnUsersDistinct

public static List<IUser> getLoggedOnUsersDistinct(IFilter<IUser> p_filter)

Get a distinct list of non-anonymous users that pass the given filter and that are currently logged in.

Parameters:

p_filter - A filter for users.

Returns:

The (possibly empty) list of requested users.