Package de.qytera.qtaf.core.config

Class ConfigurationFactory

java.lang.Object

de.qytera.qtaf.core.config.ConfigurationFactory

public class ConfigurationFactory
extends Object

Factory class for generating a configuration object from a JSON configuration file.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIGURATION_RESOURCE_URL	Default configuration resource location.
static final String	FILE_PATH	Default configuration path which is used if no custom path is provided.
static final String	QTAF_CONFIG_RESOURCES_BASE_DIR	Base resource directory.

Method Summary

Modifier and Type	Method	Description
static boolean	createConfigurationFileIfNotExists()	Create configuration file if it does not exist.
static boolean	createConfigurationFileIfNotExists(String qtafConfigResourcesBaseDir, String filePath)	Create configuration file if it does not exist.
static ConfigMap	getInstance()	Create default configuration object.
static ConfigMap	getInstance(String fileName)	Create a new configuration object.
static String	readDefaultConfigurationFileContent()	Reads the default configuration file that is shipped with the QTAF JAR file.

Methods inherited from class java.lang.Object

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

Field Details

FILE_PATH

public static final String FILE_PATH

Default configuration path which is used if no custom path is provided.

See Also:

• Constant Field Values

CONFIGURATION_RESOURCE_URL

public static final String CONFIGURATION_RESOURCE_URL

Default configuration resource location.

See Also:

• Constant Field Values

QTAF_CONFIG_RESOURCES_BASE_DIR

public static final String QTAF_CONFIG_RESOURCES_BASE_DIR

Base resource directory.

See Also:

• Constant Field Values

Method Details

getInstance

@Provides
public static ConfigMap getInstance()

Create default configuration object.

Returns:

Configuration

readDefaultConfigurationFileContent

public static String readDefaultConfigurationFileContent()
                                                  throws IOException

Reads the default configuration file that is shipped with the QTAF JAR file.

Returns:

Configuration file JSON content

Throws:

IOException - File not found

createConfigurationFileIfNotExists

public static boolean createConfigurationFileIfNotExists()
                                                  throws IOException

Create configuration file if it does not exist.

Returns:

true on success, false otherwise

Throws:

IOException - Error during file creation

createConfigurationFileIfNotExists

public static boolean createConfigurationFileIfNotExists(String qtafConfigResourcesBaseDir,
 String filePath)
                                                  throws IOException

Create configuration file if it does not exist.

Parameters:

qtafConfigResourcesBaseDir - Directory where QTAF configuration files are stored

filePath - relative path of the configuration file (relative to qtafConfigResourcesBaseDir)

Returns:

true on success, false otherwise

Throws:

IOException - Error during file creation

getInstance

public static ConfigMap getInstance(String fileName)

Create a new configuration object.

Parameters:

fileName - Name of the file

Returns:

Configuration