com.github.mkolisnyk.sirius.client

Class Configuration

java.lang.Object

com.github.mkolisnyk.sirius.client.Configuration

public final class Configuration
extends java.lang.Object

Global object for configuration data storage. Configuration data is supposed to be stored in the properties file. By default the configuration is taken from the config.properties file which should be located either in the root project folder or in the resource root. If there's a need to read configuration from different location it is recommended to call setDefaultConfigFile(String) method before any other calls to other configuration methods.

Sample use:

 Configuration.load(); // Loads configuration options
 String value = Configuration.get("config_property"); // Gets config_property property value
 

For more information read methods description.

Author:

Mykola Kolisnyk

Method Summary

Modifier and Type	Method and Description
static java.lang.String	get(ConfigurationOption option) Gets value for the predefined configuration option which is defined as ConfigurationOption enumeration.
static java.lang.String	get(java.lang.String option) Gets the value of the configuration option specified by the parameter.
static java.lang.String	getDefaultConfigFile() Returns the default location of the configuration file to read data from.
static void	load() Overloaded version of the load(String) method where the default configuration location is used.
static void	load(java.lang.String location) Loads properties from the file specified by the location.
static java.lang.String	pagesPackage() Retrieves the value of pages package.
static Platform	platform() Retrieves configuration option value for currently defined platform.
static void	print() Prints all available configuration options with their values into standard output stream.
static void	reset() Restores the internal data to initial state when the list of properties is null and the default configuration path is config.properties.
static void	setDefaultConfigFile(java.lang.String defaultConfigFileValue) Sets the default location for the configuration file.
static int	timeout() Returns timeout value based on ConfigurationOption.TIMEOUT parameter.

Methods inherited from class java.lang.Object

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

Method Detail

reset

public static void reset()

Restores the internal data to initial state when the list of properties is null and the default configuration path is config.properties.

load

public static void load(java.lang.String location)
                 throws java.io.IOException

Loads properties from the file specified by the location. The location may refer either to file path (either absolute or relative) or to resource path in case the configuration path is provided as the resource.

NOTE: if both external file and resource are available by the path specified by location parameter, the external file is read.

Parameters:

location - path to the properties file which can be either external file or internal resource.

Throws:

java.io.IOException - invoked in case of any problems with reading file.

load

public static void load()
                 throws java.io.IOException

Overloaded version of the load(String) method where the default configuration location is used. Without any additional settings that would be config.properties file. If any other default location is needed, it is recommended to call setDefaultConfigFile(String) method first.

Throws:

java.io.IOException - invoked in case of any problems with reading file.

See Also:

setDefaultConfigFile(String), getDefaultConfigFile(), load(String)

getDefaultConfigFile

public static java.lang.String getDefaultConfigFile()

Returns the default location of the configuration file to read data from.

Returns:

default configuration file/resource location.

setDefaultConfigFile

public static void setDefaultConfigFile(java.lang.String defaultConfigFileValue)

Sets the default location for the configuration file. If custom configuration location is used it is recommended to invoke this method first.

Parameters:

defaultConfigFileValue - New default configuration file/ resource location.

get

public static java.lang.String get(java.lang.String option)

Gets the value of the configuration option specified by the parameter.

If configuration hasn't been loaded yet the load() method will be forcibly invoked. It means that by default the Configuration object invokes configuration load from the default location.

Parameters:

option - the configuration option name to get value for. Name is represented as the string.

Returns:

the configuration option value.

get

public static java.lang.String get(ConfigurationOption option)

Gets value for the predefined configuration option which is defined as ConfigurationOption enumeration. Such version is needed for frequently used configuration options which have dedicated constant.

Parameters:

option - the configuration option code to get value for.

Returns:

the value of configuration parameter.

See Also:

ConfigurationOption

print

public static void print()

Prints all available configuration options with their values into standard output stream.

timeout

public static int timeout()

Returns timeout value based on ConfigurationOption.TIMEOUT parameter. If such option is unavailable the default value of 60 seconds is returned. Mainly this method can be used together with WebDriver waiting predicates as the default explicit timeout.

Returns:

the timeout value.

platform

public static Platform platform()

Retrieves configuration option value for currently defined platform.

Returns:

platform name defined in configuration.

See Also:

Platform

pagesPackage

public static java.lang.String pagesPackage()

Retrieves the value of pages package. It is mainly needed for page related classes which initialize page objects.

Returns:

the package name which contains page classes.