Package org.apache.tamaya.spi

Interface ConfigurationProviderSpi

public interface ConfigurationProviderSpi

SPI that must be implemented to provide the component that manages all Configuration instances in a system. In SE this may be a true singleton containing exact one Configuration instance, whereas in Java EE and other more complex environments instances may be returned depending the current runtime context.

Method Summary

Modifier and Type	Method	Description
Configuration	createConfiguration(ConfigurationContext context)	Create a Configuration instance using the given context.
default Configuration	getConfiguration()	Deprecated. Use getConfiguration(ClassLoader) instead of.
Configuration	getConfiguration(ClassLoader classLoader)	Access the current Configuration.
ConfigurationBuilder	getConfigurationBuilder()	Creates a new ConfigurationBuilder instance.
default boolean	isConfigurationSettable(ClassLoader classloader)	Method that allows to determine if a new Configuration can be applied programmatically.
Configuration	releaseConfiguration(ClassLoader classloader)	This method allows to release a Configuration for a classloader.
void	setConfiguration(Configuration config, ClassLoader classloader)	This method allows to replace the current Configuration with a new instance.

Method Detail

getConfiguration

Configuration getConfiguration(ClassLoader classLoader)

Access the current Configuration.

Parameters:

classLoader - the classloader to be used.

Returns:

the current Configuration instance, never null.

getConfiguration

@Deprecated
default Configuration getConfiguration()

Deprecated. Use getConfiguration(ClassLoader) instead of.

Access the current Configuration.

Returns:

the current Configuration instance, never null.

createConfiguration

Configuration createConfiguration(ConfigurationContext context)

Create a Configuration instance using the given context. The configuration created hereby must respect the artifacts provided by its context (property sources, filters, converters, policies etc), including their ordering and significance.

Parameters:

context - the context to be used, not null.

Returns:

the corresponding configuration instance.

getConfigurationBuilder

ConfigurationBuilder getConfigurationBuilder()

Creates a new ConfigurationBuilder instance.

Returns:

a new ConfigurationBuilder, never null.

setConfiguration

void setConfiguration(Configuration config,
                      ClassLoader classloader)

This method allows to replace the current Configuration with a new instance. This can be used to update the configuration with a new one, e.g. because some of the data has changed and must be updated. It is the responsibility of the ConfigurationProvider to trigger corresponding update events for the current Configuration.

Parameters:

config - the new Configuration to be applied.

classloader - the classloader to be used.

Throws:

UnsupportedOperationException - if the current provider is read-only.

releaseConfiguration

Configuration releaseConfiguration(ClassLoader classloader)

This method allows to release a Configuration for a classloader. This can be used to refresh the configuration with a new one, e.g. because some of the data has changed and must be updated.

Parameters:

classloader - the classloader to be used.

Returns:

the configuration instance released, or null.

Throws:

UnsupportedOperationException - if the current provider is read-only.

isConfigurationSettable

default boolean isConfigurationSettable(ClassLoader classloader)

Method that allows to determine if a new Configuration can be applied programmatically.

Parameters:

classloader - the target classloader

Returns:

true, if setConfiguration(org.apache.tamaya.Configuration, ClassLoader) is supported by the current implementation.

See Also:

setConfiguration(org.apache.tamaya.Configuration, ClassLoader classloader)