Config (selenium-tinafw 0.3.2 API)

java.lang.Object
- me.alb_i986.selenium.tinafw.config.Config

```
public class Config
extends Object
```
Static class defining a method for each and every configurable setting (aka property) this framework offers.
It is backed by a PropertyLoader, which hides the low-level details of retrieving properties. This implementation reads properties from the following sources (in the given order):
1. system properties, defined e.g. as -D arguments to the mvn command
2. properties files (resources)
  1. custom properties file: "/config.custom.properties"
  2. defaults properties file: "/config.default.properties"
A property may be:
- required: if it is not defined, then throw ConfigException
- optional: if it is not defined, then return null
- not empty: if it is an empty string, then throw ConfigException
Clients extending this framework, needing their own configurable settings, should extend this class, and:
- define one constant for each new configurable setting, with its name
  - optionally, also redefine (aka hide) the constant NAMESPACE with their own namespace
- define a public static method for each new configurable setting, implementing the retrieval of that setting, which should delegate to getOptionalProperty(String) or getRequiredProperty(String), or to the more generic getProperty(String, boolean), for those properties that are required by some tasks, but may not be so for some other task.
- optionally, change the logic of how to retrieve properties by redefining propLoader

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CUSTOM_PROPS_RESOURCE`
`static String`	`DEFAULT_PROPS_RESOURCE`
`static String`	`NAMESPACE`
`static String`	`PROP_BASE_URL`
`static String`	`PROP_BROWSERS`
`static String`	`PROP_GRID_BROWSER_VERSION`
`static String`	`PROP_GRID_HUB_URL`
`static String`	`PROP_GRID_PLATFORM`
`static String`	`PROP_KEEP_BROWSERS_OPEN`
`static String`	`PROP_MAX_EXECUTIONS`
`protected static String`	`PROP_PREFIX`
`static String`	`PROP_REPORTS_DIR`
`static String`	`PROP_TIMEOUT_EXPLICIT_WAIT`
`static String`	`PROP_TIMEOUT_IMPLICIT_WAIT`
`protected static PropertyLoader`	`propLoader`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Config()
This is a static class: as such, it cannot be instantiated.

Constructors
Modifier	Constructor and Description
`protected`	`Config()` This is a static class: as such, it cannot be instantiated.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getBaseUrl()`
`static List<SupportedBrowser>`	`getBrowsers()`
`static int`	`getExplicitWait()`
`static String`	`getGridBrowserVersion()`
`static URL`	`getGridHubUrl()`
`static org.openqa.selenium.Platform`	`getGridPlatform()`
`static Long`	`getImplicitWait()`
`static boolean`	`getKeepBrowsersOpen()`
`static int`	`getMaxExecutions()`
`protected static String`	`getOptionalProperty(String key)` Load the given property from one of the known sources.
`protected static String`	`getProperty(String propertyName, boolean required)`
`static String`	`getReportsDir()`
`protected static String`	`getRequiredProperty(String propertyName)`

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

- Field Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    
    Constant Field Values
  - PROP_PREFIX
```
protected static final String PROP_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROP_BASE_URL
```
public static final String PROP_BASE_URL
```
    See Also:
    
    Constant Field Values
  - PROP_TIMEOUT_IMPLICIT_WAIT
```
public static final String PROP_TIMEOUT_IMPLICIT_WAIT
```
    See Also:
    
    Constant Field Values
  - PROP_TIMEOUT_EXPLICIT_WAIT
```
public static final String PROP_TIMEOUT_EXPLICIT_WAIT
```
    See Also:
    
    Constant Field Values
  - PROP_KEEP_BROWSERS_OPEN
```
public static final String PROP_KEEP_BROWSERS_OPEN
```
    See Also:
    
    Constant Field Values
  - PROP_MAX_EXECUTIONS
```
public static final String PROP_MAX_EXECUTIONS
```
    See Also:
    
    Constant Field Values
  - PROP_REPORTS_DIR
```
public static final String PROP_REPORTS_DIR
```
    See Also:
    
    Constant Field Values
  - PROP_BROWSERS
```
public static final String PROP_BROWSERS
```
    See Also:
    
    Constant Field Values
  - PROP_GRID_PLATFORM
```
public static final String PROP_GRID_PLATFORM
```
    See Also:
    
    Constant Field Values
  - PROP_GRID_HUB_URL
```
public static final String PROP_GRID_HUB_URL
```
    See Also:
    
    Constant Field Values
  - PROP_GRID_BROWSER_VERSION
```
public static final String PROP_GRID_BROWSER_VERSION
```
    See Also:
    
    Constant Field Values
  - CUSTOM_PROPS_RESOURCE
```
public static final String CUSTOM_PROPS_RESOURCE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PROPS_RESOURCE
```
public static final String DEFAULT_PROPS_RESOURCE
```
    See Also:
    
    Constant Field Values
  - propLoader
