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 and Description
Configuration	createConfiguration(ConfigurationContext context) Create a Configuration instance using the given context.
Configuration	getConfiguration() Access the current Configuration.
ConfigurationContext	getConfigurationContext() Deprecated. Will be removed in favour of Configuration.getContext().
ConfigurationContextBuilder	getConfigurationContextBuilder() Creates a new ConfigurationContextBuilder instance.
boolean	isConfigurationContextSettable() Deprecated. use isConfigurationSettable()
boolean	isConfigurationSettable() Method that allows to determine if a new Configuration can be applied programmatically.
void	setConfiguration(Configuration config) This method allows to replace the current Configuration with a new instance.
void	setConfigurationContext(ConfigurationContext context) Deprecated. use setConfiguration(Configuration)

Method Detail

getConfiguration

Configuration getConfiguration()

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.

getConfigurationContextBuilder

ConfigurationContextBuilder getConfigurationContextBuilder()

Creates a new ConfigurationContextBuilder instance.

Returns:

a new ConfigurationContextBuilder, never null.

setConfiguration

void setConfiguration(Configuration config)

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.

Throws:

UnsupportedOperationException - if the current provider is read-only.

isConfigurationSettable

boolean isConfigurationSettable()

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

Returns:

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

See Also:

setConfiguration(org.apache.tamaya.Configuration)

getConfigurationContext

@Deprecated
ConfigurationContext getConfigurationContext()

Deprecated. Will be removed in favour of Configuration.getContext().

Get access to the current ConfigurationContext.

Returns:

the current ConfigurationContext, never null.

setConfigurationContext

@Deprecated
void setConfigurationContext(ConfigurationContext context)

Deprecated. use setConfiguration(Configuration)

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

Parameters:

context - the new ConfigurationContext to be applied.

Throws:

UnsupportedOperationException - if the current provider is read-only.

isConfigurationContextSettable

@Deprecated
boolean isConfigurationContextSettable()

Deprecated. use isConfigurationSettable()

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

Returns:

true, if setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext) is supported by the current implementation.

See Also:

setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext)