com.goldencode.p2j.security

Class SecurityManager.SessionSecurityManager

java.lang.Object

com.goldencode.p2j.security.SecurityManager.SessionSecurityManager

Enclosing class:

SecurityManager

public class SecurityManager.SessionSecurityManager
extends java.lang.Object

Wrapper class for session related logic.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<SecuritySession>	listOfSess List of sessions.
private int	nextUserSessionID Next available, unique user session ID.

Constructor Summary

Constructors

Constructor and Description
SessionSecurityManager()

Method Summary

Modifier and Type	Method and Description
private SecuritySession	addSession(java.lang.Object sid, java.lang.String uid, SecurityCache sc, SecurityContext cxt) Create a new session object, add it to the session list and return it.
SecuritySession	addSessionDetails(java.lang.String uuid, java.lang.String relatedUuid, java.lang.String osUserName, long pid, java.lang.String driverName, int webPort, java.lang.String sessionDescription, java.lang.String browserWebSocket) Sets the uuid of the current session and the uuid of the original session (when forked).
(package private) SessionInfo[]	getActiveSessions(java.lang.String jar, java.lang.String iface) Get the list of all active sessions which have executed API(s) associated to this jar.
private int	getNextUserSessionID() Retrieve a unique user session ID to assign to a new security context.
SessionInfo	getSessionDescriptor(SecuritySession session) Obtain a descriptor for the given session.
java.lang.Integer	getSessionId() Get the number which uniquely identifies the current context, or null if there is no current context.
(package private) SessionInfo[]	getSessionReport() Creates a report of all current user and process sessions.
SessionToken	getSessionToken() Get the session token which uniquely identifies the current context, or null if there is no current context.
void	killSession(int sid) Forcibly terminates (closes) the socket in use for the given session.
(package private) SecuritySession	locateSession(SecurityContext context) Locates the session in the list of sessions with matching security context.
(package private) SecuritySession	locateSessionById(java.lang.Object sessionId) Locates the session in the list of sessions with matching session id.
private SecuritySession	removeSession(SecurityContext key) Remove the session (which is associated with the given context) from the master session list.
private SecuritySession	removeSessionById(java.lang.Object sessionId) Remove the session (which is associated with the given session id) from the master session list.
private void	removeSessionWorker(SecuritySession session) Remove the given session from the session list.
void	terminateSession(java.lang.Object key) Destroys the security context associated with the given key.
void	terminateSessionById(java.lang.Object sessionId) Destroys the security context associated with the session id.
(package private) void	terminateSessions(java.lang.String jar, java.lang.String iface) Terminate all active sessions which have invoked the given APIs in the given jar.
private void	terminateSessionWorker(SecuritySession session) Destroys the security context associated with the given session.
private void	trackUserSession(java.lang.String uid, boolean add) Maintain tracking state for interactive user sessions.

Methods inherited from class java.lang.Object

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

Field Detail

listOfSess

private java.util.List<SecuritySession> listOfSess

List of sessions.

nextUserSessionID

private int nextUserSessionID

Next available, unique user session ID.

Constructor Detail

SessionSecurityManager

public SessionSecurityManager()

Method Detail

getSessionId

public java.lang.Integer getSessionId()

Get the number which uniquely identifies the current context, or null if there is no current context.

Returns:

Current security context's session ID.

addSessionDetails

public SecuritySession addSessionDetails(java.lang.String uuid,
                                         java.lang.String relatedUuid,
                                         java.lang.String osUserName,
                                         long pid,
                                         java.lang.String driverName,
                                         int webPort,
                                         java.lang.String sessionDescription,
                                         java.lang.String browserWebSocket)
                                  throws RestrictedUseException

Sets the uuid of the current session and the uuid of the original session (when forked).

Parameters:

uuid - The uuid of the session.

relatedUuid - The uuid of the original related session.

osUserName - The OS username.

pid - The pid.

driverName - The client driver name.

webPort - The web client http port.

sessionDescription - The session description from SsoAuthenticator.

browserWebSocket - The browser WebSocket address.

Throws:

RestrictedUseException

getSessionToken

public SessionToken getSessionToken()

Get the session token which uniquely identifies the current context, or null if there is no current context.

Returns:

Current security context's session token.

getActiveSessions

SessionInfo[] getActiveSessions(java.lang.String jar,
                                java.lang.String iface)

