org.codice.felix.cm.file

Class ConfigurationContextImpl

java.lang.Object

org.codice.felix.cm.file.ConfigurationContextImpl

All Implemented Interfaces:

ConfigurationContext

public class ConfigurationContextImpl
extends Object
implements ConfigurationContext

Helper class for enabling functional constructs with Configurations and exposes the felix.fileinstall.filename property, if it exists, as a File.

Reasons a getConfigFile() call would return null:

• There was no dictionary of properties associated with the config
• There was no felix.fileinstall.filename property
• The felix.fileinstall.filename property was invalid

See FELIX-4005 & FELIX-4556. This class cannot utilize Java 8 language constructs due to maven bundle plugin 2.3.7

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
File	getConfigFile()
String	getFactoryPid()
Dictionary<String,Object>	getSanitizedProperties()
String	getServicePid()
int	hashCode()
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.
boolean	shouldBeVisibleToPlugins()

Methods inherited from class java.lang.Object

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

Method Detail

getServicePid

public String getServicePid()

Specified by:

getServicePid in interface ConfigurationContext

Returns:

the unique identifier for the configuration.

getFactoryPid

public String getFactoryPid()

Specified by:

getFactoryPid in interface ConfigurationContext

Returns:

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

getConfigFile

public File getConfigFile()

Specified by:

getConfigFile in interface ConfigurationContext

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

public Dictionary<String,Object> getSanitizedProperties()

Specified by:

getSanitizedProperties in interface ConfigurationContext

Returns:

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

setProperty

public void setProperty(String key,
                        Object value)

Description copied from interface: ConfigurationContext

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.

Specified by:

setProperty in interface ConfigurationContext

Parameters:

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

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

shouldBeVisibleToPlugins

public boolean shouldBeVisibleToPlugins()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object