de.iip_ecosphere.platform.support.iip_aas.config

Class AbstractConfiguration

java.lang.Object

de.iip_ecosphere.platform.support.iip_aas.config.AbstractConfiguration

Direct Known Subclasses:

AasConfiguration

public abstract class AbstractConfiguration
extends Object

Basic class for a YAML-based component configuration. Implementing classes must have a public no-arg constructor. Each property requires a public getter and setter in Java Bean Style.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FNAME Name of the default configuration file with extension (no path).
static String	DEFAULT_NAME Just the name of the default configuration file, no extension, no path.

Constructor Summary

Constructors

Constructor and Description
AbstractConfiguration()

Method Summary

Modifier and Type	Method and Description
static <C> C	readFromYaml(Class<C> cls) Reads a configurationfrom DEFAULT_FNAME in the root folder of the JAR/classpath.
static <C> C	readFromYaml(Class<C> cls, InputStream in) Reads a instance from in.
static <C> C	readFromYaml(Class<C> cls, String filename) Reads a configuration from the root folder of the JAR/classpath.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

Just the name of the default configuration file, no extension, no path.

See Also:

Constant Field Values

DEFAULT_FNAME

public static final String DEFAULT_FNAME

Name of the default configuration file with extension (no path).

See Also:

Constant Field Values

Constructor Detail

AbstractConfiguration

public AbstractConfiguration()

Method Detail

readFromYaml

public static <C> C readFromYaml(Class<C> cls)
                          throws IOException

Reads a configurationfrom DEFAULT_FNAME in the root folder of the JAR/classpath. Unknown properties are ignored.

Type Parameters:

C - the specific type of configuration to read

Parameters:

cls - the class of configuration to read

Returns:

the configuration instance

Throws:

IOException - if the file cannot be read/found, the configuration class cannot be instantiated

readFromYaml

public static <C> C readFromYaml(Class<C> cls,
                                 String filename)
                          throws IOException

Reads a configuration from the root folder of the JAR/classpath. Unknown properties are ignored.

Type Parameters:

C - the specific type of configuration to read

Parameters:

cls - the class of configuration to read

filename - the filename (a leading "/" is added if missing for JAR/classpath resource access)

Returns:

the configuration instance

Throws:

IOException - if the file cannot be read/found, the configuration class cannot be instantiated

readFromYaml

public static <C> C readFromYaml(Class<C> cls,
                                 InputStream in)
                          throws IOException

Reads a instance from in. Unknown properties are ignored.

Type Parameters:

C - the specific type of configuration to read

Parameters:

cls - the class of configuration to read

in - the stream to read from (ignored if null)

Returns:

the configuration instance

Throws:

IOException - if the data cannot be read, the configuration class cannot be instantiated