Package org.fluentlenium.configuration
Class ProgrammaticConfiguration
- java.lang.Object
-
- org.fluentlenium.configuration.ProgrammaticConfiguration
-
- All Implemented Interfaces:
Configuration
,ConfigurationMutator
,ConfigurationProperties
public class ProgrammaticConfiguration extends java.lang.Object implements Configuration
Configuration
based on JavaBean properties.- See Also:
Configuration
,ConfigurationProperties
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.fluentlenium.configuration.ConfigurationProperties
ConfigurationProperties.DriverLifecycle, ConfigurationProperties.TriggerMode
-
-
Constructor Summary
Constructors Constructor Description ProgrammaticConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Long
getAwaitAtMost()
awaitAtMostjava.lang.Long
getAwaitPollingEvery()
awaitPollingEveryjava.lang.String
getBaseUrl()
baseUrljava.lang.Long
getBrowserTimeout()
browserTimeoutjava.lang.Integer
getBrowserTimeoutRetries()
browserTimeoutRetriesorg.openqa.selenium.Capabilities
getCapabilities()
capabilitiesjava.lang.Class<? extends ConfigurationProperties>
getConfigurationDefaults()
configurationDefaultsjava.lang.Class<? extends ConfigurationFactory>
getConfigurationFactory()
configurationFactoryjava.lang.String
getCustomProperty(java.lang.String propertyName)
Get custom property value.java.lang.Boolean
getDeleteCookies()
deleteCookiesConfigurationProperties.DriverLifecycle
getDriverLifecycle()
driverLifecyclejava.lang.Boolean
getEventsEnabled()
eventsEnabledConfigurationProperties.TriggerMode
getHtmlDumpMode()
htmlDumpModejava.lang.String
getHtmlDumpPath()
htmlDumpPathjava.lang.Long
getImplicitlyWait()
implicitlyWaitjava.lang.Long
getPageLoadTimeout()
pageLoadTimeoutjava.lang.String
getRemoteUrl()
remoteUrlConfigurationProperties.TriggerMode
getScreenshotMode()
screenshotModejava.lang.String
getScreenshotPath()
screenshotPathjava.lang.Long
getScriptTimeout()
scriptTimeoutjava.lang.String
getWebDriver()
webDrivervoid
setAwaitAtMost(java.lang.Long awaitAtMost)
Sets the value ofvoid
setAwaitPollingEvery(java.lang.Long awaitPollingEvery)
Sets the value ofvoid
setBaseUrl(java.lang.String baseUrl)
Sets the value ofvoid
setBrowserTimeout(java.lang.Long timeout)
Sets the value ofvoid
setBrowserTimeoutRetries(java.lang.Integer retriesNumber)
Sets the value ofvoid
setCapabilities(org.openqa.selenium.Capabilities capabilities)
Sets the value ofvoid
setConfigurationDefaults(java.lang.Class<? extends ConfigurationProperties> configurationDefaults)
Set the configuration defaults.void
setConfigurationFactory(java.lang.Class<? extends ConfigurationFactory> configurationFactory)
Sets the value ofvoid
setCustomProperty(java.lang.String key, java.lang.String value)
Sets custom value for a custom property keyvoid
setDeleteCookies(java.lang.Boolean deleteCookies)
Sets the value ofvoid
setDriverLifecycle(ConfigurationProperties.DriverLifecycle driverLifecycle)
Sets the value ofvoid
setEventsEnabled(java.lang.Boolean eventsEnabled)
Sets the value ofvoid
setHtmlDumpMode(ConfigurationProperties.TriggerMode htmlDumpMode)
Sets the value ofvoid
setHtmlDumpPath(java.lang.String htmlDumpPath)
Sets the value ofvoid
setImplicitlyWait(java.lang.Long implicitlyWait)
Sets the value ofvoid
setPageLoadTimeout(java.lang.Long pageLoadTimeout)
Sets the value ofvoid
setRemoteUrl(java.lang.String remoteUrl)
Sets the value ofvoid
setScreenshotMode(ConfigurationProperties.TriggerMode mode)
Sets the value ofvoid
setScreenshotPath(java.lang.String path)
Sets the value ofvoid
setScriptTimeout(java.lang.Long scriptTimeout)
Sets the value ofvoid
setWebDriver(java.lang.String webDriverName)
Sets the value of
-
-
-
Method Detail
-
setConfigurationDefaults
public void setConfigurationDefaults(java.lang.Class<? extends ConfigurationProperties> configurationDefaults)
Set the configuration defaults.- Parameters:
configurationDefaults
- configuration defaults
-
getWebDriver
public java.lang.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 callsIFluentAdapter.newWebDriver()
which delegates toWebDriversRegistryImpl.newWebDriver(String, Capabilities, ConfigurationProperties)
registry using the value stored in webDriver and capabilities property.Possible values are "firefox", "chrome", "ie", "edge", "htmlunit", "safari", "phantomjs", "opera", "remote" or any class name implementing
WebDriver
or any name that is defined in the `@FactoryName` annotation of a `WebDriverFactory` implementation.Default value is "firefox".
- Specified by:
getWebDriver
in interfaceConfigurationProperties
- Returns:
- webDriver property value
- See Also:
IFluentAdapter.newWebDriver()
,DefaultWebDriverFactories
-
setWebDriver
public void setWebDriver(java.lang.String webDriverName)
Description copied from interface:ConfigurationMutator
Sets the value ofwebDriver
property.- Specified by:
setWebDriver
in interfaceConfigurationMutator
- Parameters:
webDriverName
- property value- See Also:
ConfigurationProperties.getWebDriver()
-
getRemoteUrl
public java.lang.String getRemoteUrl()
Description copied from interface:ConfigurationProperties
remoteUrl
property. Sets the remoteUrl for "remote" webDriver.- Specified by:
getRemoteUrl
in interfaceConfigurationProperties
- Returns:
- remoteUrl property value
- See Also:
RemoteWebDriver
-
setRemoteUrl
public void setRemoteUrl(java.lang.String remoteUrl)
Description copied from interface:ConfigurationMutator
Sets the value ofremoteUrl
property.- Specified by:
setRemoteUrl
in interfaceConfigurationMutator
- Parameters:
remoteUrl
- property value- See Also:
ConfigurationProperties.getRemoteUrl()
-
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 interfaceConfigurationProperties
- Returns:
- Capabilities property value
- See Also:
Capabilities
, Selenium DesiredCapabilities Wiki Page
-
setCapabilities
public void setCapabilities(org.openqa.selenium.Capabilities capabilities)
Description copied from interface:ConfigurationMutator
Sets the value ofcapabilities
property.- Specified by:
setCapabilities
in interfaceConfigurationMutator
- Parameters:
capabilities
- property value- See Also:
ConfigurationProperties.getCapabilities()
-
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 interfaceConfigurationProperties
- Returns:
- driverLifecycle property value
-
getBrowserTimeout
public java.lang.Long getBrowserTimeout()
Description copied from interface:ConfigurationProperties
browserTimeout
property. Sets the maximum amount of time when the browser should start responding to the WebDriver. Default value is 60 seconds.- Specified by:
getBrowserTimeout
in interfaceConfigurationProperties
- Returns:
- long
-
getBrowserTimeoutRetries
public java.lang.Integer getBrowserTimeoutRetries()
Description copied from interface:ConfigurationProperties
browserTimeoutRetries
property. Sets the maximum number of retries for failed WebDriver because of browserTimeout issues. Default value is 2 times.- Specified by:
getBrowserTimeoutRetries
in interfaceConfigurationProperties
- Returns:
- Integer
-
setBrowserTimeout
public void setBrowserTimeout(java.lang.Long timeout)
Description copied from interface:ConfigurationMutator
Sets the value ofbrowserTimeout
property.- Specified by:
setBrowserTimeout
in interfaceConfigurationMutator
- Parameters:
timeout
- property value- See Also:
ConfigurationProperties.getBrowserTimeout()
-
setBrowserTimeoutRetries
public void setBrowserTimeoutRetries(java.lang.Integer retriesNumber)
Description copied from interface:ConfigurationMutator
Sets the value ofbrowserTimeoutRetries
property.- Specified by:
setBrowserTimeoutRetries
in interfaceConfigurationMutator
- Parameters:
retriesNumber
- property value- See Also:
ConfigurationProperties.getBrowserTimeoutRetries()
-
setDriverLifecycle
public void setDriverLifecycle(ConfigurationProperties.DriverLifecycle driverLifecycle)
Description copied from interface:ConfigurationMutator
Sets the value ofdriverLifecycle
property.- Specified by:
setDriverLifecycle
in interfaceConfigurationMutator
- Parameters:
driverLifecycle
- property value- See Also:
ConfigurationProperties.getDriverLifecycle()
-
getDeleteCookies
public java.lang.Boolean getDeleteCookies()
Description copied from interface:ConfigurationProperties
deleteCookies
property. When using CLASS or JVMdriverLifecycle
configuration property, allow to delete cookies between each test. Default value is false.- Specified by:
getDeleteCookies
in interfaceConfigurationProperties
- Returns:
- deleteCookies property value.
-
setDeleteCookies
public void setDeleteCookies(java.lang.Boolean deleteCookies)
Description copied from interface:ConfigurationMutator
Sets the value ofdeleteCookies
property.- Specified by:
setDeleteCookies
in interfaceConfigurationMutator
- Parameters:
deleteCookies
- property value- See Also:
ConfigurationProperties.getDeleteCookies()
-
getConfigurationFactory
public java.lang.Class<? extends ConfigurationFactory> getConfigurationFactory()
Description copied from interface:ConfigurationProperties
configurationFactory
property. Set this to a class implementingConfigurationFactory
to customize the ways properties are read. This allow to configure properties from sources that are not supported by default FluentLenium. Default value isDefaultConfigurationFactory
class.- Specified by:
getConfigurationFactory
in interfaceConfigurationProperties
- Returns:
- Custom
ConfigurationFactory
class.
-
setConfigurationFactory
public void setConfigurationFactory(java.lang.Class<? extends ConfigurationFactory> configurationFactory)
Description copied from interface:ConfigurationMutator
Sets the value ofconfigurationFactory
property.- Specified by:
setConfigurationFactory
in interfaceConfigurationMutator
- Parameters:
configurationFactory
- property value- See Also:
ConfigurationProperties.getConfigurationFactory()
-
getConfigurationDefaults
public java.lang.Class<? extends ConfigurationProperties> getConfigurationDefaults()
Description copied from interface:ConfigurationProperties
configurationDefaults
property. Set this to a class implementingConfigurationProperties
to provide the default values of the configuration properties. Default value isConfigurationDefaults
- Specified by:
getConfigurationDefaults
in interfaceConfigurationProperties
- Returns:
- Custom
ConfigurationProperties
instance with default values.
-
getBaseUrl
public java.lang.String getBaseUrl()
Description copied from interface:ConfigurationProperties
baseUrl
property. Sets the base URL used to build absolute URL when relative URL is given toFluentControl.goTo(String)
. Default value is null.- Specified by:
getBaseUrl
in interfaceConfigurationProperties
- Returns:
- baseUrl property value
-
setBaseUrl
public void setBaseUrl(java.lang.String baseUrl)
Description copied from interface:ConfigurationMutator
Sets the value ofbaseUrl
property.- Specified by:
setBaseUrl
in interfaceConfigurationMutator
- Parameters:
baseUrl
- property value- See Also:
()
-
getPageLoadTimeout
public java.lang.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 interfaceConfigurationProperties
- Returns:
- pageLoadTimeout property value
- See Also:
WebDriver.Timeouts.pageLoadTimeout(long, java.util.concurrent.TimeUnit)
-
setPageLoadTimeout
public void setPageLoadTimeout(java.lang.Long pageLoadTimeout)
Description copied from interface:ConfigurationMutator
Sets the value ofpageLoadTimeout
property.- Specified by:
setPageLoadTimeout
in interfaceConfigurationMutator
- Parameters:
pageLoadTimeout
- property value- See Also:
ConfigurationProperties.getPageLoadTimeout()
-
getImplicitlyWait
public java.lang.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 interfaceConfigurationProperties
- Returns:
- implicitlyWait property value
- See Also:
WebDriver.Timeouts.implicitlyWait(long, java.util.concurrent.TimeUnit)
-
setImplicitlyWait
public void setImplicitlyWait(java.lang.Long implicitlyWait)
Description copied from interface:ConfigurationMutator
Sets the value ofimplicitlyWait
property.- Specified by:
setImplicitlyWait
in interfaceConfigurationMutator
- Parameters:
implicitlyWait
- property value- See Also:
ConfigurationProperties.getImplicitlyWait()
-
getScriptTimeout
public java.lang.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 interfaceConfigurationProperties
- Returns:
- scriptTimeout property value
- See Also:
WebDriver.Timeouts.setScriptTimeout(long, java.util.concurrent.TimeUnit)
-
setScriptTimeout
public void setScriptTimeout(java.lang.Long scriptTimeout)
Description copied from interface:ConfigurationMutator
Sets the value ofscriptTimeout
property.- Specified by:
setScriptTimeout
in interfaceConfigurationMutator
- Parameters:
scriptTimeout
- property value- See Also:
ConfigurationProperties.getScriptTimeout()
-
getAwaitAtMost
public java.lang.Long getAwaitAtMost()
Description copied from interface:ConfigurationProperties
awaitAtMost
property. Sets the default timeout in millisecond when usingFluentControl.await()
orWait
hook.- Specified by:
getAwaitAtMost
in interfaceConfigurationProperties
- Returns:
- awaitTimeout property value
- See Also:
FluentWaitConfiguration.atMost(long, java.util.concurrent.TimeUnit)
,FluentWaitConfiguration.atMost(long)
-
setAwaitAtMost
public void setAwaitAtMost(java.lang.Long awaitAtMost)
Description copied from interface:ConfigurationMutator
Sets the value ofawaitAtMost
property- Specified by:
setAwaitAtMost
in interfaceConfigurationMutator
- Parameters:
awaitAtMost
- property value- See Also:
ConfigurationProperties.getAwaitAtMost()
-
getAwaitPollingEvery
public java.lang.Long getAwaitPollingEvery()
Description copied from interface:ConfigurationProperties
awaitPollingEvery
property. Sets the default polling frequency in millisecond when usingFluentControl.await()
orWait
hook.- Specified by:
getAwaitPollingEvery
in interfaceConfigurationProperties
- Returns:
- awaitPollingEvery property value
- See Also:
FluentWaitConfiguration.pollingEvery(long, java.util.concurrent.TimeUnit)
,FluentWaitConfiguration.pollingEvery(long)
-
setAwaitPollingEvery
public void setAwaitPollingEvery(java.lang.Long awaitPollingEvery)
Description copied from interface:ConfigurationMutator
Sets the value ofawaitPollingEvery
property- Specified by:
setAwaitPollingEvery
in interfaceConfigurationMutator
- Parameters:
awaitPollingEvery
- property value- See Also:
ConfigurationProperties.getAwaitPollingEvery()
-
getEventsEnabled
public java.lang.Boolean getEventsEnabled()
Description copied from interface:ConfigurationProperties
eventsEnabled
property. EnablesFluentControl.events()
by wrapping theWebDriver
inEventFiringWebDriver
. Default value is true.- Specified by:
getEventsEnabled
in interfaceConfigurationProperties
- Returns:
- eventsEnabled property value.
-
setEventsEnabled
public void setEventsEnabled(java.lang.Boolean eventsEnabled)
Description copied from interface:ConfigurationMutator
Sets the value ofeventsEnabled
property.- Specified by:
setEventsEnabled
in interfaceConfigurationMutator
- Parameters:
eventsEnabled
- property value
-
setScreenshotPath
public void setScreenshotPath(java.lang.String path)
Description copied from interface:ConfigurationMutator
Sets the value ofscreenshotPath
property.- Specified by:
setScreenshotPath
in interfaceConfigurationMutator
- Parameters:
path
- property value- See Also:
ConfigurationProperties.getScreenshotPath()
-
setHtmlDumpPath
public void setHtmlDumpPath(java.lang.String htmlDumpPath)
Description copied from interface:ConfigurationMutator
Sets the value ofhtmlDumpPath
property.- Specified by:
setHtmlDumpPath
in interfaceConfigurationMutator
- Parameters:
htmlDumpPath
- property value- See Also:
ConfigurationProperties.getHtmlDumpPath()
-
setScreenshotMode
public void setScreenshotMode(ConfigurationProperties.TriggerMode mode)
Description copied from interface:ConfigurationMutator
Sets the value ofscreenshotMode
property.- Specified by:
setScreenshotMode
in interfaceConfigurationMutator
- Parameters:
mode
- property value- See Also:
ConfigurationProperties.getScreenshotMode()
-
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 interfaceConfigurationProperties
- Returns:
- screenshotMode property value.
- See Also:
ConfigurationProperties.TriggerMode
-
getScreenshotPath
public java.lang.String getScreenshotPath()
Description copied from interface:ConfigurationProperties
screenshotPath
property. Sets the filesystem path where screenshot will be saved when callingFluentControl.takeScreenshot()
orFluentControl.takeScreenshot(String)
. Default value is null.- Specified by:
getScreenshotPath
in interfaceConfigurationProperties
- Returns:
- screenshotPath property value
-
getHtmlDumpPath
public java.lang.String getHtmlDumpPath()
Description copied from interface:ConfigurationProperties
htmlDumpPath
property. Sets the filesystem path where screenshot will be saved when callingFluentControl.takeHtmlDump()
orFluentControl.takeHtmlDump(String)
. Default value is null.- Specified by:
getHtmlDumpPath
in interfaceConfigurationProperties
- Returns:
- htmlDumpPath property value
-
setHtmlDumpMode
public void setHtmlDumpMode(ConfigurationProperties.TriggerMode htmlDumpMode)
Description copied from interface:ConfigurationMutator
Sets the value ofhtmlDumpMode
property.- Specified by:
setHtmlDumpMode
in interfaceConfigurationMutator
- Parameters:
htmlDumpMode
- property value- See Also:
ConfigurationProperties.getHtmlDumpMode()
-
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 interfaceConfigurationProperties
- Returns:
- htmlDumpMode property value.
- See Also:
ConfigurationProperties.TriggerMode
-
getCustomProperty
public java.lang.String getCustomProperty(java.lang.String propertyName)
Description copied from interface:ConfigurationProperties
Get custom property value.- Specified by:
getCustomProperty
in interfaceConfigurationProperties
- Parameters:
propertyName
- name of the property- Returns:
- property value
-
setCustomProperty
public void setCustomProperty(java.lang.String key, java.lang.String value)
Description copied from interface:ConfigurationMutator
Sets custom value for a custom property key- Specified by:
setCustomProperty
in interfaceConfigurationMutator
- Parameters:
key
- custom property keyvalue
- custom property value
-
-