org.finra.jtaf.ewd.session

Class SessionManager

java.lang.Object

org.finra.jtaf.ewd.session.SessionManager

public class SessionManager
extends Object

SessionManager for the testing framework. Uses a ThreadLocal so each thread of test execution has its own manager instance.

Method Summary

Modifier and Type	Method and Description
ExtWebDriver	getCurrentSession() Convenience method for getting the current ExtWebDriver session associated with this SessionManager, creating a new session if the session does not exist.
ExtWebDriver	getCurrentSession(boolean createIfNotFound) Get the current session associated with this thread.
String	getCurrentSessionId() Get the ID of the current ExtWebDriver session associated with this SessionManager
static SessionManager	getInstance() Obtain the ThreadLocal instance of SessionManager.
ExtWebDriver	getNewSession() Create and return a new ExtWebDriver session with default options, and set it as the current session for this SessionManager.
ExtWebDriver	getNewSession(boolean setAsCurrent) Create and return new ExtWebDriver instance with default options.
ExtWebDriver	getNewSession(Map<String,String> override) Create and return a new ExtWebDriver instance.
ExtWebDriver	getNewSession(Map<String,String> override, boolean setAsCurrent) Create and return a new ExtWebDriver instance.
ExtWebDriver	getNewSession(String key, String value) Create and return a new ExtWebDriver instance.
ExtWebDriver	getNewSession(String key, String value, boolean setAsCurrent) Create and return a new ExtWebDriver instance.
ExtWebDriver	getSession(String sessionId) Get an existing ExtWebDriver session with the given ID.
Map<String,ExtWebDriver>	getSessions() Get the Map of all ExtWebDriver sessions associated with this SessionManager instance.
void	removeSession(ExtWebDriver session) Remove the given session from SessionManager based on its stored ID.
void	removeSession(String sessionId) Remove a session with the given ID from this SessionManager
SessionManager	setSessionFactory(SessionFactory impl) Configure the current instance of SessionManager to use the given SessionFactory instance as its SessionFactory, returning the newly configured instance.
void	switchToSession(ExtWebDriver ewd) Switch the current session to be the provided ExtWebDriver instance.
void	switchToSession(String sessionId) Switch the current session to be the ExtWebDriver session with the given ID.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SessionManager getInstance()

Obtain the ThreadLocal instance of SessionManager. Configures the instance to use DefaultSessionFactory()

Returns:

SessionManager, the ThreadLocal instance of SessionManager

See Also:

setSessionFactory

setSessionFactory

public SessionManager setSessionFactory(SessionFactory impl)

Configure the current instance of SessionManager to use the given SessionFactory instance as its SessionFactory, returning the newly configured instance. With this method, obtaining a SessionManager configured to use a custom SessionFactory can be done with SessionManager.getInstance().setSessionFactory(new ustomSessionFactory()).

Parameters:

impl - a SessionFactory instance to be associated with this manager

Returns:

SessionManager

See Also:

getInstance

getCurrentSession

public ExtWebDriver getCurrentSession(boolean createIfNotFound)

Get the current session associated with this thread. Because a SessionManager instance is thread-local, the notion of current is also specific to a thread.

Parameters:

createIfNotFound - set to true if a session should be created if no session is associated with the current sessionId

Returns:

ExtWebDriver an ExtWebDriver instance

See Also:

getCurrentSession(), getSession(String), switchToSession(String)

getCurrentSession

public ExtWebDriver getCurrentSession()

Convenience method for getting the current ExtWebDriver session associated with this SessionManager, creating a new session if the session does not exist.

Returns:

ExtWebDriver an instance of ExtWebDriver

getSession

public ExtWebDriver getSession(String sessionId)

Get an existing ExtWebDriver session with the given ID.

Parameters:

sessionId -

Returns:

getSessions

public Map<String,ExtWebDriver> getSessions()

Get the Map of all ExtWebDriver sessions associated with this SessionManager instance.

Returns:

switchToSession

public void switchToSession(String sessionId)

Switch the current session to be the ExtWebDriver session with the given ID. A session with this ID should have already been previously created.

Parameters:

sessionId -

switchToSession

public void switchToSession(ExtWebDriver ewd)

Switch the current session to be the provided ExtWebDriver instance. This method assumes that the provided session was created within the scope of the current thread (since session IDs are only required to be thread-local, as are sessions themselves).

Parameters:

ewd -

getCurrentSessionId

public String getCurrentSessionId()

Get the ID of the current ExtWebDriver session associated with this SessionManager

Returns:

removeSession

public void removeSession(String sessionId)

Remove a session with the given ID from this SessionManager

Parameters:

sessionId - the ID of the session to be removed

removeSession

public void removeSession(ExtWebDriver session)

Remove the given session from SessionManager based on its stored ID. Note that the session must have been created with this same thread as sessions and unique IDs are only required to be thread-local and not global.

Parameters:

session - the ExtWebDriver session to be removed

getNewSession

public ExtWebDriver getNewSession()
                           throws Exception

Create and return a new ExtWebDriver session with default options, and set it as the current session for this SessionManager.

Returns:

A new ExtWebDriver instance with auto-generated ID. You can obtain the Session ID with ExtWebDriver.getSessionId().

Throws:

Exception

getNewSession

public ExtWebDriver getNewSession(boolean setAsCurrent)
                           throws Exception

Create and return new ExtWebDriver instance with default options. If setAsCurrent is true, set the new session as the current session for this SessionManager.

Parameters:

setAsCurrent - set to true if the new session should become the current session for this SessionManager

Returns:

A new ExtWebDriver session

Throws:

Exception

getNewSession

public ExtWebDriver getNewSession(String key,
                                  String value)
                           throws Exception

Create and return a new ExtWebDriver instance. The instance is constructed with default options, with the provided key/value pair overriding the corresponding key and value in the options, and will become the current session. This is a convenience method for use when only a single option needs to be overridden. If overriding multiple options, you must use getNewSession(string-string Map, boolean) instead.

Parameters:

key - The key whose default value will be overridden

value - The value to be associated with the provided key

Returns:

A new ExtWebDriver instance which is now the current session

Throws:

Exception

getNewSession

public ExtWebDriver getNewSession(String key,
                                  String value,
                                  boolean setAsCurrent)
                           throws Exception

Create and return a new ExtWebDriver instance. The instance is constructed with default options, with the provided key/value pair overriding the corresponding key and value in the options. This is a convenience method for use when only a single option needs to be overridden. If overriding multiple options, you must use getNewSession(string-string Map, boolean) instead.

Parameters:

key - The key whose default value will be overridden

value - The value to be associated with the provided key

setAsCurrent - set to true if the new session should become the current session for this SessionManager

Returns:

A new ExtWebDriver instance

Throws:

Exception

getNewSession

public ExtWebDriver getNewSession(Map<String,String> override)
                           throws Exception

Create and return a new ExtWebDriver instance. The instance is constructed with default options, with the provided Map of key/value pairs overriding the corresponding pairs in the options. This new ExtWebDriver instance will then become the current session.

Parameters:

override - A Map of options to be overridden

Returns:

A new ExtWebDriver instance which is now the current session

Throws:

Exception

getNewSession

public ExtWebDriver getNewSession(Map<String,String> override,
                                  boolean setAsCurrent)
                           throws Exception

Create and return a new ExtWebDriver instance. The instance is constructed with default options, with the provided Map of key/value pairs overriding the corresponding pairs in the options.

Parameters:

override - A Map of options to be overridden

setAsCurrent - set to true if the new session should become the current session for this SessionManager

Returns:

A new ExtWebDriver instance

Throws:

Exception