Get the list of all active sessions which have executed API(s) associated to this jar.

Parameters:

jar - The name of the target jar file.

iface - The interface for which we need the sessions; if null, search through the entire jar.

Returns:

the list of all active sessions which have executed API(s) associated to this jar.

locateSession

SecuritySession locateSession(SecurityContext context)

Locates the session in the list of sessions with matching security context.

Parameters:

context - security context to look for

Returns:

instance of Session associated with the security context

locateSessionById

SecuritySession locateSessionById(java.lang.Object sessionId)

Locates the session in the list of sessions with matching session id.

Parameters:

sessionId - session id

Returns:

instance of Session associated with the session id

getSessionReport

SessionInfo[] getSessionReport()

Creates a report of all current user and process sessions.

Returns:

Session descriptors suitable for reporting purposes.

getSessionDescriptor

public SessionInfo getSessionDescriptor(SecuritySession session)

Obtain a descriptor for the given session. At this time virtual sessions cannot be inspected.

Parameters:

session - The session on which to report. Must not be null.

Returns:

The descriptor, suitable for reporting on the session details. null will be returned if the session cannot be inspected.

Throws:

java.lang.NullPointerException - If the given session is null.

killSession

public void killSession(int sid)
                 throws RestrictedUseException

Forcibly terminates (closes) the socket in use for the given session. At this time it is not possible to terminate virtual sessions.

Parameters:

sid - Session ID to terminate.

Throws:

java.lang.IllegalStateException - If the given session id is invalid, is associated with a virtual session or if it is associated with the current session being used.

RestrictedUseException

terminateSession

public void terminateSession(java.lang.Object key)
                      throws RestrictedUseException

Destroys the security context associated with the given key.

Restricted use. This method checks the caller to be:

• com.goldencode.p2j.net.BaseSession.cleanupContext()
• com.goldencode.p2j.net.Queue.stop()

Parameters:

key - The security context.

Throws:

RestrictedUseException - If called improperly from unauthorized code.

terminateSessionById

public void terminateSessionById(java.lang.Object sessionId)
                          throws RestrictedUseException

Destroys the security context associated with the session id.

Restricted use. This method checks the caller to be:

• com.goldencode.p2j.admin.server.AuthServiceImpl.logout

Parameters:

sessionId - The session id.

Throws:

RestrictedUseException - If called improperly from unauthorized code.

terminateSessions

void terminateSessions(java.lang.String jar,
                       java.lang.String iface)

Terminate all active sessions which have invoked the given APIs in the given jar. If the jar name is null, terminate all active tracked sessions. This method guarantees that all session termination listeners have been executed.

Parameters:

jar - The jar name; if null, terminate all active tracked sessions.

iface - The interface for which we need to terminate the sessions; if null, terminate all sessions for the given jar.

terminateSessionWorker

private void terminateSessionWorker(SecuritySession session)
                             throws RestrictedUseException

Destroys the security context associated with the given session.

Parameters:

session - The session to terminate.

Throws:

RestrictedUseException - If called improperly from unauthorized code.

removeSession

private SecuritySession removeSession(SecurityContext key)

Remove the session (which is associated with the given context) from the master session list.

Parameters:

key - The security context.

Returns:

The session that was removed.

removeSessionById

private SecuritySession removeSessionById(java.lang.Object sessionId)

Remove the session (which is associated with the given session id) from the master session list.

Parameters:

sessionId - The session id.

Returns:

The session that was removed.

removeSessionWorker

private void removeSessionWorker(SecuritySession session)

Remove the given session from the session list.

Parameters:

session - The session to remove.

getNextUserSessionID

private int getNextUserSessionID()

Retrieve a unique user session ID to assign to a new security context.

Returns:

Unique session ID which is not the reserved, system ID.

addSession

private SecuritySession addSession(java.lang.Object sid,
                                   java.lang.String uid,
                                   SecurityCache sc,
                                   SecurityContext cxt)

Create a new session object, add it to the session list and return it.

Parameters:

sid - The unique session identifier object.

uid - If not null this is an interactive user session which must be tracked.

sc - The current security cache.

cxt - The context to associate with this session.

Returns:

The created session.

trackUserSession

private void trackUserSession(java.lang.String uid,
                              boolean add)

Maintain tracking state for interactive user sessions. This state is used to implement user session limits.

Parameters:

uid - The userid of the interactive account

add - true for adding a new session and false for removing a session.