Package io.fluentlenium.configuration

Class ProgrammaticConfiguration

java.lang.Object

io.fluentlenium.configuration.ProgrammaticConfiguration

All Implemented Interfaces:

Configuration, ConfigurationMutator, ConfigurationProperties

public class ProgrammaticConfiguration
                    extends Object
implements Configuration
                

Configuration based on JavaBean properties.

See Also:

• Configuration
• ConfigurationProperties

Nested Class Summary

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

ConfigurationProperties.DriverLifecycle, ConfigurationProperties.TriggerMode

Constructor Summary

Constructors

Constructor	Description
ProgrammaticConfiguration()

Method Summary

Modifier and Type	Method	Description
Long	getAwaitAtMost()	awaitAtMost
Long	getAwaitPollingEvery()	awaitPollingEvery
String	getBaseUrl()	baseUrl
Long	getBrowserTimeout()	browserTimeout
Integer	getBrowserTimeoutRetries()	browserTimeoutRetries
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
String	getRemoteUrl()	remoteUrl
ConfigurationProperties.TriggerMode	getScreenshotMode()	screenshotMode
String	getScreenshotPath()	screenshotPath
Long	getScriptTimeout()	scriptTimeout
String	getWebDriver()	webDriver
void	setAwaitAtMost (Long awaitAtMost)	Sets the value of
void	setAwaitPollingEvery (Long awaitPollingEvery)	Sets the value of
void	setBaseUrl (String baseUrl)	Sets the value of
void	setBrowserTimeout (Long timeout)	Sets the value of
void	setBrowserTimeoutRetries (Integer retriesNumber)	Sets the value of
void	setCapabilities (org.openqa.selenium.Capabilities capabilities)	Sets the value of
void	setConfigurationDefaults (Class<? extends ConfigurationProperties> configurationDefaults)	Set the configuration defaults.
void	setConfigurationFactory (Class<? extends ConfigurationFactory> configurationFactory)	Sets the value of
void	setCustomProperty (String key, String value)	Sets custom value for a custom property key
void	setDeleteCookies (Boolean deleteCookies)	Sets the value of
void	setDriverLifecycle (ConfigurationProperties.DriverLifecycle driverLifecycle)	Sets the value of
void	setEventsEnabled (Boolean eventsEnabled)	Sets the value of
void	setHtmlDumpMode (ConfigurationProperties.TriggerMode htmlDumpMode)	Sets the value of
void	setHtmlDumpPath (String htmlDumpPath)	Sets the value of
void	setImplicitlyWait (Long implicitlyWait)	Sets the value of
void	setPageLoadTimeout (Long pageLoadTimeout)	Sets the value of
void	setRemoteUrl (String remoteUrl)	Sets the value of
void	setScreenshotMode (ConfigurationProperties.TriggerMode mode)	Sets the value of
void	setScreenshotPath (String path)	Sets the value of
void	setScriptTimeout (Long scriptTimeout)	Sets the value of
void	setWebDriver (String webDriverName)	Sets the value of

Methods inherited from class java.lang.Object

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

Constructor Details

ProgrammaticConfiguration

public ProgrammaticConfiguration()
                                        

Method Details

setConfigurationDefaults

public void setConfigurationDefaults
                                            
                                            (Class<? extends ConfigurationProperties> configurationDefaults)
                                        

Set the configuration defaults.

Parameters:

configurationDefaults - configuration defaults

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 IFluentAdapter.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", "edge", "htmlunit", "safari", "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 interface ConfigurationProperties

Returns:

webDriver property value

See Also:

• IFluentAdapter.newWebDriver()
• DefaultWebDriverFactories

setWebDriver

public void setWebDriver
                                            
                                            (String webDriverName)

Description copied from interface: ConfigurationMutator

Sets the value of

webDriver

property.

Specified by:

setWebDriver in interface ConfigurationMutator

Parameters:

webDriverName - property value

See Also:

• ConfigurationProperties.getWebDriver()

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

setRemoteUrl

public void setRemoteUrl
                                            
                                            (String remoteUrl)

Description copied from interface: ConfigurationMutator

Sets the value of

remoteUrl

property.

Specified by:

setRemoteUrl in interface ConfigurationMutator

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 interface ConfigurationProperties

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 of

capabilities

property.

Specified by:

