Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

com :: sun :: star :: configuration ::

service ConfigurationProvider

Description
manages one, or more, complete sets of configuration data and serves as a factory for objects that provide access to a subset of the configuration.

An implementation is usually obtained from a ServiceManager . The default com.sun.star.configuration.ConfigurationProvider object, that is instantiated without using extra arguments, is a one instance service.

Using the first of these requests a read-only view of the configuration. The object that is created implements service ConfigurationAccess . To reflect its element role as root of the view, it implements service AccessRootElement .

Using the second form requests an updatable view of the configuration. The object that is created should implement service ConfigurationUpdateAccess . To reflect its element role which includes controlling updates for the whole view, it implements service UpdateRootElement .
If the root element of the view is marked read-only (as indicated by PropertyAttributes::READONLY ), the implementation may either raise an exception or return a (read-only) ConfigurationAccess / AccessRootElement instead.

The arguments passed to XMultiServiceFactory::createInstanceWithArguments() in parameter aArguments specify the view of the configuration that should be created. That is, they determine the subset of elements that can be accessed starting from the returned object. Each element of the argument sequence should be a PropertyValue , so that the parameters can be identified by name rather than by position.

What combinations of arguments are supported depends on the service name.

With both of the standard service-specifiers above, an implementation must accept a single argument named nodepath of type string . This argument must contain the absolute path to an element of the configuration. The view that is selected consists of the named element and all its decendants.

Other arguments can be used to control the behavior of the view. These are different for different implementations. Whether and how they are used may also depend on the configuration store and configuration that were selected when the provider was created.

An implementation must ignore unknown arguments.

Some parameters that are commonly supported are: