The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15



Tips ‘n’ Tricks


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

service ConfigurationProvider
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 ::com::sun::star::lang::ServiceManager. The arguments passed to ::com::sun::star::lang::XMultiComponentFactory::createInstanceWithContextAndArguments() select the configuration data source. Arguments must be provided as ::com::sun::star::beans::NamedValue or ::com::sun::star::beans::PropertyValue. If the parameters given are incomplete missing values are taken from the context or the environment. If an instance already exists for the given set of arguments, the existing instance may be reused. In particular, instantiating a provider without explicit arguments to access the default configuration data will always yield the same DefaultProvider object.

Some arguments for ::com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments() may be given default values during creation of this service. In particular this applies to the parameters "Locale" and "EnableAsync".

Developers Guide
WritingUNO - Disable Commands - Disabling Commands at Runtime
Config - Connecting to a Data Source
Config - Object Model

Exported Interfaces - Summary

allows creating access objects for specific views such as subsets and fragments of the configuration. (details)


allows controlling or observing the lifetime of the configuration. (details)

Exported Interfaces - Details
allows creating access objects for specific views such as subsets and fragments of the configuration.

The parameter aServiceSpecifier passed to ::com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments() supports at least the service specifiers "" and "".

Using the first of these service specifiers 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 ::com::sun::star::lang::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 ::com::sun::star::beans::PropertyValue or a ::com::sun::star::beans::NamedValue, 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:

  • Selecting data into a view:
    "nodepath" : string
    specifies the location of the view root in the configuration.
    "depth" : short
    specifies that elements of the hierarchy that are more than the given number of nesting levels away from the root need not be included in the view.
    "locale" : ::com::sun::star::lang::Locale
    specifies the locale for which localized values should be retrieved.

    Example: In the hierarchy

     A - B1 - C1
     - B2 - C2 (localized: de, en, fr, ..)
     | |
     | - C3 - D1 
     | | |
     | | - D2 - E1
     | | 
     | - C4 - D3 - E2 - F1
     | | |
     | | - F2
     | |
     | - C5
     - B3
     - B4 - C6 - D4 - E3 

    selecting a view with nodepath = "/A/B2", depth = 2 and locale = <Locale for en_US> would result in the tree fragment
    (A-) B2 - C2 (en)
     - C3 - D1
     | |
     | - D2 (..)
     - C4 - D3 (..) 
     - C5

  • Controlling cache behavior: (with providers that cache configuration data)
    "enableasync" : boolean
    controls how updates are handled in the cache. If true, the cache may operate in write-back mode, where updates at first only affect the cache and are written to persistent storage at some later time. If false, the cache must operate in write-through mode, where updates are written to persistent storage at once - that is before ::com::sun::star::util::XChangesBatch::commitChanges() returns.

    This parameter was formerly called "lazywrite". The old name should still be supported for compatibility.

    "nocache" : boolean
    This deprecated parameter specifies that data for the view is not taken from the cache, but read directly from storage. This may entail that future changes that become visible in the cache are not reflected in this view and that changes done through this view are not reflected in the cache.
    Use with caution !

    This parameter is not supported by all implementations and may be silently ignored !

::com::sun::star::lang::XMultiServiceFactory::createInstance() may be unusable. Only an implementation that supports service names that can be used with no further arguments support this method. It should return the same result as if ::com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments() had been called using an empty sequence of arguments.

allows controlling or observing the lifetime of the configuration.

The owner of the provider may dispose of this object using ::com::sun::star::lang::XComponent::dispose(). Note that the default provider is owned by the ::com::sun::star::lang::ServiceManager and should not be disposed of by user code.

Views created by the provider generally refer to data that is managed by the provider. Therefore, disposing of the provider will cause all objects belonging to these views to be disposed of as well. This does not apply to snapshot views that have their own copy of the data, if available.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.