PropertiesBackendConfiguration (FluentLenium Core 3.0.3 API)

java.lang.Object
- org.fluentlenium.configuration.BaseConfiguration
- - org.fluentlenium.configuration.PropertiesBackendConfiguration

All Implemented Interfaces:: ConfigurationProperties

public class PropertiesBackendConfiguration
extends BaseConfiguration
implements ConfigurationProperties

Abstract properties configuration.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.fluentlenium.configuration.ConfigurationProperties
  ConfigurationProperties.DriverLifecycle, ConfigurationProperties.TriggerMode

Field Summary

Fields
Modifier and Type Field and Description

static String PROPERTIES_PREFIX
Default properties prefix.

Fields
Modifier and Type	Field and Description
`static String`	`PROPERTIES_PREFIX` Default properties prefix.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PropertiesBackendConfiguration(PropertiesBackend propertiesReader)` Creates a new abstract properties configuration, using default properties prefix.
`protected`	`PropertiesBackendConfiguration(PropertiesBackend propertiesReader, String... prefixes)` Creates a new abstract properties configuration, using given properties prefixes.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getAwaitAtMost()` awaitAtMost
`Long`	`getAwaitPollingEvery()` awaitPollingEvery
`String`	`getBaseUrl()` baseUrl
`org.openqa.selenium.Capabilities`	`getCapabilities()` capabilities
`Class<? extends ConfigurationProperties>`	`getConfigurationDefaults()` configurationDefaults
`Class<? extends ConfigurationFactory>`	`getConfigurationFactory()` configurationFactory
`String`	`getCustomProperty(String propertyName)` Get custom property value.
`Boolean`	`getDeleteCookies()` deleteCookies
`ConfigurationProperties.DriverLifecycle`	`getDriverLifecycle()` driverLifecycle
`Boolean`	`getEventsEnabled()` eventsEnabled
`ConfigurationProperties.TriggerMode`	`getHtmlDumpMode()` htmlDumpMode
`String`	`getHtmlDumpPath()` htmlDumpPath
`Long`	`getImplicitlyWait()` implicitlyWait
`Long`	`getPageLoadTimeout()` pageLoadTimeout
`protected String`	`getPropertyImpl(String propertyName)` Get the property value used by underlying property storage.
`String`	`getRemoteUrl()` remoteUrl
`ConfigurationProperties.TriggerMode`	`getScreenshotMode()` screenshotMode
`String`	`getScreenshotPath()` screenshotPath
`Long`	`getScriptTimeout()` scriptTimeout
`String`	`getWebDriver()` webDriver
`protected URL`	`newURL(String url)` Creates a new URL from it's representation

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

- Field Detail
  - PROPERTIES_PREFIX
```
public static final String PROPERTIES_PREFIX
```
    Default properties prefix.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PropertiesBackendConfiguration
```
protected PropertiesBackendConfiguration(PropertiesBackend propertiesReader)
```
    Creates a new abstract properties configuration, using default properties prefix.
    
    Parameters:
    
    propertiesReader - properties reader
  - PropertiesBackendConfiguration
```
protected PropertiesBackendConfiguration(PropertiesBackend propertiesReader,
                                         String... prefixes)
```
    Creates a new abstract properties configuration, using given properties prefixes.
    
    Parameters:
    
    propertiesReader - properties reader
    
    prefixes - array of allowed prefixes
- Method Detail
  - getPropertyImpl
```
protected String getPropertyImpl(String propertyName)
```
    Get the property value used by underlying property storage.
    
    Parameters:
    
    propertyName - property key
    
    Returns:
    
    property value
  - newURL
```
protected URL newURL(String url)
              throws MalformedURLException
```
    Creates a new URL from it's representation
    
    Parameters:
    
    url - url
    
    Returns:
    
    URL object
    
    Throws:
    
    MalformedURLException - if given url is not valid
  - getConfigurationFactory
```
public Class<? extends ConfigurationFactory> getConfigurationFactory()
```
    Description copied from interface: ConfigurationProperties
```
configurationFactory
```
    property. Set this to a class implementing ConfigurationFactory to customize the ways properties are read. This allow to configure properties from sources that are not supported by default FluentLenium. Default value is DefaultConfigurationFactory class.
    Specified by:
    
    getConfigurationFactory in interface ConfigurationProperties
    
    Returns:
    
    Custom ConfigurationFactory class.
  - getConfigurationDefaults
```
public Class<? extends ConfigurationProperties> getConfigurationDefaults()
```
    Description copied from interface: ConfigurationProperties
```
configurationDefaults
```
    property. Set this to a class implementing ConfigurationProperties to provide the default values of the configuration properties. Default value is ConfigurationDefaults
    Specified by:
    
    getConfigurationDefaults in interface ConfigurationProperties
    
    Returns:
    
    Custom ConfigurationProperties instance with default values.
  - getWebDriver
