cz.etnetera.seleniumbrowser.configuration

Class BasicBrowserConfiguration

java.lang.Object

cz.etnetera.seleniumbrowser.configuration.BasicBrowserConfiguration

All Implemented Interfaces:

BrowserConfiguration, ChainedPropertiesSource, DataSource, PropertySource

public class BasicBrowserConfiguration
extends Object
implements BrowserConfiguration, ChainedPropertiesSource, DataSource

Configures browser. You are free to add whatever methods you want as you can easily get overridden configuration BrowserContext.getConfiguration(Class). It allows to load properties from resource, path, file or Properties directly and it has higher priority than default values. You can obtain them later using BrowserContext.getProperty(String) and similar property based methods. Tries to get all possible values from chained properties. Properties are prefixed with 'browser.': baseUrlProperty = browser.baseUrlProperty baseUrlRegexProperty = browser.baseUrlRegexProperty urlVerificationProperty = browser.urlVerificationProperty waitTimeoutProperty = browser.waitTimeoutProperty waitRetryIntervalProperty = browser.waitRetryIntervalProperty reportedProperty = browser.reportedProperty reportDirProperty = browser.reportDirProperty For now only getDriver(DesiredCapabilities), getCapabilities() and getListeners() are not supported methods and calls default methods directly. In addition you can add any data using DataSource.addData(String, Object) and obtain it using DataSource.getData(String, Class).

Nested Class Summary

Nested classes/interfaces inherited from interface cz.etnetera.seleniumbrowser.source.ChainedPropertiesSource

ChainedPropertiesSource.PropertiesValue

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_URL
static String	BASE_URL_REGEX
protected Map<String,Object>	dataHolder
static String	DEFAULT_PROPERTIES_KEY
static String	DEFAULT_PROPERTIES_RESOURCE_NAME
static String	PREFIX
protected List<ChainedPropertiesSource.PropertiesValue>	propertiesHolder
static String	REPORT_DIR
static String	REPORTED
static String	SYSTEM_PROPERTIES_KEY
static String	URL_VERIFICATION
static String	WAIT_RETRY_INTERVAL
static String	WAIT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
BasicBrowserConfiguration() Constructs new instance with system and default properties.

Method Summary

Modifier and Type	Method and Description
BasicBrowserConfiguration	addDefaultProperties() Loads properties from resource DEFAULT_PROPERTIES_RESOURCE_NAME and adds them at the end of actual properties list.
BasicBrowserConfiguration	addDefaultPropertiesAfter(String afterKey) Loads properties from resource DEFAULT_PROPERTIES_RESOURCE_NAME and adds them after specific key in actual properties list.
BasicBrowserConfiguration	addDefaultPropertiesBefore(String beforeKey) Loads properties from resource DEFAULT_PROPERTIES_RESOURCE_NAME and adds them before specific key in actual properties list.
BasicBrowserConfiguration	addSystemProperties() Adds System.getProperties() at the end of actual properties list.
BasicBrowserConfiguration	addSystemPropertiesAfter(String afterKey) Adds System.getProperties() after specific key in actual properties list.
BasicBrowserConfiguration	addSystemPropertiesBefore(String beforeKey) Adds System.getProperties() before specific key in actual properties list.
String	getBaseUrl() Base URL for pages.
String	getBaseUrlRegex() Base URL regex for pages.
org.openqa.selenium.remote.DesiredCapabilities	getCapabilities() Returns optional DesiredCapabilities.
Map<String,Object>	getDataHolder() Returns map which holds data.
protected String	getDefaultBaseUrl() Default base URL for pages.
protected String	getDefaultBaseUrlRegex() Default base URL regex for pages.
protected org.openqa.selenium.remote.DesiredCapabilities	getDefaultCapabilities() Returns optional default DesiredCapabilities.
protected org.openqa.selenium.WebDriver	getDefaultDriver(org.openqa.selenium.remote.DesiredCapabilities caps) Returns default WebDriver instance.
protected List<BrowserListener>	getDefaultListeners() Returns default list of browser event listeners.
protected File	getDefaultReportDir() Returns default directory for storing browser files.
protected double	getDefaultWaitRetryInterval() Returns default wait retry interval.
protected double	getDefaultWaitTimeout() Returns default wait timeout.
org.openqa.selenium.WebDriver	getDriver(org.openqa.selenium.remote.DesiredCapabilities caps) Returns WebDriver instance.
List<BrowserListener>	getListeners() Returns list of browser event listeners.
List<ChainedPropertiesSource.PropertiesValue>	getPropertiesHolder()
File	getReportDir() Returns directory for storing browser files.
double	getWaitRetryInterval() Returns wait retry interval.
double	getWaitTimeout() Returns wait timeout.
void	init() It is called after putting it into browser.
protected boolean	isDefaultReported() Is storing files using browser enabled as default? Override this for different value.
protected boolean	isDefaultUrlVerification() Is URL on pages verified as default? Override this for different value.
boolean	isReported() Is storing files using browser enabled?
boolean	isUrlVerification() Is URL on pages verified?
BasicBrowserConfiguration	pushDefaultProperties() Loads properties from resource DEFAULT_PROPERTIES_RESOURCE_NAME and pushes them at the start of actual properties list.
BasicBrowserConfiguration	pushSystemProperties() Pushes System.getProperties() at the start of actual properties list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.etnetera.seleniumbrowser.source.ChainedPropertiesSource

