de.aristaflow.adept2.base.configuration

Class PropertyProvider

java.lang.Object

de.aristaflow.adept2.base.configuration.PropertyProvider

Direct Known Subclasses:

ConfigurationPropertyProvider

public abstract class PropertyProvider
extends java.lang.Object

This class provides global properties that are needed for the whole AristaFlow-platform. These properties are needed for initialising the configuration framework which is why they are parsed very early when bootstrapping.
This interface encapsulates the concrete representation of the global properties. For instance, these may stem from the system properties or from a servlet context, depending on the execution context of the AristaFlow-platform.

This class may be extended to reflect specific requirements (that is specific global properties) needed by a configuration manager.

This class parses the following properties from the designated map (in parentheses the default value that will apply if the property is not set):

• arflow.logdir (default: ./logs)
• arflow.datadir (default: ./examples)
• arflow.libdir (default: ./lib)
• arflow.useSunSecProvider (default: false)

Author:

Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	logger The logger for property providers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyProvider(java.util.Map<java.lang.String,java.lang.String> properties) Creates a new PropertyProvider and parses all corresponding global properties from the designated map and/or sets the properties appropriately.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getSubstitutedVariables() Gets an unmodifiable map containing all substitutions (interpolation) that need to be applied to all configurations.
boolean	getUseSunSecurityProviders() Gets whether the Sun providers should be used for the security API.
protected void	initialiseProperties(java.util.Map<java.lang.String,java.lang.String> properties) Initialises, checks and sets the values of the global properties as well as the substituted variables.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final java.util.logging.Logger logger

The logger for property providers. It is protected for extensibility.

Constructor Detail

PropertyProvider

protected PropertyProvider(java.util.Map<java.lang.String,java.lang.String> properties)
                    throws ConfigurationException

Creates a new PropertyProvider and parses all corresponding global properties from the designated map and/or sets the properties appropriately.

Parameters:

properties - A map providing all required global properties and values for substituted variables.

Throws:

ConfigurationException - If there are problems retrieving a required global property or a substituted variables from the designated map, a ConfigurationException will be thrown.

Method Detail

getSubstitutedVariables

public java.util.Map<java.lang.String,java.lang.String> getSubstitutedVariables()

Gets an unmodifiable map containing all substitutions (interpolation) that need to be applied to all configurations. If a key of this map is found in a configuration, it will be replaced with the corresponding value from the map. The key needs to have the appropriate prefix in the configuration, for instance, ${arflow:key} will be replaced by value.

Returns:

An unmodifiable map containing the keys which will be replaced by the corresponding values from the map if they are found in a configuration.

getUseSunSecurityProviders

public boolean getUseSunSecurityProviders()

Gets whether the Sun providers should be used for the security API. This prevents using other registered security providers like from Apache or Bouncy Castle.

Returns:

Whether the Sun providers should be used for the security API. This prevents using other registered security providers like from Apache or Bouncy Castle.

initialiseProperties

protected void initialiseProperties(java.util.Map<java.lang.String,java.lang.String> properties)
                             throws ConfigurationException

Initialises, checks and sets the values of the global properties as well as the substituted variables. The following properties are parsed from the designated map (with a default value where appropriate):

• arflow.logdir (default: ./logs)
• arflow.datadir (default: ./examples)
• arflow.libdir (default: ./lib)
• arflow.useSunSecProvider (default: false)

The substituted variables will contain:

• arflow.logdir (default: ./logs)
• arflow.datadir (default: ./examples)
• arflow.libdir (default: ./lib)

Parameters:

properties - The properties which to parse.

Throws:

ConfigurationException - If the user dir for the log dir is not a valid directory or the default data directory could not be created, a ConfigurationException will be thrown.