```
public String getWebDriver()
```
    Description copied from interface: ConfigurationProperties
```
webDriver
```
    property. Sets the WebDriver type to use. When FluentLenium needs to create a new WebDriver instance, it calls FluentAdapter.newWebDriver() which delegates to WebDriversRegistryImpl.newWebDriver(String, Capabilities, ConfigurationProperties) registry using the value stored in webDriver and capabilities property. Possible values are "firefox", "chrome", "ie", "htmlunit", or any class name implementing WebDriver. Default value is "firefox".
    Specified by:
    
    getWebDriver in interface ConfigurationProperties
    
    Returns:
    
    webDriver property value
    
    See Also:
    
    FluentAdapter.newWebDriver()
  - getRemoteUrl
```
public String getRemoteUrl()
```
    Description copied from interface: ConfigurationProperties
```
remoteUrl
```
    property. Sets the remoteUrl for "remote" webDriver.
    Specified by:
    
    getRemoteUrl in interface ConfigurationProperties
    
    Returns:
    
    remoteUrl property value
    
    See Also:
    
    RemoteWebDriver
  - getCapabilities
```
public org.openqa.selenium.Capabilities getCapabilities()
```
    Description copied from interface: ConfigurationProperties
```
capabilities
```
    property. Sets the Capabilities to use, as a JSON Object or a URL pointing to a JSON Object. Default value is "null".
    Specified by:
    
    getCapabilities in interface ConfigurationProperties
    
    Returns:
    
    Capabilities property value
    
    See Also:
    
    Capabilities, Selenium DesiredCapabilities Wiki Page
  - getDriverLifecycle
```
public ConfigurationProperties.DriverLifecycle getDriverLifecycle()
```
    Description copied from interface: ConfigurationProperties
```
driverLifecycle
```
    property. Sets the lifecycle of the WebDriver. WebDriver is fully managed by FluentLenium, so you should never create or quit a WebDriver by yourself. Please keep in mind that this configures when drivers are created and exited at runtime, but it does not deal with concurrency of your tests. Default value is METHOD.
    Specified by:
    
    getDriverLifecycle in interface ConfigurationProperties
    
    Returns:
    
    driverLifecycle property value
  - getDeleteCookies
```
public Boolean getDeleteCookies()
```
    Description copied from interface: ConfigurationProperties
```
deleteCookies
```
    property. When using CLASS or JVM
```
driverLifecycle
```
    configuration property, allow to delete cookies between each test. Default value is false.
    Specified by:
    
    getDeleteCookies in interface ConfigurationProperties
    
    Returns:
    
    deleteCookies property value.
  - getBaseUrl
```
public String getBaseUrl()
```
    Description copied from interface: ConfigurationProperties
```
baseUrl
```
    property. Sets the base URL used to build absolute URL when relative URL is given to NavigationControl.goTo(String). Default value is null.
    Specified by:
    
    getBaseUrl in interface ConfigurationProperties
    
    Returns:
    
    baseUrl property value
  - getEventsEnabled
```
public Boolean getEventsEnabled()
```
    Description copied from interface: ConfigurationProperties
```
eventsEnabled
```
    property. Enables EventsControl.events() by wrapping the WebDriver in EventFiringWebDriver. Default value is true.
    Specified by:
    
    getEventsEnabled in interface ConfigurationProperties
    
    Returns:
    
    eventsEnabled property value.
  - getPageLoadTimeout
```
public Long getPageLoadTimeout()
```
    Description copied from interface: ConfigurationProperties
```
pageLoadTimeout
```
    property. Sets the amount of time in millisecond to wait for a page load to complete before throwing an error. If the timeout is negative, page loads can be indefinite. Default value is null.
    Specified by:
    
    getPageLoadTimeout in interface ConfigurationProperties
    
    Returns:
    
    pageLoadTimeout property value
    
    See Also:
    
    WebDriver.Timeouts.pageLoadTimeout(long, java.util.concurrent.TimeUnit)
  - getImplicitlyWait
```
public Long getImplicitlyWait()
```
    Description copied from interface: ConfigurationProperties
```
implicitlyWait
```
    property. Specifies the amount of time in millisecond the driver should wait when searching for an element if it is not immediately present. Default value is null.
    Specified by:
    
    getImplicitlyWait in interface ConfigurationProperties
    
    Returns:
    
    implicitlyWait property value
    
    See Also:
    
    WebDriver.Timeouts.implicitlyWait(long, java.util.concurrent.TimeUnit)
  - getScriptTimeout