setCapabilities in interface ConfigurationMutator

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 interface ConfigurationProperties

Returns:

driverLifecycle property value

getBrowserTimeout

public 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 interface ConfigurationProperties

Returns:

long

getBrowserTimeoutRetries

public 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 interface ConfigurationProperties

Returns:

Integer

setBrowserTimeout

public void setBrowserTimeout
                                            
                                            (Long timeout)

Description copied from interface: ConfigurationMutator

Sets the value of

browserTimeout

property.

Specified by:

setBrowserTimeout in interface ConfigurationMutator

Parameters:

timeout - property value

See Also:

• ConfigurationProperties.getBrowserTimeout()

setBrowserTimeoutRetries

public void setBrowserTimeoutRetries
                                            
                                            (Integer retriesNumber)
                                        

Description copied from interface: ConfigurationMutator

Sets the value of

browserTimeoutRetries

property.

Specified by:

setBrowserTimeoutRetries in interface ConfigurationMutator

Parameters:

retriesNumber - property value

See Also:

• ConfigurationProperties.getBrowserTimeoutRetries()

setDriverLifecycle

public void setDriverLifecycle
                                            
                                            (ConfigurationProperties.DriverLifecycle driverLifecycle)
                                        

Description copied from interface: ConfigurationMutator

Sets the value of

driverLifecycle

property.

Specified by:

setDriverLifecycle in interface ConfigurationMutator

Parameters:

driverLifecycle - property value

See Also:

• ConfigurationProperties.getDriverLifecycle()

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.

setDeleteCookies

public void setDeleteCookies
                                            
                                            (Boolean deleteCookies)
                                        

Description copied from interface: ConfigurationMutator

Sets the value of

deleteCookies

property.

Specified by:

setDeleteCookies in interface ConfigurationMutator

Parameters:

deleteCookies - property value

See Also:

• ConfigurationProperties.getDeleteCookies()

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.

setConfigurationFactory

public void setConfigurationFactory
                                            
                                            (Class<? extends ConfigurationFactory> configurationFactory)
                                        

Description copied from interface: ConfigurationMutator

Sets the value of

configurationFactory

property.

Specified by:

setConfigurationFactory in interface ConfigurationMutator

Parameters:

configurationFactory - property value

See Also:

• ConfigurationProperties.getConfigurationFactory()

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.

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 FluentControl.goTo(String). Default value is null.

Specified by:

getBaseUrl in interface ConfigurationProperties

Returns:

baseUrl property value

setBaseUrl

public void setBaseUrl
                                            
                                            (String baseUrl)

Description copied from interface: ConfigurationMutator

Sets the value of

baseUrl

property.

Specified by:

setBaseUrl in interface ConfigurationMutator

Parameters:

baseUrl - property value

See Also:

• ()

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)

setPageLoadTimeout

public void setPageLoadTimeout
                                            
                                            (Long pageLoadTimeout)

Description copied from interface: ConfigurationMutator

Sets the value of

pageLoadTimeout

property.

Specified by:

setPageLoadTimeout in interface ConfigurationMutator

Parameters:

pageLoadTimeout - property value

See Also:

• ConfigurationProperties.getPageLoadTimeout()

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)

setImplicitlyWait

public void setImplicitlyWait
                                            
                                            (Long implicitlyWait)

Description copied from interface: ConfigurationMutator

Sets the value of

implicitlyWait

property.

Specified by:

setImplicitlyWait in interface ConfigurationMutator

Parameters:

implicitlyWait - property value

See Also:

• ConfigurationProperties.getImplicitlyWait()

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)

setScriptTimeout

public void setScriptTimeout
                                            
                                            (Long scriptTimeout)

Description copied from interface: ConfigurationMutator

Sets the value of

scriptTimeout

property.

Specified by:

setScriptTimeout in interface ConfigurationMutator

Parameters:

scriptTimeout - property value

See Also:

• ConfigurationProperties.getScriptTimeout()

getAwaitAtMost

public Long getAwaitAtMost()
                                        

Description copied from interface: ConfigurationProperties

awaitAtMost

property. Sets the default timeout in millisecond when using FluentControl.await() or Wait hook.

Specified by:

getAwaitAtMost in interface ConfigurationProperties

Returns:

awaitTimeout property value

See Also:

