org.apache.tamaya.core.propertysource

Class SystemPropertySource

java.lang.Object

org.apache.tamaya.core.propertysource.SystemPropertySource

All Implemented Interfaces:

PropertySource

public class SystemPropertySource
extends Object
implements PropertySource

This PropertySource manages the system properties. You can disable this feature by setting tamaya.envprops.disable or tamaya.defaults.disable.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ORDINAL default ordinal for SystemPropertySource

Fields inherited from interface org.apache.tamaya.spi.PropertySource

EMPTY, TAMAYA_ORDINAL

Constructor Summary

Constructors

Constructor and Description
SystemPropertySource()

Method Summary

Modifier and Type	Method and Description
PropertyValue	get(String key) Access a property.
String	getName() Get the name of the property source.
int	getOrdinal() Lookup order: TODO rethink whole default PropertySources and ordering: TODO introduce default values or constants for ordinals System properties (ordinal 400) Environment properties (ordinal 300) JNDI values (ordinal 200) Properties file values (/META-INF/applicationConfiguration.properties) (ordinal 100) Important Hints for custom implementations: If a custom implementation should be invoked before the default implementations, use a value > 400 If a custom implementation should be invoked after the default implementations, use a value < 100 Reordering of the default order of the config-sources: Example: If the properties file/s should be used before the other implementations, you have to configure an ordinal > 400.
Map<String,String>	getProperties() Access the current properties as Map.
boolean	isScannable() Determines if this config source can be scanned for its list of properties.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ORDINAL

public static final int DEFAULT_ORDINAL

default ordinal for SystemPropertySource

See Also:

Constant Field Values

Constructor Detail

SystemPropertySource

public SystemPropertySource()

Method Detail

getOrdinal

public int getOrdinal()

Description copied from interface: PropertySource

Lookup order: TODO rethink whole default PropertySources and ordering: TODO introduce default values or constants for ordinals

1. System properties (ordinal 400)
2. Environment properties (ordinal 300)
3. JNDI values (ordinal 200)
4. Properties file values (/META-INF/applicationConfiguration.properties) (ordinal 100)

Important Hints for custom implementations:

If a custom implementation should be invoked before the default implementations, use a value > 400

If a custom implementation should be invoked after the default implementations, use a value < 100

Reordering of the default order of the config-sources:

Example: If the properties file/s should be used before the other implementations, you have to configure an ordinal > 400. That means, you have to add e.g. deltaspike_ordinal=401 to /META-INF/apache-deltaspike.properties . Hint: In case of property files every file is handled as independent config-source, but all of them have ordinal 400 by default (and can be reordered in a fine-grained manner.

Specified by:

getOrdinal in interface PropertySource

Returns:

the 'importance' aka ordinal of the configured values. The higher, the more important. //X TODO think about making this a default method which returns default priority

getName

public String getName()

Description copied from interface: PropertySource

Get the name of the property source. The name should be unique for the type of source, whereas the id is used to ensure unique identity, either locally or remotely.

Specified by:

getName in interface PropertySource

Returns:

the configuration's name, never null.

get

public PropertyValue get(String key)

Description copied from interface: PropertySource

Access a property.

Specified by:

get in interface PropertySource

Parameters:

key - the property's key, not null.

Returns:

the property value map, where map.get(key) == value, including also any metadata. In case a value is null, simply return null.

getProperties

public Map<String,String> getProperties()

Description copied from interface: PropertySource

Access the current properties as Map. The resulting Map may not return all items accessible, e.g. when the underlying storage does not support iteration of its entries.

Specified by:

getProperties in interface PropertySource

Returns:

the a corresponding map, never null.

isScannable

public boolean isScannable()

Description copied from interface: PropertySource

Determines if this config source can be scanned for its list of properties.

PropertySources which are not scannable might not be able to find all the configured values to provide via PropertySource.getProperties(). This can e.g. happen if the underlying storage doesn't support listing.

Specified by:

isScannable in interface PropertySource

Returns:

true if this PropertySource can be scanned for its list of properties, false if it should not be scanned.