org.openqa.selenium.firefox

Class FirefoxBinary

java.lang.Object

org.openqa.selenium.firefox.FirefoxBinary

public class FirefoxBinary
extends java.lang.Object

Property Summary

Type	Property and Description
private static Executable	locateFirefoxBinaryFromSystem Locates the firefox binary from a system property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirefoxBinary.Channel Enumerates Firefox channels, according to https://wiki.mozilla.org/RapidRelease

Field Summary

Fields

Modifier and Type	Field and Description
private Executable	executable
private java.util.Map<java.lang.String,java.lang.String>	extraEnv
private java.util.List<java.lang.String>	extraOptions
private static java.lang.String	NO_FOCUS_LIBRARY_NAME
private static java.lang.String	PATH_PREFIX
private org.openqa.selenium.os.CommandLine	process
private java.io.OutputStream	stream
private long	timeout

Constructor Summary

Constructors

Constructor and Description
FirefoxBinary()
FirefoxBinary(java.io.File pathToFirefoxBinary)
FirefoxBinary(FirefoxBinary.Channel channel)
FirefoxBinary(java.lang.String version) Deprecated. Perform the version check by taking a look at the version that comes back from the remote end in the returned Capabilities.

Method Summary

Modifier and Type	Method and Description
void	addCommandLineOptions(java.lang.String... options)
protected java.lang.String	extractAndCheck(java.io.File profileDir, java.lang.String noFocusSoName, java.lang.String jarPath32Bit, java.lang.String jarPath64Bit)
java.lang.String	getConsoleOutput() Gets all console output of the binary.
private java.io.OutputStream	getDefaultOutputStream()
java.util.Map<java.lang.String,java.lang.String>	getExtraEnv()
protected java.io.File	getFile()
protected java.lang.String	getPath()
long	getTimeout()
protected boolean	isOnLinux()
private static java.util.stream.Stream<Executable>	locateFirefoxBinariesFromPlatform() Locates the firefox binary by platform.
private static Executable	locateFirefoxBinaryFromSystemProperty() Locates the firefox binary from a system property.
protected void	modifyLinkLibraryPath(java.io.File profileDir)
void	quit()
void	setEnvironmentProperty(java.lang.String propertyName, java.lang.String value)
void	setOutputWatcher(java.io.OutputStream stream)
void	setTimeout(long timeout)
protected void	startFirefoxProcess(org.openqa.selenium.os.CommandLine command)
void	startProfile(FirefoxProfile profile, java.io.File profileDir, java.lang.String... commandLineFlags)
java.lang.String	toString()
void	waitFor() Waits for the process to execute, returning the command output taken from the profile's execution.
void	waitFor(long timeout) Waits for the process to execute, returning the command output taken from the profile's execution.

Methods inherited from class java.lang.Object

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

Property Detail

locateFirefoxBinaryFromSystem

private static Executable locateFirefoxBinaryFromSystemProperty

Locates the firefox binary from a system property. Will throw an exception if the binary cannot be found.

Field Detail

NO_FOCUS_LIBRARY_NAME

private static final java.lang.String NO_FOCUS_LIBRARY_NAME

See Also:

Constant Field Values

PATH_PREFIX

private static final java.lang.String PATH_PREFIX

extraEnv

private final java.util.Map<java.lang.String,java.lang.String> extraEnv

extraOptions

private final java.util.List<java.lang.String> extraOptions

executable

private final Executable executable

process

private org.openqa.selenium.os.CommandLine process

stream

private java.io.OutputStream stream

timeout

private long timeout

Constructor Detail

FirefoxBinary

public FirefoxBinary()

FirefoxBinary

public FirefoxBinary(FirefoxBinary.Channel channel)

FirefoxBinary

@Deprecated
public FirefoxBinary(java.lang.String version)

Deprecated. Perform the version check by taking a look at the version that comes back from the remote end in the returned Capabilities.

FirefoxBinary

public FirefoxBinary(java.io.File pathToFirefoxBinary)

Method Detail

setEnvironmentProperty

public void setEnvironmentProperty(java.lang.String propertyName,
                                   java.lang.String value)

addCommandLineOptions

public void addCommandLineOptions(java.lang.String... options)

isOnLinux

protected boolean isOnLinux()

startProfile

public void startProfile(FirefoxProfile profile,
                         java.io.File profileDir,
                         java.lang.String... commandLineFlags)
                  throws java.io.IOException

Throws:

java.io.IOException

startFirefoxProcess

protected void startFirefoxProcess(org.openqa.selenium.os.CommandLine command)
                            throws java.io.IOException

Throws:

java.io.IOException

getFile

protected java.io.File getFile()

getPath

protected java.lang.String getPath()

getExtraEnv

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

modifyLinkLibraryPath

protected void modifyLinkLibraryPath(java.io.File profileDir)

extractAndCheck

protected java.lang.String extractAndCheck(java.io.File profileDir,
                                           java.lang.String noFocusSoName,
                                           java.lang.String jarPath32Bit,
                                           java.lang.String jarPath64Bit)

waitFor

public void waitFor()
             throws java.lang.InterruptedException,
                    java.io.IOException

Waits for the process to execute, returning the command output taken from the profile's execution.

Throws:

java.lang.InterruptedException - if we are interrupted while waiting for the process to launch

java.io.IOException - if there is a problem with reading the input stream of the launching process

waitFor

public void waitFor(long timeout)
             throws java.lang.InterruptedException,
                    java.io.IOException

Waits for the process to execute, returning the command output taken from the profile's execution.

Parameters:

timeout - the maximum time to wait in milliseconds

Throws:

java.lang.InterruptedException - if we are interrupted while waiting for the process to launch

java.io.IOException - if there is a problem with reading the input stream of the launching process

getConsoleOutput

public java.lang.String getConsoleOutput()
                                  throws java.io.IOException

Gets all console output of the binary. Output retrieval is non-destructive and non-blocking.

Returns:

the console output of the executed binary.

Throws:

java.io.IOException - IO exception reading from the output stream of the firefox process

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setOutputWatcher

public void setOutputWatcher(java.io.OutputStream stream)

quit

public void quit()

getDefaultOutputStream

private java.io.OutputStream getDefaultOutputStream()
                                             throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

locateFirefoxBinaryFromSystemProperty

private static Executable locateFirefoxBinaryFromSystemProperty()

Locates the firefox binary from a system property. Will throw an exception if the binary cannot be found.

locateFirefoxBinariesFromPlatform

private static java.util.stream.Stream<Executable> locateFirefoxBinariesFromPlatform()

Locates the firefox binary by platform.