oracle.toplink.tools.sessionmanagement
Class SessionManager

java.lang.Object
  |
  +--oracle.toplink.tools.sessionmanagement.SessionManager

public class SessionManager

extends java.lang.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

Constructor Summary

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

Method Summary

Type	Method
void	addSession(java.lang.String sessionName, Session session) ADVANCED: add an named session to the hashtable.
Session	getDefaultSession() PUBLIC: Return the default session.
static SessionManager	getManager() PUBLIC: Return the singleton session manager.
Session	getSession(java.lang.String sessionName) PUBLIC: Return the session by name.
Session	getSession(java.lang.String sessionName, java.lang.ClassLoader objectClassLoader) PUBLIC: Return the session by name.
Session	getSession(java.lang.String sessionName, java.lang.Object objectBean) Deprecated.
Session	getSession(XMLLoader xmlLoader, java.lang.String sessionName, java.lang.ClassLoader objectClassLoader) PUBLIC: Return the session by name, loading the configuration from the file specified in the xmlLoader.
Session	getSession(XMLLoader xmlLoader, java.lang.String sessionName, java.lang.ClassLoader objectClassLoader, boolean shouldLoginSession, boolean shouldRefreshSession) PUBLIC: Return the session by name, loading the configuration from the file specified in the xmlLoader.
void	setDefaultSession(Session defaultSession) PUBLIC: Set the default session.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionManager

public SessionManager()

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

Method Detail

addSession

public void addSession(java.lang.String sessionName,
                       Session session)

ADVANCED: add an named session to the hashtable.

getDefaultSession

public Session getDefaultSession()

PUBLIC: Return the default session. The session configuration is stored in a TopLink.properties file in a directory on your classpath. Other sessions are supported through the getSession by name API.

getManager

public static SessionManager getManager()

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

getSession

public Session getSession(java.lang.String sessionName)

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

getSession

public Session getSession(java.lang.String sessionName,
                          java.lang.Object objectBean)

Deprecated.

PUBLIC: Return the session by name, using the classloader of the Object specified. This method is used in older versions of BMP support

getSession

public Session getSession(java.lang.String sessionName,
                          java.lang.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());

getSession

public Session getSession(XMLLoader xmlLoader,
                          java.lang.String sessionName,
                          java.lang.ClassLoader objectClassLoader)

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. If the no sessions.xml file is found in the classpath then an attempt is made to load the TOPLink.properties.

getSession

public Session getSession(XMLLoader xmlLoader,
                          java.lang.String sessionName,
                          java.lang.ClassLoader objectClassLoader,
                          boolean shouldLoginSession,
                          boolean shouldRefreshSession)

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 xmlLoader should reparse the configuration file for new sessions. False, will cause the XMLLoader not to parse the file again.

setDefaultSession

public void setDefaultSession(Session defaultSession)

PUBLIC: Set the default session. If not set the session configuration is stored in a TopLink.properties file in a TopLink directory on your classpath. Other sessions are supported through the getSession by name API.