```
protected static PropertyLoader propLoader
```
- Constructor Detail
  - Config
```
protected Config()
```
    This is a static class: as such, it cannot be instantiated.
- Method Detail
  - getBaseUrl
```
public static String getBaseUrl()
```
    Returns:
    
    the property "tinafw.base_url"
    
    Throws:
    
    SettingNotFoundException - if the property is not defined
  - getImplicitWait
```
public static Long getImplicitWait()
```
    Returns:
    
    the property "tinafw.timeout.implicit_wait"; null, if not found
  - getExplicitWait
```
public static int getExplicitWait()
```
    Returns:
    
    the property "tinafw.timeout.explicit_wait"
    
    Throws:
    
    SettingNotFoundException - if the property is not defined
    
    See Also:
    
    Integer.parseInt(String)
  - getKeepBrowsersOpen
```
public static boolean getKeepBrowsersOpen()
```
    Returns:
    
    the property "tinafw.keep_browsers_open" Please note, in case the property is defined and empty, it will be considered as false.
    
    Throws:
    
    SettingNotFoundException - if the property is not defined
    
    See Also:
    
    Boolean.parseBoolean(String)
  - getMaxExecutions
```
public static int getMaxExecutions()
```
    Returns:
    
    the property "tinafw.max_executions"
    
    Throws:
    
    SettingNotFoundException - if the property is not defined
    
    See Also:
    
    Integer.parseInt(String)
  - getReportsDir
```
public static String getReportsDir()
```
    Returns:
    
    the property "tinafw.reports_dir"
    
    Throws:
    
    SettingNotFoundException - if the property is not defined
  - getBrowsers
```
public static List<SupportedBrowser> getBrowsers()
```
    Returns:
    
    a List of the SupportedBrowser's specified in the property "tinafw.browsers"
    
    Throws:
    
    SettingNotFoundException - if the property can't be found,
    
    ConfigException - if the property is empty
    
    IllegalArgumentException - if one of the values cannot be converted to SupportedBrowser
    
    See Also:
    
    PropertiesUtils.split(String), PropertiesUtils.toSupportedBrowsers(String[])
  - getGridPlatform
```
public static org.openqa.selenium.Platform getGridPlatform()
```
    Returns:
    
    the Platform specified in the property "tinafw.grid.platform"; null, if not defined
  - getGridBrowserVersion
```
public static String getGridBrowserVersion()
```
    Returns:
    
    the property "tinafw.grid.browser_version"; null, if not defined.
  - getGridHubUrl
```
public static URL getGridHubUrl()
```
    Returns:
    
    a URL with the property "tinafw.grid.hub_url"; null, if not defined.
    
    See Also:
    
    PropertiesUtils.toURL(String)
  - getProperty
```
protected static String getProperty(String propertyName,
                                    boolean required)
```
    Returns:
    
    getRequiredProperty(String) if required is true; getOptionalProperty(String) otherwise.
  - getRequiredProperty
```
protected static String getRequiredProperty(String propertyName)
```
    Parameters:
    
    propertyName - the name of the property
    
    Returns:
    
    the value of the required property (might be an empty string)
    
    Throws:
    
    SettingNotFoundException - if the property cannot be found
  - getOptionalProperty
```
protected static String getOptionalProperty(String key)
```
    Load the given property from one of the known sources.
    The order of precedence is as follows:
    1. system properties, defined e.g. as -D arguments to the mvn command
    2. custom properties file, "/config.custom.properties"
    3. defaults properties file, "/config.default.properties"
    Parameters:
    
    key - the name of the property
    
    Returns:
    
    the value of the property; null if the property is not found

Class Config

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

PROP_PREFIX

PROP_BASE_URL

PROP_TIMEOUT_IMPLICIT_WAIT

PROP_TIMEOUT_EXPLICIT_WAIT

PROP_KEEP_BROWSERS_OPEN

PROP_MAX_EXECUTIONS

PROP_REPORTS_DIR

PROP_BROWSERS

PROP_GRID_PLATFORM

PROP_GRID_HUB_URL

PROP_GRID_BROWSER_VERSION

CUSTOM_PROPS_RESOURCE

DEFAULT_PROPS_RESOURCE

propLoader

Constructor Detail

Config

Method Detail

getBaseUrl

getImplicitWait

getExplicitWait

getKeepBrowsersOpen

getMaxExecutions

getReportsDir

getBrowsers

getGridPlatform

getGridBrowserVersion

getGridHubUrl

getProperty

getRequiredProperty

getOptionalProperty