addFileProperties, addFilePropertiesAfter, addFilePropertiesBefore, addProperties, addPropertiesAfter, addPropertiesBefore, addResourceProperties, addResourcePropertiesAfter, addResourcePropertiesBefore, getMergedProperties, getProperties, getProperties, getPropertiesWithKeys, getProperty, pushFileProperties, pushProperties, pushResourceProperties, removeProperties

Methods inherited from interface cz.etnetera.seleniumbrowser.source.PropertySource

castString, getProperty, getProperty, getProperty

Methods inherited from interface cz.etnetera.seleniumbrowser.source.DataSource

addData, getData, removeData

Field Detail

SYSTEM_PROPERTIES_KEY

public static final String SYSTEM_PROPERTIES_KEY

See Also:

Constant Field Values

DEFAULT_PROPERTIES_KEY

public static final String DEFAULT_PROPERTIES_KEY

See Also:

Constant Field Values

DEFAULT_PROPERTIES_RESOURCE_NAME

public static final String DEFAULT_PROPERTIES_RESOURCE_NAME

See Also:

Constant Field Values

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

BASE_URL

public static final String BASE_URL

See Also:

Constant Field Values

BASE_URL_REGEX

public static final String BASE_URL_REGEX

See Also:

Constant Field Values

URL_VERIFICATION

public static final String URL_VERIFICATION

See Also:

Constant Field Values

WAIT_TIMEOUT

public static final String WAIT_TIMEOUT

See Also:

Constant Field Values

WAIT_RETRY_INTERVAL

public static final String WAIT_RETRY_INTERVAL

See Also:

Constant Field Values

REPORTED

public static final String REPORTED

See Also:

Constant Field Values

REPORT_DIR

public static final String REPORT_DIR

See Also:

Constant Field Values

propertiesHolder

protected List<ChainedPropertiesSource.PropertiesValue> propertiesHolder

dataHolder

protected Map<String,Object> dataHolder

Constructor Detail

BasicBrowserConfiguration

public BasicBrowserConfiguration()

Constructs new instance with system and default properties.

Method Detail

getDefaultBaseUrl

protected String getDefaultBaseUrl()

Default base URL for pages. Override this for different value.

Returns:

The base URL

getDefaultBaseUrlRegex

protected String getDefaultBaseUrlRegex()

Default base URL regex for pages. Override this for different value.

Returns:

The base URL regex

isDefaultUrlVerification

protected boolean isDefaultUrlVerification()

Is URL on pages verified as default? Override this for different value.

Returns:

Verification status

getDefaultDriver

protected org.openqa.selenium.WebDriver getDefaultDriver(org.openqa.selenium.remote.DesiredCapabilities caps)

Returns default WebDriver instance. Override this for different value.

Parameters:

caps - The non null desired capabilities.

Returns:

The driver

getDefaultCapabilities

protected org.openqa.selenium.remote.DesiredCapabilities getDefaultCapabilities()

Returns optional default DesiredCapabilities. Override this for different value.

Returns:

The desired capabilities.

getDefaultWaitTimeout

protected double getDefaultWaitTimeout()

Returns default wait timeout. Override this for different value.

Returns:

The wait timeout.

getDefaultWaitRetryInterval

protected double getDefaultWaitRetryInterval()

Returns default wait retry interval. Override this for different value.

Returns:

The wait retry interval.

isDefaultReported

protected boolean isDefaultReported()

Is storing files using browser enabled as default? Override this for different value.

Returns:

Reporting status.

getDefaultReportDir

protected File getDefaultReportDir()

Returns default directory for storing browser files. Override this for different value.

Returns:

The report directory.

getDefaultListeners

protected List<BrowserListener> getDefaultListeners()

Returns default list of browser event listeners. Override this for different value.

Returns:

The browser event listeners.

init

public void init()

Description copied from interface: BrowserConfiguration

It is called after putting it into browser.

Specified by:

