Package org.kquiet.browser

Class BasicActionRunner

java.lang.Object

org.kquiet.browser.BasicActionRunner

All Implemented Interfaces:

Closeable, AutoCloseable, ActionRunner

public class BasicActionRunner
extends Object
implements ActionRunner

BasicActionRunner maintains two prioritized thread pool internally to execute ActionComposer and browser actions separatedly. The thread pool for ActionComposer allows multiple ones to be run concurrently(depends on parameter values in constructors). The thread pool for browser actions is single-threaded, so only one browser action is executed at a time(due to the constraint of WebDriver).

Author:

Kimberly

Constructor Summary

Constructors

Constructor	Description
BasicActionRunner()	Create an BasicActionRunner with PageLoadStrategy.NONE as page load strategy, BrowserType.CHROME as browser type, and at most one ActionComposer is allowed to be executed at a time.
BasicActionRunner(int maxConcurrentComposer)	Create an BasicActionRunner with PageLoadStrategy.NONE as page load strategy and BrowserType.CHROME as browser type.
BasicActionRunner(org.openqa.selenium.PageLoadStrategy pageLoadStrategy, BrowserType browserType)	Create an BasicActionRunner with specified page load strategy, browser type, name, and at most one ActionComposer is allowed to be executed at a time.
BasicActionRunner(org.openqa.selenium.PageLoadStrategy pageLoadStrategy, BrowserType browserType, int maxConcurrentComposer)	Create an BasicActionRunner with specified page load strategy, browser type, name, and max number of concurrent composer.

Method Summary

Modifier and Type	Method	Description
void	close()
CompletableFuture<Void>	executeAction(Runnable browserAction, int priority)	Execute browser action with specified priority.
CompletableFuture<Void>	executeComposer(ActionComposer actionComposer)	Execute given ActionComposer.
String	getName()	Get the name of this ActionRunner.
String	getRootWindowIdentity()	Get the identity of root window(the initial window as the browser started).
org.openqa.selenium.WebDriver	getWebDriver()	Get associated WebDriver.
boolean	isBrowserAlive()	This method checks the existence of root window and use the result as the result of browser's aliveness.
boolean	isPaused()	Check whether this ActionRunner is paused or not.
void	pause()	Stop executing queued ActionComposer or browser action, but the running ones will keep running.
void	resume()	Resume to executing queued ActionComposer or browser action (if any).
BasicActionRunner	setName(String name)	Set the name of this ActionRunner.

Methods inherited from class java.lang.Object

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

Constructor Details

BasicActionRunner

public BasicActionRunner()

Create an BasicActionRunner with PageLoadStrategy.NONE as page load strategy, BrowserType.CHROME as browser type, and at most one ActionComposer is allowed to be executed at a time.

BasicActionRunner

public BasicActionRunner(int maxConcurrentComposer)

Create an BasicActionRunner with PageLoadStrategy.NONE as page load strategy and BrowserType.CHROME as browser type.

Parameters:

maxConcurrentComposer - the max number of ActionComposer that could be executed by this BasicActionRunner concurrently.

BasicActionRunner

public BasicActionRunner(org.openqa.selenium.PageLoadStrategy pageLoadStrategy,
 BrowserType browserType)

Create an BasicActionRunner with specified page load strategy, browser type, name, and at most one ActionComposer is allowed to be executed at a time.

Parameters:

pageLoadStrategy - page load strategy

browserType - the type of browser

See Also:

• possible page load strategies and corresponding document readiness

BasicActionRunner

public BasicActionRunner(org.openqa.selenium.PageLoadStrategy pageLoadStrategy,
 BrowserType browserType,
 int maxConcurrentComposer)

Create an BasicActionRunner with specified page load strategy, browser type, name, and max number of concurrent composer.

Parameters:

pageLoadStrategy - page load strategy

browserType - the type of browser

maxConcurrentComposer - max number of ActionComposer that could be executed concurrently

See Also:

• possible page load strategies and corresponding document readiness

Method Details

getName

public String getName()

Description copied from interface: ActionRunner

Get the name of this ActionRunner.

Specified by:

getName in interface ActionRunner

Returns:

name represented as String

setName

public BasicActionRunner setName(String name)

Description copied from interface: ActionRunner

Set the name of this ActionRunner.

Specified by:

setName in interface ActionRunner

Parameters:

name - the name to set

Returns:

this ActionRunner

getRootWindowIdentity

public String getRootWindowIdentity()

Description copied from interface: ActionRunner

Get the identity of root window(the initial window as the browser started).

Specified by:

getRootWindowIdentity in interface ActionRunner

Returns:

identity represented as String

executeAction

public CompletableFuture<Void> executeAction(Runnable browserAction,
 int priority)

Description copied from interface: ActionRunner

Execute browser action with specified priority.

Specified by:

executeAction in interface ActionRunner

Parameters:

browserAction - browser action to execute

priority - priority of action

Returns:

a CompletableFuture representing the pending completion of given browser action

executeComposer

public CompletableFuture<Void> executeComposer(ActionComposer actionComposer)

Description copied from interface: ActionRunner

Execute given ActionComposer.

Specified by:

executeComposer in interface ActionRunner

Parameters:

actionComposer - ActionComposer to execute

Returns:

a CompletableFuture representing the pending completion of given ActionComposer

getWebDriver

public org.openqa.selenium.WebDriver getWebDriver()

Description copied from interface: ActionRunner

Get associated WebDriver.

Specified by:

getWebDriver in interface ActionRunner

Returns:

the WebDriver this ActionRunner is using

isBrowserAlive

public boolean isBrowserAlive()

This method checks the existence of root window and use the result as the result of browser's aliveness. When a negative result is acquired, users can choose to close ActionRunner and create a new one.

Specified by:

isBrowserAlive in interface ActionRunner

Returns:

true if the root window exists; false otherwise

pause

public void pause()

Stop executing queued ActionComposer or browser action, but the running ones will keep running.

Specified by:

pause in interface ActionRunner

resume

public void resume()

Resume to executing queued ActionComposer or browser action (if any).

Specified by:

resume in interface ActionRunner

isPaused

public boolean isPaused()

Description copied from interface: ActionRunner

Check whether this ActionRunner is paused or not.

Specified by:

isPaused in interface ActionRunner

Returns:

true if paused; false otherwise

close

public void close()

Specified by:

close in interface ActionRunner

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable