de.ppi.selenium.browser

Class SessionManager

java.lang.Object

de.ppi.selenium.browser.SessionManager

public class SessionManager
extends java.lang.Object

SessionManager for the testing framework. Uses a ThreadLocal so each thread of test execution has its own manager instance. Based on https://github.com/FINRAOS/JTAF-ExtWebDriver for the properties see http://finraos.github.io/JTAF-ExtWebDriver/clientproperties.html.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_URL_KEY Key for the options to define a base-url.

Method Summary

Modifier and Type	Method and Description
WebBrowser	getCurrentSession() Convenience method for getting the current WebBrowser session associated with this SessionManager, the session must exists.
WebBrowser	getCurrentSession(boolean createIfNotFound) Get the current session associated with this thread.
java.lang.String	getCurrentSessionId() Get the ID of the current WebBrowser session associated with this SessionManager
java.lang.String	getDefaultBaseUrl() Get the default base-url.
static SessionManager	getInstance() Obtain the ThreadLocal instance of SessionManager.
WebBrowser	getNewSession() Create and return a new WebBrowser session with default options, and set it as the current session for this SessionManager.
WebBrowser	getNewSession(boolean setAsCurrent) Create and return new WebBrowser instance with default options.
WebBrowser	getNewSession(java.util.Map<java.lang.String,java.lang.String> override) Create and return a new WebBrowser instance.
WebBrowser	getNewSession(java.util.Map<java.lang.String,java.lang.String> override, boolean setAsCurrent) Create and return a new WebBrowser instance.
WebBrowser	getNewSession(java.lang.String key, java.lang.String value) Create and return a new WebBrowser instance.
WebBrowser	getNewSession(java.lang.String key, java.lang.String value, boolean setAsCurrent) Create and return a new WebBrowser instance.
static WebBrowser	getSession() Convenience method to get the current session.
WebBrowser	getSession(java.lang.String sessionId) Get an existing WebBrowser session with the given ID.
java.util.Map<java.lang.String,WebBrowser>	getSessions() Get the Map of all WebBrowser sessions associated with this SessionManager instance.
void	quitAllSessions()
void	removeSession(java.lang.String sessionId) Remove a session with the given ID from this SessionManager
void	removeSession(WebBrowser session) Remove the given session from SessionManager based on its stored ID.
void	setDefaultBaseUrl(java.lang.String defaultBaseUrl) Possibility to set the default base-url.
SessionManager	setWebDriverFactory(WebDriverFactory impl) Configure the current instance of SessionManager to use the given WebDriverFactory instance as its WebDriverFactory, returning the newly configured instance.
void	switchToSession(java.lang.String sessionId) Switch the current session to be the WebBrowser session with the given ID.
void	switchToSession(WebBrowser ewd) Switch the current session to be the provided WebBrowser instance.

Methods inherited from class java.lang.Object

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

Field Detail

BASE_URL_KEY

public static final java.lang.String BASE_URL_KEY

Key for the options to define a base-url.

See Also:

Constant Field Values

Method Detail

getInstance

public static SessionManager getInstance()

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

Returns:

SessionManager, the ThreadLocal instance of SessionManager

See Also:

setWebDriverFactory

getDefaultBaseUrl

public java.lang.String getDefaultBaseUrl()

Get the default base-url.

Returns:

the default base-url.

setDefaultBaseUrl

public void setDefaultBaseUrl(java.lang.String defaultBaseUrl)

Possibility to set the default base-url.

Parameters:

defaultBaseUrl - the default base-url.

setWebDriverFactory

public SessionManager setWebDriverFactory(WebDriverFactory impl)

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

Parameters:

impl - a WebDriverFactory instance to be associated with this manager

Returns:

SessionManager

See Also:

getInstance

getCurrentSession

public WebBrowser 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:

WebBrowser an WebBrowser instance

See Also:

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

getCurrentSession

public WebBrowser getCurrentSession()

Convenience method for getting the current WebBrowser session associated with this SessionManager, the session must exists.

Returns:

WebBrowser an instance of WebBrowser

getSession

public static WebBrowser getSession()

Convenience method to get the current session.

Returns:

the current session.

getSession

public WebBrowser getSession(java.lang.String sessionId)

Get an existing WebBrowser session with the given ID.

Parameters:

sessionId -

Returns:

getSessions

public java.util.Map<java.lang.String,WebBrowser> getSessions()

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

Returns:

switchToSession

public void switchToSession(java.lang.String sessionId)

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

Parameters:

sessionId -

switchToSession

public void switchToSession(WebBrowser ewd)

Switch the current session to be the provided WebBrowser 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:

sessionId -

getCurrentSessionId

public java.lang.String getCurrentSessionId()

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

Returns:

removeSession

public void removeSession(java.lang.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(WebBrowser 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 WebBrowser session to be removed

getNewSession

public WebBrowser getNewSession()
                         throws java.lang.Exception

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

Returns:

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

Throws:

java.lang.Exception

getNewSession

public WebBrowser getNewSession(boolean setAsCurrent)
                         throws java.lang.Exception

Create and return new WebBrowser 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 WebBrowser session

Throws:

java.lang.Exception

getNewSession

public WebBrowser getNewSession(java.lang.String key,
                                java.lang.String value)
                         throws java.lang.Exception

Create and return a new WebBrowser 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(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 WebBrowser instance which is now the current session

Throws:

java.lang.Exception

getNewSession

public WebBrowser getNewSession(java.lang.String key,
                                java.lang.String value,
                                boolean setAsCurrent)
                         throws java.lang.Exception

Create and return a new WebBrowser 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(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 WebBrowser instance

Throws:

java.lang.Exception

getNewSession

public WebBrowser getNewSession(java.util.Map<java.lang.String,java.lang.String> override)
                         throws java.lang.Exception

Create and return a new WebBrowser 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 WebBrowser instance will then become the current session.

Parameters:

override - A Map of options to be overridden

Returns:

A new WebBrowser instance which is now the current session

Throws:

java.lang.Exception

getNewSession

public WebBrowser getNewSession(java.util.Map<java.lang.String,java.lang.String> override,
                                boolean setAsCurrent)
                         throws java.lang.Exception

Create and return a new WebBrowser 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 WebBrowser instance

Throws:

java.lang.Exception

quitAllSessions

public void quitAllSessions()