org.codice.felix.cm.internal

Interface ConfigurationContext

All Known Implementing Classes:

ConfigurationContextImpl

public interface ConfigurationContext

The purpose of the ConfigurationContext is to provide an abstraction for the oddities of Apache Felix, and isolate only a single place where an implementation may need to change when upgrading versions of Karaf.

Method Summary

Modifier and Type	Method and Description
File	getConfigFile()
String	getFactoryPid()
Dictionary<String,Object>	getSanitizedProperties()
String	getServicePid()
void	setProperty(String key, Object value) Provides a mechanism to add or change property values on the internal felix map to be persisted without going back through the config admin service.

Method Detail

getServicePid

String getServicePid()

Returns:

the unique identifier for the configuration.

getFactoryPid

@Nullable
String getFactoryPid()

Returns:

the unique identifier for the configuration factory, or null if the config belongs to a singleton service.

getConfigFile

@Nullable
File getConfigFile()

Returns:

a File in the etc directory that defines this config if and only if the config was created by the Felix directory watcher. Returns null otherwise.

getSanitizedProperties

Dictionary<String,Object> getSanitizedProperties()

Returns:

a dictionary of properties only relevant to the configuration itself, completely free of Felix internal control values.

setProperty

void setProperty(String key,
                 Object value)

Provides a mechanism to add or change property values on the internal felix map to be persisted without going back through the config admin service.

Parameters:

key - the key of the property to add or change.

value - the intended new value for the specified property to hold.