• FluentWaitConfiguration.atMost(long, java.util.concurrent.TimeUnit)
• FluentWaitConfiguration.atMost(long)

setAwaitAtMost

public void setAwaitAtMost
                                            
                                            (Long awaitAtMost)

Description copied from interface: ConfigurationMutator

Sets the value of

awaitAtMost

property

Specified by:

setAwaitAtMost in interface ConfigurationMutator

Parameters:

awaitAtMost - property value

See Also:

• ConfigurationProperties.getAwaitAtMost()

getAwaitPollingEvery

public Long getAwaitPollingEvery()
                                        

Description copied from interface: ConfigurationProperties

awaitPollingEvery

property. Sets the default polling frequency in millisecond when using FluentControl.await() or Wait hook.

Specified by:

getAwaitPollingEvery in interface ConfigurationProperties

Returns:

awaitPollingEvery property value

See Also:

• FluentWaitConfiguration.pollingEvery(long, java.util.concurrent.TimeUnit)
• FluentWaitConfiguration.pollingEvery(long)

setAwaitPollingEvery

public void setAwaitPollingEvery
                                            
                                            (Long awaitPollingEvery)

Description copied from interface: ConfigurationMutator

Sets the value of

awaitPollingEvery

property

Specified by:

setAwaitPollingEvery in interface ConfigurationMutator

Parameters:

awaitPollingEvery - property value

See Also:

• ConfigurationProperties.getAwaitPollingEvery()

getEventsEnabled

public Boolean getEventsEnabled()
                                        

Description copied from interface: ConfigurationProperties

eventsEnabled

property. Enables FluentControl.events() by wrapping the WebDriver in EventFiringWebDriver. Default value is true.

Specified by:

getEventsEnabled in interface ConfigurationProperties

Returns:

eventsEnabled property value.

setEventsEnabled

public void setEventsEnabled
                                            
                                            (Boolean eventsEnabled)
                                        

Description copied from interface: ConfigurationMutator

Sets the value of

eventsEnabled

property.

Specified by:

setEventsEnabled in interface ConfigurationMutator

Parameters:

eventsEnabled - property value

setScreenshotPath

public void setScreenshotPath
                                            
                                            (String path)

Description copied from interface: ConfigurationMutator

Sets the value of

screenshotPath

property.

Specified by:

setScreenshotPath in interface ConfigurationMutator

Parameters:

path - property value

See Also:

• ConfigurationProperties.getScreenshotPath()

setHtmlDumpPath

public void setHtmlDumpPath
                                            
                                            (String htmlDumpPath)

Description copied from interface: ConfigurationMutator

Sets the value of

htmlDumpPath

property.

Specified by:

setHtmlDumpPath in interface ConfigurationMutator

Parameters:

htmlDumpPath - property value

See Also:

• ConfigurationProperties.getHtmlDumpPath()

setScreenshotMode

public void setScreenshotMode
                                            
                                            (ConfigurationProperties.TriggerMode mode)
                                        

Description copied from interface: ConfigurationMutator

Sets the value of

screenshotMode

property.

Specified by:

setScreenshotMode in interface ConfigurationMutator

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 interface ConfigurationProperties

Returns:

screenshotMode property value.

See Also:

• ConfigurationProperties.TriggerMode

getScreenshotPath

public String getScreenshotPath()
                                        

Description copied from interface: ConfigurationProperties

screenshotPath

property. Sets the filesystem path where screenshot will be saved when calling FluentControl.takeScreenshot() or FluentControl.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 FluentControl.takeHtmlDump() or FluentControl.takeHtmlDump(String). Default value is null.

Specified by:

getHtmlDumpPath in interface ConfigurationProperties

Returns:

htmlDumpPath property value

setHtmlDumpMode

public void setHtmlDumpMode
                                            
                                            (ConfigurationProperties.TriggerMode htmlDumpMode)
                                        

Description copied from interface: ConfigurationMutator

Sets the value of

htmlDumpMode

property.

Specified by:

setHtmlDumpMode in interface ConfigurationMutator

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 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

setCustomProperty

public void setCustomProperty
                                            
                                            (String key,
 String value)

Description copied from interface: ConfigurationMutator

Sets custom value for a custom property key

Specified by:

setCustomProperty in interface ConfigurationMutator

Parameters:

key - custom property key

value - custom property value