public interface ConfigurationProviderSpi
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.Modifier and Type | Method and Description |
---|---|
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()
Method that allows to determine if a new
ConfigurationContext can be applied
programmatically. |
void |
setConfigurationContext(ConfigurationContext context)
This method allows to replace the current
ConfigurationContext with a new
instance. |
Configuration getConfiguration()
Configuration
.Configuration
instance, never null.@Deprecated ConfigurationContext getConfigurationContext()
Configuration.getContext()
.ConfigurationContext
.ConfigurationContext
, never null.void setConfigurationContext(ConfigurationContext context)
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
.context
- the new ConfigurationContext to be applied.UnsupportedOperationException
- if the current provider is read-only.boolean isConfigurationContextSettable()
ConfigurationContext
can be applied
programmatically.setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext)
is supported
by the current implementation.setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext)
ConfigurationContextBuilder getConfigurationContextBuilder()
ConfigurationContextBuilder
instance.ConfigurationContextBuilder
, never null.Copyright © 2014–2016 Apache Software Foundation. All rights reserved.