oracle.toplink.essentials.tools.sessionmanagement

Class SessionManager

java.lang.Object

oracle.toplink.essentials.tools.sessionmanagement.SessionManager

public class SessionManager
extends Object

Purpose: Global session location.

Description: This allows for a global session local which can be accessed globally from other classes. This is needed for EJB data stores as they must have a globally accessible place to access the session. This can be by EJB session beans, BMP beans and CMP beans as well as Servlets and other three-tier services.

Responsibilities:

• Store a global session.
• Allow the storage of alternative sessions as well.

Since:

TOPLink/Java 3.0

Author:

James Sutherland

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractSession	defaultSession
protected static SessionManager	manager
protected Hashtable	sessions

Constructor Summary

Constructors

Constructor and Description
SessionManager() PUBLIC: The default constructor to create a new session manager.

Method Summary

Modifier and Type	Method and Description
void	addSession(Session session) INTERNAL: add an named session to the hashtable.
void	addSession(String sessionName, Session session) ADVANCED: add an named session to the hashtable.
void	destroyAllSessions() INTERNAL: Destroy all sessions held onto by this manager.
void	destroySession(String sessionName) INTERNAL: Destroy the session defined by sessionName on this manager.
Session	getDefaultSession() PUBLIC: Return the default session.
static SessionManager	getManager() PUBLIC: Return the singleton session manager.
AbstractSession	getSession(String sessionName) PUBLIC: Return the session by name.
AbstractSession	getSession(String sessionName, boolean shouldLoginSession) PUBLIC: Return the session by name.
AbstractSession	getSession(String sessionName, boolean shouldLoginSession, boolean shouldRefreshSession) PUBLIC: Return the session by name.
AbstractSession	getSession(String sessionName, ClassLoader objectClassLoader) PUBLIC: Return the session by name.
AbstractSession	getSession(String sessionName, ClassLoader objectClassLoader, boolean shouldLoginSession, boolean shouldRefreshSession, boolean shouldCheckClassLoader) PUBLIC: Return the session by name, loading the configuration from the file specified in the xmlLoader.
Hashtable	getSessions() INTERNAL: Return a hashtable on all sessions.
void	setDefaultSession(Session defaultSession) PUBLIC: Set the default session.
static void	setManager(SessionManager theManager) INTERNAL: Set the singleton session manager.
void	setSessions(Hashtable sessions) INTERNAL: Set a hashtable of all sessions

Methods inherited from class java.lang.Object

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

Field Detail

manager

protected static SessionManager manager

defaultSession

protected AbstractSession defaultSession

sessions

protected Hashtable sessions

Constructor Detail

SessionManager

public SessionManager()

PUBLIC: The default constructor to create a new session manager.

Method Detail

addSession

public void addSession(Session session)

INTERNAL: add an named session to the hashtable. session must have a name prior to setting into session Manager

addSession

public void addSession(String sessionName,
                       Session session)

ADVANCED: add an named session to the hashtable.

getDefaultSession

public Session getDefaultSession()

PUBLIC: Return the default session.

destroySession

public void destroySession(String sessionName)

INTERNAL: Destroy the session defined by sessionName on this manager.

destroyAllSessions

public void destroyAllSessions()

INTERNAL: Destroy all sessions held onto by this manager.

getManager

public static SessionManager getManager()

PUBLIC: Return the singleton session manager. This allow global access to a set of named sessions.

getSession

public AbstractSession getSession(String sessionName)

PUBLIC: Return the session by name. Use the classLoader that loaded the SessionManager.

getSession

public AbstractSession getSession(String sessionName,
                                  boolean shouldLoginSession)

PUBLIC: Return the session by name. Use the classLoader that loaded the SessionManager. Log the session in only if the user specifies to.

getSession

public AbstractSession getSession(String sessionName,
                                  boolean shouldLoginSession,
                                  boolean shouldRefreshSession)

PUBLIC: Return the session by name. Use the classLoader that loaded the SessionManager. Log the session in only if the user specifies to. Refresh the session only if the user specifies to.

getSession

public AbstractSession getSession(String sessionName,
                                  ClassLoader objectClassLoader)

PUBLIC: Return the session by name. Provide the class loader for loading the project, the configuration file and the deployed classes. E.g. SessionManager.getManager().getSession("mySession", MySessionBean.getClassLoader()); This method will cause the class loader to be compared with the classloader used to load the original session of this name, with this classloader. If they are not the same then the session will be refreshed.

getSession

public AbstractSession getSession(String sessionName,
                                  ClassLoader objectClassLoader,
                                  boolean shouldLoginSession,
                                  boolean shouldRefreshSession,
                                  boolean shouldCheckClassLoader)

PUBLIC: Return the session by name, loading the configuration from the file specified in the xmlLoader. Provide the class loader for loading the project, the configuration file and the deployed classes. Pass in true for shouldLoginSession if the session returned should be logged in before returned otherwise false. Pass in true for shouldRefreshSession if the XMLSessionConfigLoader should reparse the configuration file for new sessions. False, will cause the XMLSessionConfigLoader not to parse the file again. This method will cause the class loader to be compared with the classloader used to load the original session of this name, with this classloader. If they are not the same then the session will be refreshed.

setSessions

public void setSessions(Hashtable sessions)

INTERNAL: Set a hashtable of all sessions

getSessions

public Hashtable getSessions()

INTERNAL: Return a hashtable on all sessions.

setDefaultSession

public void setDefaultSession(Session defaultSession)

PUBLIC: Set the default session. Other sessions are supported through the getSession by name API.

setManager

public static void setManager(SessionManager theManager)

INTERNAL: Set the singleton session manager. This allows global access to a set of named sessions.