com.qeagle.devtools.launch

Class ChromeLauncher

java.lang.Object

com.qeagle.devtools.launch.ChromeLauncher

All Implemented Interfaces:

AutoCloseable

public class ChromeLauncher
extends Object
implements AutoCloseable

Chrome launcher.

Author:

Gopinath

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChromeLauncher.Environment Environment interface.
static class	ChromeLauncher.RuntimeShutdownHookRegistry Runtime based shutdown hook.
static interface	ChromeLauncher.ShutdownHookRegistry Shutdown hooks registry.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_CHROME_PATH CHROME_PATH environment var

Constructor Summary

Constructors

Constructor and Description
ChromeLauncher() Instantiates a new Chrome launcher.
ChromeLauncher(ChromeLauncherConfiguration configuration) Instantiates a new Chrome launcher.
ChromeLauncher(ProcessLauncher processLauncher, ChromeLauncher.Environment environment, ChromeLauncher.ShutdownHookRegistry shutdownHookRegistry, ChromeLauncherConfiguration configuration) Instantiates a new Chrome launcher with a process launcher.

Method Summary

Modifier and Type	Method and Description
void	close()
int	exitValue() Returns an exit value.
Path	getChromeBinaryPath() Returns the chrome binary path.
boolean	isAlive() Tests whether the subprocess is alive.
ChromeService	launch() Launches a headless chrome with default arguments.
ChromeService	launch(boolean headless) Launches a chrome with default arguments.
ChromeService	launch(ChromeArguments chromeArguments) Launches a chrome given its path and arguments.
ChromeService	launch(Path chromeBinaryPath, ChromeArguments chromeArguments) Launches a chrome given its path and arguments.

Methods inherited from class java.lang.Object

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

Field Detail

ENV_CHROME_PATH

public static final String ENV_CHROME_PATH

CHROME_PATH environment var

See Also:

Constant Field Values

Constructor Detail

ChromeLauncher

public ChromeLauncher()

Instantiates a new Chrome launcher.

ChromeLauncher

public ChromeLauncher(ChromeLauncherConfiguration configuration)

Instantiates a new Chrome launcher.

Parameters:

configuration - Launch configuration.

ChromeLauncher

public ChromeLauncher(ProcessLauncher processLauncher,
                      ChromeLauncher.Environment environment,
                      ChromeLauncher.ShutdownHookRegistry shutdownHookRegistry,
                      ChromeLauncherConfiguration configuration)

Instantiates a new Chrome launcher with a process launcher.

Parameters:

processLauncher - Process launcher.

environment - Environment interface.

shutdownHookRegistry - Shutdown hooks registry.

Method Detail

launch

public ChromeService launch(Path chromeBinaryPath,
                            ChromeArguments chromeArguments)
                     throws ChromeProcessException

Launches a chrome given its path and arguments.

Parameters:

chromeBinaryPath - the chrome binary path

chromeArguments - the chrome arguments

Returns:

Chrome service.

Throws:

IllegalStateException - If chrome process has already been started.

ChromeProcessException - If an I/O error occurs during chrome process start.

ChromeProcessTimeoutException - If timeout expired while waiting for chrome to start.

launch

public ChromeService launch(ChromeArguments chromeArguments)
                     throws ChromeProcessException

Launches a chrome given its path and arguments.

Parameters:

chromeArguments - the chrome arguments

Returns:

Chrome service.

Throws:

IllegalStateException - If chrome process has already been started.

ChromeProcessException - If an I/O error occurs during chrome process start.

ChromeProcessTimeoutException - If timeout expired while waiting for chrome to start.

launch

public ChromeService launch(boolean headless)
                     throws ChromeProcessException

Launches a chrome with default arguments.

Parameters:

headless - Headless flag.

Returns:

Chrome service.

Throws:

IllegalStateException - If chrome process has already been started.

ChromeProcessException - If an I/O error occurs during chrome process start.

ChromeProcessTimeoutException - If timeout expired while waiting for chrome to start.

launch

public ChromeService launch()
                     throws ChromeProcessException

Launches a headless chrome with default arguments.

Returns:

Chrome service.

Throws:

IllegalStateException - If chrome process has already been started.

ChromeProcessException - If an I/O error occurs during chrome process start.

ChromeProcessTimeoutException - If timeout expired while waiting for chrome to start.

getChromeBinaryPath

public Path getChromeBinaryPath()

Returns the chrome binary path.

Returns:

Chrome binary path.

close

public void close()

Specified by:

close in interface AutoCloseable

exitValue

public int exitValue()

Returns an exit value. This is just proxy to Process.exitValue().

Returns:

Exit value of the process if exited.

Throws:

{@link - IllegalThreadStateException} if the subprocess has not yet terminated. IllegalStateException If the process hasn't even started.

isAlive

public boolean isAlive()

Tests whether the subprocess is alive. This is just proxy to Process.isAlive().

Returns:

True if the subprocess has not yet terminated.

Throws:

IllegalThreadStateException - if the subprocess has not yet terminated.