```
public Long getScriptTimeout()
```
    Description copied from interface: ConfigurationProperties
```
scriptTimeout
```
    property. Sets the amount of time in millisecond to wait for an asynchronous script to finish execution before throwing an error. If the timeout is negative, then the script will be allowed to run indefinitely. Default value is null.
    Specified by:
    
    getScriptTimeout in interface ConfigurationProperties
    
    Returns:
    
    scriptTimeout property value
    
    See Also:
    
    WebDriver.Timeouts.setScriptTimeout(long, java.util.concurrent.TimeUnit)
  - getAwaitAtMost
```
public Long getAwaitAtMost()
```
    Description copied from interface: ConfigurationProperties
```
awaitAtMost
```
    property. Sets the default timeout in millisecond when using AwaitControl.await() or Wait hook.
    Specified by:
    
    getAwaitAtMost in interface ConfigurationProperties
    
    Returns:
    
    awaitTimeout property value
    
    See Also:
    
    FluentWait.atMost(long, java.util.concurrent.TimeUnit), FluentWait.atMost(long)
  - getAwaitPollingEvery
```
public Long getAwaitPollingEvery()
```
    Description copied from interface: ConfigurationProperties
```
awaitPollingEvery
```
    property. Sets the default polling frequency in millisecond when using AwaitControl.await() or Wait hook.
    Specified by:
    
    getAwaitPollingEvery in interface ConfigurationProperties
    
    Returns:
    
    awaitPollingEvery property value
    
    See Also:
    
    FluentWait.pollingEvery(long, java.util.concurrent.TimeUnit), FluentWait.pollingEvery(long)
  - getScreenshotPath
```
public String getScreenshotPath()
```
    Description copied from interface: ConfigurationProperties
```
screenshotPath
```
    property. Sets the filesystem path where screenshot will be saved when calling SnapshotControl.takeScreenShot() or SnapshotControl.takeScreenShot(String). Default value is null.
    Specified by:
    
    getScreenshotPath in interface ConfigurationProperties
    
    Returns:
    
    screenshotPath property value
  - getHtmlDumpPath
```
public String getHtmlDumpPath()
```
    Description copied from interface: ConfigurationProperties
```
htmlDumpPath
```
    property. Sets the filesystem path where screenshot will be saved when calling SnapshotControl.takeHtmlDump() or SnapshotControl.takeHtmlDump(String). Default value is null.
    Specified by:
    
    getHtmlDumpPath in interface ConfigurationProperties
    
    Returns:
    
    htmlDumpPath property value
  - getScreenshotMode
```
public ConfigurationProperties.TriggerMode getScreenshotMode()
```
    Description copied from interface: ConfigurationProperties
```
screenshotMode
```
    property. Sets the trigger mode of screenshots. Can be {AUTOMATIC_ON_FAIL} to take screenshot when the test fail or {MANUAL}. Default value is null.
    Specified by:
    
    getScreenshotMode in interface ConfigurationProperties
    
    Returns:
    
    screenshotMode property value.
    
    See Also:
    
    ConfigurationProperties.TriggerMode
  - getHtmlDumpMode
```
public ConfigurationProperties.TriggerMode getHtmlDumpMode()
```
    Description copied from interface: ConfigurationProperties
```
htmlDumpMode
```
    property. Sets the trigger mode of htmlDump. Can be {AUTOMATIC_ON_FAIL} to take html dump when the test fail or {MANUAL}. Default value is null.
    Specified by:
    
    getHtmlDumpMode in interface ConfigurationProperties
    
    Returns:
    
    htmlDumpMode property value.
    
    See Also:
    
    ConfigurationProperties.TriggerMode
  - getCustomProperty
```
public String getCustomProperty(String propertyName)
```
    Description copied from interface: ConfigurationProperties
    
    Get custom property value.
    
    Specified by:
    
    getCustomProperty in interface ConfigurationProperties
    
    Parameters:
    
    propertyName - name of the property
    
    Returns:
    
    property value

Class PropertiesBackendConfiguration

Nested Class Summary

Nested classes/interfaces inherited from interface org.fluentlenium.configuration.ConfigurationProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTIES_PREFIX

Constructor Detail

PropertiesBackendConfiguration

PropertiesBackendConfiguration

Method Detail

getPropertyImpl

newURL

getConfigurationFactory

getConfigurationDefaults

getWebDriver

getRemoteUrl

getCapabilities

getDriverLifecycle

getDeleteCookies

getBaseUrl

getEventsEnabled

getPageLoadTimeout

getImplicitlyWait

getScriptTimeout

getAwaitAtMost

getAwaitPollingEvery

getScreenshotPath

getHtmlDumpPath

getScreenshotMode

getHtmlDumpMode

getCustomProperty