@ConsumerType public interface PersistenceManager
PersistenceManagerinterface defines the API to be implemented to support persisting configuration data. This interface may be implemented by bundles, which support storing configuration data in different locations.
The Apache Felix Configuration Admin Service bundles provides an implementation of this interface using the platform file system to store configuration data.
Implementations of this interface must support loading and storing
java.util.Dictionary objects as defined in section 104.4.2,
Configuration Properties, of the Configuration Admin Service Specification
To make implementations of this interface available to the Configuration
Admin Service they must be registered as service for this interface. The
Configuration Admin Service will consider all registered services plus the
default platform file system based implementation to load configuration data.
To store new configuration data, the persistence manager service with the
highest rank value - the
service.ranking service property - is
used. If no persistence manager service has been registered, the platform
file system based implementation is used.
|Modifier and Type||Field and Description|
Service registration property to define a unique name for the persistence manager.
|Modifier and Type||Method and Description|
Returns an enumeration of all
static final java.lang.String PROPERTY_NAME
boolean exists(java.lang.String pid)
trueif a persisted
Dictionaryexists for the given
pid- The identifier for the dictionary to test.
trueif a persisted dictionary exists for the pid.
java.util.Dictionary load(java.lang.String pid) throws java.io.IOException
Dictionaryfor the given
Implementations are expected to return dictionary instances which may be
modified by the caller without affecting any underlying data or affecting
future calls to this method with the same PID. In other words the
load(pid) != load(pid) must hold
pid- The identifier for the dictionary to load.
nullbut may be empty.
java.io.IOException- If an error occurs loading the dictionary. An
IOExceptionmust also be thrown if no dictionary exists for the given identifier.
java.util.Enumeration getDictionaries() throws java.io.IOException
Dictionaryobjects known to this persistence manager.
Implementations of this method are allowed to return lazy enumerations. That is, it is allowable for the enumeration to not return a dictionary if loading it results in an error.
Implementations are expected to return dictionary instances which may be modified by the caller without affecting any underlying data or affecting future calls to this method.
java.io.IOException- If an error occurs getting the dictionaries.
void store(java.lang.String pid, java.util.Dictionary properties) throws java.io.IOException
Dictionaryunder the given
The dictionary provided to this method must be considered private to the caller. Any modification by the caller after this method finishes must not influence any internal storage of the provided data. Implementations must not modify the dictionary.
pid- The identifier of the dictionary.
java.io.IOException- If an error occurs storing the dictionary. If this exception is thrown, it is expected, that
void delete(java.lang.String pid) throws java.io.IOException
Dictionaryfor the given
pid. If such a dictionary does not exist, this method has no effect.
pid- The identifier of the dictionary to delete.
java.io.IOException- If an error occurs deleting the dictionary. This exception must not be thrown if no dictionary with the given identifier exists.
Copyright © 2010 - 2020 Adobe. All Rights Reserved