SeleniumServerConfiguration (Arquillian Drone Extension Support for Selenium Server 2.0.0.Alpha4 API)

java.lang.Object
- org.jboss.arquillian.drone.selenium.server.configuration.SeleniumServerConfiguration

All Implemented Interfaces:

DroneConfiguration<SeleniumServerConfiguration>
```
public class SeleniumServerConfiguration
extends Object
implements DroneConfiguration<SeleniumServerConfiguration>
```
Configuration for Selenium Server. This configuration can be fetched from Arquillian Descriptor and overridden by System properties.

Author:

Karel Piwko

See Also:
ConfigurationMapper

Field Summary

Fields
Modifier and Type Field and Description

static String CONFIGURATION_NAME

Fields
Modifier and Type	Field and Description
`static String`	`CONFIGURATION_NAME`

Constructor Summary

Constructors
Constructor and Description

SeleniumServerConfiguration()
Creates default Selenium Server Configuration

Constructors
Constructor and Description
`SeleniumServerConfiguration()` Creates default Selenium Server Configuration

Method Summary

Methods
Modifier and Type	Method and Description
`SeleniumServerConfiguration`	`configure(org.jboss.arquillian.config.descriptor.api.ArquillianDescriptor descriptor, Class<? extends Annotation> qualifier)`
`String`	`getConfigurationName()`
`String`	`getFirefoxProfileTemplate()` Gets the path to the directory where a Firefox profile is stored
`String`	`getForcedBrowserMode()` Gets enforced browser name
`String`	`getHost()` Gets the host where Selenium server is listening for requests
`String`	`getLogFile()` Gets path to the log file
`String`	`getNonProxyHosts()` Gets list of server not proxied, comma separated
`String`	`getOutput()` Deprecated.
`int`	`getPort()` Gets the port where Selenium server is listening for requests
`String`	`getProfilesLocation()` Gets location of the Firefox profiles
`String`	`getProxyHost()` Gets host name of proxy
`String`	`getProxyPort()` Gets port of the proxy
`int`	`getRetryTimeoutInSeconds()` Gets timeout for retrying a request
`String`	`getSystemProperties()` Gets additional system properties
`int`	`getTimeoutInSeconds()` Gets global timeout for Selenium server.
`String`	`getTrustStore()` Gets path to the trust store
`String`	`getTrustStorePassword()` Gets password to the trust store
`String`	`getUserExtensions()` Gets path to the file where user specified JavaScript extensions
`boolean`	`isAvoidProxy()` Gets flag marking Selenium server to avoid proxy
`boolean`	`isBrowserSessionReuse()` Reuse browser session between browsers
`boolean`	`isBrowserSideLog()` Gets flag whether logging in browser window is enabled
`boolean`	`isDebug()` Gets debug flag
`boolean`	`isDontTouchLogging()` Gets logging type flag
`boolean`	`isEnable()` Deprecated.
`boolean`	`isEnsureCleanSession()` Gets flag ensuring session is clean
`boolean`	`isHonorSystemProxy()` Gets flag whether Selenium server is honoring the system proxy
`boolean`	`isProxyInjectionMode()` Gets proxy injection flag
`boolean`	`isSingleWindow()` Gets flag whether Selenium server is using single window
`boolean`	`isSkip()` Checks whether start of Selenium server is enabled
`boolean`	`isTrustAllSSLCertificates()` Gets flag whether Selenium server is trusting all SSL certificates
`void`	`setAvoidProxy(boolean avoidProxy)` Sets Selenium Server to avoid proxy server
`void`	`setBrowserSessionReuse(boolean browserSessionReuse)` Sets browser session to be reused between browsers
`void`	`setBrowserSideLog(boolean browserSideLog)` Enables or disables logging on server side log
`void`	`setDebug(boolean debug)` Enables or disabled debug messages
`void`	`setDontTouchLogging(boolean dontTouchLogging)` Sets logging not to be done by Selenium loggers
`void`	`setEnable(boolean enable)` Deprecated.
`void`	`setEnsureCleanSession(boolean ensureCleanSession)` Forces or disabled cleaning browser session
`void`	`setFirefoxProfileTemplate(String firefoxProfileTemplate)` Sets the path to the directory where a Firefox profile is stored.
`void`	`setForcedBrowserMode(String forcedBrowserMode)` Forces browser to be of given type
`void`	`setHonorSystemProxy(boolean honorSystemProxy)` Sets Selenium server to use system proxy settings
`void`	`setHost(String host)` Sets the host where Selenium server is listening for requests
`void`	`setLogFile(String logFile)` Sets the path to the log file
`void`	`setNonProxyHosts(String nonProxyHosts)` Sets list (comma separated) of host where proxying is not applied
`void`	`setOutput(String output)` Deprecated.
`void`	`setPort(int port)` Sets the port where Selenium server is listening for requests
`void`	`setProfilesLocation(String profilesLocation)` Sets location of the Firefox profiles
`void`	`setProxyHost(String proxyHost)` Sets host name of proxy
`void`	`setProxyInjectionMode(boolean proxyInjectionMode)` Allows proxy injection on Selenium server side
`void`	`setProxyPort(String proxyPort)` Sets port of the proxy
`void`	`setRetryTimeoutInSeconds(int retryTimeoutInSeconds)` Sets timeout for retrying a request
`void`	`setSingleWindow(boolean singleWindow)` Enforces server to use a single window
`void`	`setSkip(boolean skip)` Enables or disabled start of Selenium server
`void`	`setSystemProperties(String systemProperties)` Sets additional system properties.
`void`	`setTimeoutInSeconds(int timeoutInSeconds)` Sets global timeout for Selenium server.
`void`	`setTrustAllSSLCertificates(boolean trustAllSSLCertificates)` Sets Selenium server to trust all certificates
`void`	`setTrustStore(String trustStore)` Sets path to the trust store
`void`	`setTrustStorePassword(String trustStorePassword)` Sets path to the trust store
`void`	`setUserExtensions(String userExtensions)` Sets path to the file where user specified JavaScript extensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONFIGURATION_NAME
```
public static final String CONFIGURATION_NAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SeleniumServerConfiguration
```
public SeleniumServerConfiguration()
```
    Creates default Selenium Server Configuration
- Method Detail
  - configure
```
public SeleniumServerConfiguration configure(org.jboss.arquillian.config.descriptor.api.ArquillianDescriptor descriptor,
                                    Class<? extends Annotation> qualifier)
