org.eclipse.basyx.components.configuration

Class BaSyxConfiguration

java.lang.Object

org.eclipse.basyx.components.configuration.BaSyxConfiguration

Direct Known Subclasses:

BaSyxContextConfiguration, BaSyxDockerConfiguration, BaSyxMongoDBConfiguration, BaSyxMqttConfiguration, BaSyxSQLConfiguration

public class BaSyxConfiguration
extends Object

Constructor Summary

Constructors

Constructor and Description
BaSyxConfiguration(Map<String,String> defaultValues) Constructor that takes the configuration's default values.

Method Summary

Modifier and Type	Method and Description
List<String>	getProperties(String prefix) Returns all contained properties that begin with a specific prefix
String	getProperty(String name) Queries a property
static InputStream	getResourceStream(String relativeResourcePath)
static String	getResourceString(String relativeResourcePath)
void	loadFileOrDefaultResource(String fileKey, String defaultResource) Load the configuration from a path relative to the current folder
void	loadFromFile(String filePath) Load the configuration from a path relative to the current folder
void	loadFromProperties(Properties properties) Load the configuration directly from properties.
void	loadFromResource(String relativeResourcePath) Load the configuration from a path relative to the current resource folder
void	loadFromStream(InputStream input) Load the configuration from an input stream
void	setProperty(String name, String value) Sets a property, if it is contained in this configuration

Methods inherited from class java.lang.Object

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

Constructor Detail

BaSyxConfiguration

public BaSyxConfiguration(Map<String,String> defaultValues)

Constructor that takes the configuration's default values. All the keys in the map are the name of the properties that are stored and loaded in this configuration.

Method Detail

getResourceStream

public static InputStream getResourceStream(String relativeResourcePath)

getResourceString

public static String getResourceString(String relativeResourcePath)
                                throws IOException

Throws:

IOException

loadFromFile

public void loadFromFile(String filePath)

Load the configuration from a path relative to the current folder

Parameters:

filePath - Path to the resource in the application folder

loadFileOrDefaultResource

public void loadFileOrDefaultResource(String fileKey,
                                      String defaultResource)

Load the configuration from a path relative to the current folder

Parameters:

filePath - Path to the resource in the application folder

loadFromStream

public void loadFromStream(InputStream input)

Load the configuration from an input stream

Parameters:

input - the input stream containing the properties

loadFromResource

public void loadFromResource(String relativeResourcePath)

Load the configuration from a path relative to the current resource folder

Parameters:

relativeResourcePath - Path to the resource in the resource folder. In a maven project, the resources are located at /src/main/resources by default.

loadFromProperties

public void loadFromProperties(Properties properties)

Load the configuration directly from properties.

setProperty

public void setProperty(String name,
                        String value)

Sets a property, if it is contained in this configuration

Parameters:

name - The name of the property

value - The new value of the property

getProperties

public List<String> getProperties(String prefix)

Returns all contained properties that begin with a specific prefix

Parameters:

prefix - The filtered prefix (e.g. "aas.")

Returns:

The list of all contained properties that begin with the prefix

getProperty

public String getProperty(String name)

Queries a property