init in interface BrowserConfiguration

getBaseUrl

public String getBaseUrl()

Description copied from interface: BrowserConfiguration

Base URL for pages.

Specified by:

getBaseUrl in interface BrowserConfiguration

Returns:

The base URL

getBaseUrlRegex

public String getBaseUrlRegex()

Description copied from interface: BrowserConfiguration

Base URL regex for pages.

Specified by:

getBaseUrlRegex in interface BrowserConfiguration

Returns:

The base URL regex

isUrlVerification

public boolean isUrlVerification()

Description copied from interface: BrowserConfiguration

Is URL on pages verified?

Specified by:

isUrlVerification in interface BrowserConfiguration

Returns:

Verification status

getDriver

public org.openqa.selenium.WebDriver getDriver(org.openqa.selenium.remote.DesiredCapabilities caps)

Description copied from interface: BrowserConfiguration

Returns WebDriver instance.

Specified by:

getDriver in interface BrowserConfiguration

Parameters:

caps - The non null desired capabilities.

Returns:

The driver

getCapabilities

public org.openqa.selenium.remote.DesiredCapabilities getCapabilities()

Description copied from interface: BrowserConfiguration

Returns optional DesiredCapabilities.

Specified by:

getCapabilities in interface BrowserConfiguration

Returns:

The desired capabilities.

getWaitTimeout

public double getWaitTimeout()

Description copied from interface: BrowserConfiguration

Returns wait timeout.

Specified by:

getWaitTimeout in interface BrowserConfiguration

Returns:

The wait timeout.

getWaitRetryInterval

public double getWaitRetryInterval()

Description copied from interface: BrowserConfiguration

Returns wait retry interval.

Specified by:

getWaitRetryInterval in interface BrowserConfiguration

Returns:

The wait retry interval.

isReported

public boolean isReported()

Description copied from interface: BrowserConfiguration

Is storing files using browser enabled?

Specified by:

isReported in interface BrowserConfiguration

Returns:

Reporting status.

getReportDir

public File getReportDir()

Description copied from interface: BrowserConfiguration

Returns directory for storing browser files.

Specified by:

getReportDir in interface BrowserConfiguration

Returns:

The report directory.

getListeners

public List<BrowserListener> getListeners()

Description copied from interface: BrowserConfiguration

Returns list of browser event listeners.

Specified by:

getListeners in interface BrowserConfiguration

Returns:

The browser event listeners.

getPropertiesHolder

public List<ChainedPropertiesSource.PropertiesValue> getPropertiesHolder()

Specified by:

getPropertiesHolder in interface ChainedPropertiesSource

getDataHolder

public Map<String,Object> getDataHolder()

Description copied from interface: DataSource

Returns map which holds data.

Specified by:

getDataHolder in interface DataSource

Returns:

The data holder map

addDefaultProperties

public BasicBrowserConfiguration addDefaultProperties()

Loads properties from resource DEFAULT_PROPERTIES_RESOURCE_NAME and adds them at the end of actual properties list.

Returns:

Same instance

addDefaultPropertiesBefore

public BasicBrowserConfiguration addDefaultPropertiesBefore(String beforeKey)

Loads properties from resource DEFAULT_PROPERTIES_RESOURCE_NAME and adds them before specific key in actual properties list.

Parameters:

beforeKey - The before properties key

Returns:

Same instance

addDefaultPropertiesAfter

public BasicBrowserConfiguration addDefaultPropertiesAfter(String afterKey)

Loads properties from resource DEFAULT_PROPERTIES_RESOURCE_NAME and adds them after specific key in actual properties list.

Parameters:

afterKey - The after properties key

Returns:

Same instance

addSystemProperties

public BasicBrowserConfiguration addSystemProperties()

Adds System.getProperties() at the end of actual properties list.

Returns:

Same instance

addSystemPropertiesBefore

public BasicBrowserConfiguration addSystemPropertiesBefore(String beforeKey)

Adds System.getProperties() before specific key in actual properties list.

Parameters:

beforeKey - The before properties key

Returns:

Same instance

addSystemPropertiesAfter

public BasicBrowserConfiguration addSystemPropertiesAfter(String afterKey)

Adds System.getProperties() after specific key in actual properties list.

Parameters:

afterKey - The after properties key

Returns:

Same instance

pushDefaultProperties

public BasicBrowserConfiguration pushDefaultProperties()

Loads properties from resource DEFAULT_PROPERTIES_RESOURCE_NAME and pushes them at the start of actual properties list.

Returns:

Same instance

pushSystemProperties

public BasicBrowserConfiguration pushSystemProperties()

Pushes System.getProperties() at the start of actual properties list.

Returns:

Same instance