```
    Specified by:
    
    configure in interface DroneConfiguration<SeleniumServerConfiguration>
  - getConfigurationName
```
public String getConfigurationName()
```
    Specified by:
    
    getConfigurationName in interface DroneConfiguration<SeleniumServerConfiguration>
  - getPort
```
public int getPort()
```
    Gets the port where Selenium server is listening for requests
    
    Returns:
    the port
  - setPort
```
public void setPort(int port)
```
    Sets the port where Selenium server is listening for requests
    
    Parameters:
    port - the port to set
  - getHost
```
public String getHost()
```
    Gets the host where Selenium server is listening for requests
    
    Returns:
    the host
  - setHost
```
public void setHost(String host)
```
    Sets the host where Selenium server is listening for requests
    
    Parameters:
    host - the host to set
  - getOutput
```
@Deprecated
public String getOutput()
```
    Deprecated.
    
    Gets the name of log file where Selenium output is logged
    
    Returns:
    the output
    See Also:
    SeleniumServerConfiguration.getLogFile()
  - setOutput
```
@Deprecated
public void setOutput(String output)
```
    Deprecated.
    
    Sets the name of log file where Selenium output is logged
    
    Parameters:
    output - the output to set
    See Also:
    SeleniumServerConfiguration.setLogFile(String)
  - isEnable
```
@Deprecated
public boolean isEnable()
```
    Deprecated.
    
    Gets the flag which enable running Selenium server
    
    Returns:
    the enable flag
    See Also:
    SeleniumServerConfiguration.isSkip()
  - setEnable
```
@Deprecated
public void setEnable(boolean enable)
```
    Deprecated.
    
    Sets Selenium server start to be enabled
    
    Parameters:
    enable - the enable to set
    See Also:
    SeleniumServerConfiguration.setSkip(boolean)
  - getLogFile
```
public String getLogFile()
```
    Gets path to the log file
    
    Returns:
    the logFile
  - setLogFile
```
public void setLogFile(String logFile)
```
    Sets the path to the log file
    
    Parameters:
    logFile - the logFile to set
  - isAvoidProxy
```
public boolean isAvoidProxy()
```
    Gets flag marking Selenium server to avoid proxy
    
    Returns:
    the avoidProxy
  - setAvoidProxy
```
public void setAvoidProxy(boolean avoidProxy)
```
    Sets Selenium Server to avoid proxy server
    
    Parameters:
    avoidProxy - the avoidProxy to set
  - isBrowserSessionReuse
```
public boolean isBrowserSessionReuse()
```
    Reuse browser session between browsers
    
    Returns:
    the browserSessionReuse
  - setBrowserSessionReuse
```
public void setBrowserSessionReuse(boolean browserSessionReuse)
```
    Sets browser session to be reused between browsers
    
    Parameters:
    browserSessionReuse - the browserSessionReuse to set
  - isBrowserSideLog
```
public boolean isBrowserSideLog()
```
    Gets flag whether logging in browser window is enabled
    
    Returns:
    the browserSideLog
  - setBrowserSideLog
```
public void setBrowserSideLog(boolean browserSideLog)
```
    Enables or disables logging on server side log
    
    Parameters:
    browserSideLog - the browserSideLog to set
  - isDebug
```
public boolean isDebug()
```
    Gets debug flag
    
    Returns:
    the debug
  - setDebug
```
public void setDebug(boolean debug)
```
    Enables or disabled debug messages
    
    Parameters:
    debug - the debug to set
  - setDontTouchLogging
```
public void setDontTouchLogging(boolean dontTouchLogging)
```
    Sets logging not to be done by Selenium loggers
    
    Parameters:
    dontTouchLogging - the dontTouchLogging to set
  - isDontTouchLogging
```
public boolean isDontTouchLogging()
```
    Gets logging type flag
    
    Returns:
    the dontTouchLogging
  - isEnsureCleanSession
```
public boolean isEnsureCleanSession()
```
    Gets flag ensuring session is clean
    
    Returns:
    the ensureCleanSession
  - setEnsureCleanSession
```
public void setEnsureCleanSession(boolean ensureCleanSession)
```
    Forces or disabled cleaning browser session
    
    Parameters:
    ensureCleanSession - the ensureCleanSession to set
  - getFirefoxProfileTemplate
```
public String getFirefoxProfileTemplate()
```
    Gets the path to the directory where a Firefox profile is stored
    
    Returns:
    the firefoxProfileTemplate
  - setFirefoxProfileTemplate
```
public void setFirefoxProfileTemplate(String firefoxProfileTemplate)
```
    Sets the path to the directory where a Firefox profile is stored.
    
    Parameters:
    firefoxProfileTemplate - the firefoxProfileTemplate to set
  - getForcedBrowserMode
```
public String getForcedBrowserMode()
```
    Gets enforced browser name
    
    Returns:
    the forcedBrowserMode
  - setForcedBrowserMode
```
public void setForcedBrowserMode(String forcedBrowserMode)
```
    Forces browser to be of given type
    
    Parameters:
    forcedBrowserMode - the forcedBrowserMode to set
  - setHonorSystemProxy
```
public void setHonorSystemProxy(boolean honorSystemProxy)
```
    Sets Selenium server to use system proxy settings
    
    Parameters:
    honorSystemProxy - the honorSystemProxy to set
  - isHonorSystemProxy
```
public boolean isHonorSystemProxy()
```
    Gets flag whether Selenium server is honoring the system proxy
    
    Returns:
    the honorSystemProxy
  - getNonProxyHosts
```
public String getNonProxyHosts()
```
    Gets list of server not proxied, comma separated
    
    Returns:
    the nonProxyHosts
  - setNonProxyHosts
```
public void setNonProxyHosts(String nonProxyHosts)
```
    Sets list (comma separated) of host where proxying is not applied
    
    Parameters:
    nonProxyHosts - the nonProxyHosts to set
  - getProfilesLocation
```
public String getProfilesLocation()
```
    Gets location of the Firefox profiles
    
    Returns:
    the profilesLocation
  - setProfilesLocation
```
public void setProfilesLocation(String profilesLocation)
```
    Sets location of the Firefox profiles
    
    Parameters:
    profilesLocation - the profilesLocation to set
  - getProxyHost
```
public String getProxyHost()
```
    Gets host name of proxy
    
    Returns:
    the proxyHost
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    Sets host name of proxy
    
    Parameters:
    proxyHost - the proxyHost to set
  - setProxyInjectionMode
```
public void setProxyInjectionMode(boolean proxyInjectionMode)
```
    Allows proxy injection on Selenium server side
    
    Parameters:
    proxyInjectionMode - the proxyInjectionMode to set
  - isProxyInjectionMode
```
public boolean isProxyInjectionMode()
```
    Gets proxy injection flag
    
    Returns:
    the proxyInjectionMode
  - getProxyPort
```
public String getProxyPort()
```
    Gets port of the proxy
    
    Returns:
    the proxyPort
  - setProxyPort
```
public void setProxyPort(String proxyPort)
```
    Sets port of the proxy
    
    Parameters:
    proxyPort - the proxyPort to set
  - setRetryTimeoutInSeconds
```
public void setRetryTimeoutInSeconds(int retryTimeoutInSeconds)
```
    Sets timeout for retrying a request
    
    Parameters:
    retryTimeoutInSeconds - the retryTimeoutInSeconds to set
  - getRetryTimeoutInSeconds
```
public int getRetryTimeoutInSeconds()
```
    Gets timeout for retrying a request
    
    Returns:
    the retryTimeoutInSeconds
  - isSingleWindow
```
public boolean isSingleWindow()
```
    Gets flag whether Selenium server is using single window
    
    Returns:
    the singleWindow
  - setSingleWindow
```
public void setSingleWindow(boolean singleWindow)
```
    Enforces server to use a single window
    
    Parameters:
    singleWindow - the singleWindow to set
  - isSkip
```
public boolean isSkip()
```
    Checks whether start of Selenium server is enabled
    
    Returns:
    the skip
  - setSkip
```
public void setSkip(boolean skip)
```
    Enables or disabled start of Selenium server
    
    Parameters:
    skip - the skip to set
  - setSystemProperties
```
public void setSystemProperties(String systemProperties)
```
    Sets additional system properties.
    This properties should be specified in format:
```
 -Dfoo=bar -Dfoo2=bar2
 
