Class UserPool

java.lang.Object

org.deltava.security.UserPool

public class UserPool
extends Object

A singleton class for tracking connected and blocked users.

Since:

1.0

Version:

9.0

Author:

Luke

Method Summary

Modifier and Type	Method	Description
static void	add(Pilot p, String sessionID, IPBlock addrInfo, String userAgent)	Adds a person to the user pool.
static void	block(Person p)	Locks a user out of the application.
static boolean	contains(int userID)	Queries whether a particular user is currently logged in.
static int	getMaxSize()	Returns the maximum number of concurrent users.
static Instant	getMaxSizeDate()	Returns the date when the maximum number of concurrent users occurred.
static Collection<UserSession>	getPilots()	Returns all logged in Pilots and their browser types.
static int	getSize()	Returns the number of logged-in users.
static void	init(int maxSize, Instant maxSizeDate)	Initializes the maximum size values.
static boolean	isBlocked(Person usr)	Queries whether a particular user is locked out of the system.
static void	remove(Person p, String sessionID)	Removes a person from the user pool, provided that the supplied Session ID matches.
static void	unblock(Person p)	Unlocks a user from the application.

Methods inherited from class java.lang.Object

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

Method Details

add

public static void add(Pilot p,
 String sessionID,
 IPBlock addrInfo,
 String userAgent)

Adds a person to the user pool. See the notes for remove(Person, String) for an explanation of why we add the session ID.

Parameters:

p - the Pilot to add

sessionID - the session ID

addrInfo - the user's IP address block

userAgent - the User-Agent header

See Also:

• remove(Person, String)

block

public static void block(Person p)

Locks a user out of the application.

Parameters:

p - the user to block

See Also:

• isBlocked(Person)

unblock

public static void unblock(Person p)

Unlocks a user from the application.

Parameters:

p - the Person to block

remove

public static void remove(Person p,
 String sessionID)

Removes a person from the user pool, provided that the supplied Session ID matches. This additional check is performed because this method is usually called from a session lifecycle handler, and a session for a user may timeout after that same user has launched a new session. In such a circumstance, we do not want to remove the user from the pool.

Parameters:

p - the Person to remove

sessionID - the session ID to match

See Also:

• add(Pilot, String, IPBlock, String)

contains

public static boolean contains(int userID)

Queries whether a particular user is currently logged in.

Parameters:

userID - The database ID of the person

Returns:

TRUE if the user is logged in, otherwise FALSE

See Also:

• DatabaseBean.getID()
• isBlocked(Person)

isBlocked

public static boolean isBlocked(Person usr)

Queries whether a particular user is locked out of the system.

Parameters:

usr - the Pilot bean

Returns:

TRUE if the user is locked out, otherwise FALSE

See Also:

• DatabaseBean.getID()
• contains(int)
• block(Person)

getPilots

public static Collection<UserSession> getPilots()

Returns all logged in Pilots and their browser types.

Returns:

a Map of user agents, keyed by Pilot

getSize

public static int getSize()

Returns the number of logged-in users.

Returns:

the number of concurrent users

getMaxSize

public static int getMaxSize()

Returns the maximum number of concurrent users.

Returns:

the maxmimum number of concurrent users

See Also:

• getMaxSizeDate()

getMaxSizeDate

public static Instant getMaxSizeDate()

Returns the date when the maximum number of concurrent users occurred.

Returns:

the date/time when the maximum user count was reached

See Also:

• getMaxSize()

init

public static void init(int maxSize,
 Instant maxSizeDate)

Initializes the maximum size values.

Parameters:

maxSize - the maximum number of users

maxSizeDate - the date the maximum concurrent users was reached