```
    Parameters:
    systemProperties - the systemProperties to set
  - getSystemProperties
```
public String getSystemProperties()
```
    Gets additional system properties
    
    Returns:
    the systemProperties
  - setTimeoutInSeconds
```
public void setTimeoutInSeconds(int timeoutInSeconds)
```
    Sets global timeout for Selenium server. Default value is Integer.MAX_VALUE After this timeout all request will fail
    
    Parameters:
    timeoutInSeconds - the timeoutInSeconds to set
  - getTimeoutInSeconds
```
public int getTimeoutInSeconds()
```
    Gets global timeout for Selenium server.
    
    Returns:
    the timeoutInSeconds
  - isTrustAllSSLCertificates
```
public boolean isTrustAllSSLCertificates()
```
    Gets flag whether Selenium server is trusting all SSL certificates
    
    Returns:
    the trustAllSSLCertificates
  - setTrustAllSSLCertificates
```
public void setTrustAllSSLCertificates(boolean trustAllSSLCertificates)
```
    Sets Selenium server to trust all certificates
    
    Parameters:
    trustAllSSLCertificates - the trustAllSSLCertificates to set
  - getTrustStore
```
public String getTrustStore()
```
    Gets path to the trust store
    
    Returns:
    the trustStore
  - setTrustStore
```
public void setTrustStore(String trustStore)
```
    Sets path to the trust store
    
    Parameters:
    trustStore - the trustStore to set
  - getTrustStorePassword
```
public String getTrustStorePassword()
```
    Gets password to the trust store
    
    Returns:
    the trustStorePassword
  - setTrustStorePassword
```
public void setTrustStorePassword(String trustStorePassword)
```
    Sets path to the trust store
    
    Parameters:
    trustStorePassword - the trustStorePassword to set
  - getUserExtensions
```
public String getUserExtensions()
```
    Gets path to the file where user specified JavaScript extensions
    
    Returns:
    the userExtensions
  - setUserExtensions
```
public void setUserExtensions(String userExtensions)
```
    Sets path to the file where user specified JavaScript extensions
    
    Parameters:
    userExtensions - the userExtensions to set

Class SeleniumServerConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIGURATION_NAME

Constructor Detail

SeleniumServerConfiguration

Method Detail

configure

getConfigurationName

getPort

setPort

getHost

setHost

getOutput

setOutput

isEnable

setEnable

getLogFile

setLogFile

isAvoidProxy

setAvoidProxy

isBrowserSessionReuse

setBrowserSessionReuse

isBrowserSideLog

setBrowserSideLog

isDebug

setDebug

setDontTouchLogging

isDontTouchLogging

isEnsureCleanSession

setEnsureCleanSession

getFirefoxProfileTemplate

setFirefoxProfileTemplate

getForcedBrowserMode

setForcedBrowserMode

setHonorSystemProxy

isHonorSystemProxy

getNonProxyHosts

setNonProxyHosts

getProfilesLocation

setProfilesLocation

getProxyHost

setProxyHost

setProxyInjectionMode

isProxyInjectionMode

getProxyPort

setProxyPort

setRetryTimeoutInSeconds

getRetryTimeoutInSeconds

isSingleWindow

setSingleWindow

isSkip

setSkip

setSystemProperties

getSystemProperties

setTimeoutInSeconds

getTimeoutInSeconds

isTrustAllSSLCertificates

setTrustAllSSLCertificates

getTrustStore

setTrustStore

getTrustStorePassword

setTrustStorePassword

getUserExtensions

setUserExtensions