<html> <head> <title>Module backend</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimainself">Module</td> <td class="navimainnone">Use</td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#NestedModules" class="navisub">Nested Modules</a></td> <td class="navisub"><a href="#Services" class="navisub">Services</a></td> <td class="navisub">Singletons</td> <td class="navisub"><a href="#Interfaces" class="navisub">Interfaces</a></td> <td class="navisub"><a href="#Structs" class="navisub">Structs</a></td> <td class="navisub"><a href="#Exceptions" class="navisub">Exceptions</a></td> <td class="navisub">Enums</td> <td class="navisub">Typedefs</td> <td class="navisub"><a href="#ConstantGroups" class="navisub">Constant Groups</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">configuration</a> :: </p> </td> </tr> <tr> <td class="title">module backend</td> </tr> <tr> <td/></tr> </table> <hr> <a name="NestedModules"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Nested Modules</td> </tr> <tr> <td class="imsum_left"><a href="xml/module-ix.html">xml</a></td> <td class="imsum_right"/></tr> </table> <a name="Services"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Services</td> </tr> <tr> <td class="imsum_left"><a href="Backend.html">Backend</a></td> <td class="imsum_right">provides access to a configuration database composed of one or more storage backends containing settings used by software modules. </td> </tr> <tr> <td class="imsum_left"><a href="BackendAdapter.html">BackendAdapter</a></td> <td class="imsum_right">implements <a href="Backend.html">Backend</a> retrieving data from a <a href="SingleBackend.html">SingleBackend</a>. </td> </tr> <tr> <td class="imsum_left"><a href="CopyImporter.html">CopyImporter</a></td> <td class="imsum_right">imports data into a configuration layer by copying over existing data. </td> </tr> <tr> <td class="imsum_left"><a href="DataImporter.html">DataImporter</a></td> <td class="imsum_right">allows importing data from one configuration repository into another. . </td> </tr> <tr> <td class="imsum_left"><a href="DefaultBackend.html">DefaultBackend</a></td> <td class="imsum_right">is a <a href="DefaultBackend.html">DefaultBackend</a>, that is the default <a href="DefaultBackend.html">DefaultBackend</a> for its ::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/XComponentContext.html">XComponentContext</a>. </td> </tr> <tr> <td class="imsum_left"><a href="HierarchyBrowser.html">HierarchyBrowser</a></td> <td class="imsum_right">allows scanning a configuration data repository for available components . </td> </tr> <tr> <td class="imsum_left"><a href="Importer.html">Importer</a></td> <td class="imsum_right">imports data into a configuration layer. </td> </tr> <tr> <td class="imsum_left"><a href="InteractionHandler.html">InteractionHandler</a></td> <td class="imsum_right">An interaction request handler that lets the user handle a number of well known requests via GUI dialogs. </td> </tr> <tr> <td class="imsum_left"><a href="Layer.html">Layer</a></td> <td class="imsum_right">provides read-only access to a configuration data layer. </td> </tr> <tr> <td class="imsum_left"><a href="LayerDescriber.html">LayerDescriber</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="LayerFilter.html">LayerFilter</a></td> <td class="imsum_right">provides a filtered version of a configuration data <a href="Layer.html">Layer</a>. </td> </tr> <tr> <td class="imsum_left"><a href="LayerUpdateMerger.html">LayerUpdateMerger</a></td> <td class="imsum_right">applies updates to a configuration layer. </td> </tr> <tr> <td class="imsum_left"><a href="LdapMultiLayerStratum.html">LdapMultiLayerStratum</a></td> <td class="imsum_right">implements <a href="MultiLayerStratum.html">MultiLayerStratum</a> that provides access to a multiple layers of configuration data from ldap source </td> </tr> <tr> <td class="imsum_left"><a href="LdapSingleBackend.html">LdapSingleBackend</a></td> <td class="imsum_right">implements <a href="SingleBackend.html">SingleBackend</a> that stores data in an LDAP directoy. </td> </tr> <tr> <td class="imsum_left"><a href="LdapSingleStratum.html">LdapSingleStratum</a></td> <td class="imsum_right">implements <a href="SingleLayerStratum.html">SingleLayerStratum</a> that provides access to a single layer of configuration data from ldap source </td> </tr> <tr> <td class="imsum_left"><a href="LocalDataImporter.html">LocalDataImporter</a></td> <td class="imsum_right">allows importing data from a local configuration data repository or file into any <a href="Backend.html">Backend</a>. </td> </tr> <tr> <td class="imsum_left"><a href="LocalHierarchyBrowser.html">LocalHierarchyBrowser</a></td> <td class="imsum_right">is a <a href="HierarchyBrowser.html">HierarchyBrowser</a>, that browses a configuration database stored in the local file system. </td> </tr> <tr> <td class="imsum_left"><a href="LocalSchemaSupplier.html">LocalSchemaSupplier</a></td> <td class="imsum_right">implements <a href="SchemaSupplier.html">SchemaSupplier</a> providing access to local configuration schemas </td> </tr> <tr> <td class="imsum_left"><a href="LocalSingleBackend.html">LocalSingleBackend</a></td> <td class="imsum_right">implements <a href="SingleBackend.html">SingleBackend</a> that stores data in the local filesystem using the OOR XML formats. </td> </tr> <tr> <td class="imsum_left"><a href="LocalSingleStratum.html">LocalSingleStratum</a></td> <td class="imsum_right">implements <a href="SingleLayerStratum.html">SingleLayerStratum</a> that provides access to a singe layer of configuration data from local file system </td> </tr> <tr> <td class="imsum_left"><a href="MergeImporter.html">MergeImporter</a></td> <td class="imsum_right">imports data into a configuration layer by merging with existing data. </td> </tr> <tr> <td class="imsum_left"><a href="MultiLayerStratum.html">MultiLayerStratum</a></td> <td class="imsum_right">Provides access to a singe layer of configuration data </td> </tr> <tr> <td class="imsum_left"><a href="MultiStratumBackend.html">MultiStratumBackend</a></td> <td class="imsum_right">implements <a href="Backend.html">Backend</a> provides access to a configuration database composed of one or more storage backends containing settings used by software modules. </td> </tr> <tr> <td class="imsum_left"><a href="OfflineBackend.html">OfflineBackend</a></td> <td class="imsum_right">implements <a href="BackendAdapter.html">BackendAdapter</a> that maintains a cache so it can operate even if the <a href="SingleBackend.html">SingleBackend</a> holding the data is inaccessible. </td> </tr> <tr> <td class="imsum_left"><a href="OnlineBackend.html">OnlineBackend</a></td> <td class="imsum_right">implements a <a href="BackendAdapter.html">BackendAdapter</a> that requires that the <a href="SingleBackend.html">SingleBackend</a> holding the data is continuously accessible. </td> </tr> <tr> <td class="imsum_left"><a href="PlatformBackend.html">PlatformBackend</a></td> <td class="imsum_right">implements <a href="SingleLayerStratum.html">SingleLayerStratum</a> that provides access to a singe layer of configuration data from external data store </td> </tr> <tr> <td class="imsum_left"><a href="PolicyLayerBackend.html">PolicyLayerBackend</a></td> <td class="imsum_right">provides access to multi layers of configuration data </td> </tr> <tr> <td class="imsum_left"><a href="Schema.html">Schema</a></td> <td class="imsum_right">provides read only access to a configuration component schema. </td> </tr> <tr> <td class="imsum_left"><a href="SchemaSupplier.html">SchemaSupplier</a></td> <td class="imsum_right">provides access to configuration schemas </td> </tr> <tr> <td class="imsum_left"><a href="SingleBackend.html">SingleBackend</a></td> <td class="imsum_right">is a configuration storage backends containing a complete configuration database, including user data, default or policy layers and schemata. </td> </tr> <tr> <td class="imsum_left"><a href="SingleBackendAdapter.html">SingleBackendAdapter</a></td> <td class="imsum_right">implements a simple <a href="BackendAdapter.html">BackendAdapter</a> that can be used for normal configuration operation. </td> </tr> <tr> <td class="imsum_left"><a href="SingleLayerStratum.html">SingleLayerStratum</a></td> <td class="imsum_right">Provides access to a single layer of configuration data </td> </tr> <tr> <td class="imsum_left"><a href="SystemIntegration.html">SystemIntegration</a></td> <td class="imsum_right">provides access to a configuration data composed of one or more platform backends containing settings used by software modules. </td> </tr> <tr> <td class="imsum_left"><a href="UpdatableLayer.html">UpdatableLayer</a></td> <td class="imsum_right">provides read/write access to a configuration data layer. </td> </tr> </table> <a name="Interfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Interfaces</td> </tr> <tr> <td class="imsum_left"><a href="XBackend.html">XBackend</a></td> <td class="imsum_right">Handles access to layered data stored in a repository. </td> </tr> <tr> <td class="imsum_left"><a href="XBackendChangesListener.html">XBackendChangesListener</a></td> <td class="imsum_right">receives notification from backend broadcaster objects. </td> </tr> <tr> <td class="imsum_left"><a href="XBackendChangesNotifier.html">XBackendChangesNotifier</a></td> <td class="imsum_right">broadcasts changes when data from backend sources has changed. </td> </tr> <tr> <td class="imsum_left"><a href="XBackendEntities.html">XBackendEntities</a></td> <td class="imsum_right">Provides functionality relating to common and supported entities for a configuration data backend. </td> </tr> <tr> <td class="imsum_left"><a href="XCompositeLayer.html">XCompositeLayer</a></td> <td class="imsum_right">provides read access to layers that contain sublayers accessible through an additional criterion (for instance the locale they contain data for). </td> </tr> <tr> <td class="imsum_left"><a href="XLayer.html">XLayer</a></td> <td class="imsum_right">provides read access to the data contained in a layer. </td> </tr> <tr> <td class="imsum_left"><a href="XLayerContentDescriber.html">XLayerContentDescriber</a></td> <td class="imsum_right">describe the contents of a layer to an XLayerHander object. The contents of the layer is contained in the sequence of PropertyInfo structures </td> </tr> <tr> <td class="imsum_left"><a href="XLayerHandler.html">XLayerHandler</a></td> <td class="imsum_right">receives a description of a configuration layer as a sequence of events. </td> </tr> <tr> <td class="imsum_left"><a href="XLayerImporter.html">XLayerImporter</a></td> <td class="imsum_right">allows importing a layer into a <a href="Backend.html">Backend</a> </td> </tr> <tr> <td class="imsum_left"><a href="XMultiLayerStratum.html">XMultiLayerStratum</a></td> <td class="imsum_right">Handles access to a stratum consisting of multiple layers in a single configuration data repository </td> </tr> <tr> <td class="imsum_left"><a href="XSchema.html">XSchema</a></td> <td class="imsum_right">Handles access to the elements of a component schema, i.e its templates and its component definition. </td> </tr> <tr> <td class="imsum_left"><a href="XSchemaHandler.html">XSchemaHandler</a></td> <td class="imsum_right">receives a description of a configuration schema as a sequence of events. </td> </tr> <tr> <td class="imsum_left"><a href="XSchemaSupplier.html">XSchemaSupplier</a></td> <td class="imsum_right">provides access to configuration component schemas. </td> </tr> <tr> <td class="imsum_left"><a href="XSingleLayerStratum.html">XSingleLayerStratum</a></td> <td class="imsum_right">Handles access to a stratum consisting of a single layer in a configuration data repository </td> </tr> <tr> <td class="imsum_left"><a href="XUpdatableLayer.html">XUpdatableLayer</a></td> <td class="imsum_right">Provides access to a read-write layer of configuration data for a given component and entity. </td> </tr> <tr> <td class="imsum_left"><a href="XUpdateHandler.html">XUpdateHandler</a></td> <td class="imsum_right">receives a description of a configuration update or layer as a sequence of events. </td> </tr> <tr> <td class="imsum_left"><a href="XVersionedSchemaSupplier.html">XVersionedSchemaSupplier</a></td> <td class="imsum_right">provides access to versioned configuration component schemas. </td> </tr> </table> <a name="Structs"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Structs</td> </tr> <tr> <td class="imsum_left"><a href="ComponentChangeEvent.html">ComponentChangeEvent</a></td> <td class="imsum_right">This event is fired when a change becomes effective on the source of the event </td> </tr> <tr> <td class="imsum_left"><a href="PropertyInfo.html">PropertyInfo</a></td> <td class="imsum_right">This structure contains all the information related to a property </td> </tr> <tr> <td class="imsum_left"><a href="TemplateIdentifier.html">TemplateIdentifier</a></td> <td class="imsum_right">holds the data needed to identify a template. </td> </tr> </table> <a name="Exceptions"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exceptions</td> </tr> <tr> <td class="imsum_left"><a href="AuthenticationFailedException.html">AuthenticationFailedException</a></td> <td class="imsum_right">Exception thrown when authentication to the underlying backend fails due to an unknown user-id or invalid credentials. </td> </tr> <tr> <td class="imsum_left"><a href="BackendAccessException.html">BackendAccessException</a></td> <td class="imsum_right">Generic exception thrown when physical access to an underlying backend fails. </td> </tr> <tr> <td class="imsum_left"><a href="BackendSetupException.html">BackendSetupException</a></td> <td class="imsum_right">Generic exception thrown when setting up a connection to an underlying backend fails. </td> </tr> <tr> <td class="imsum_left"><a href="CannotConnectException.html">CannotConnectException</a></td> <td class="imsum_right">Exception thrown when a connection to the underlying backend cannot be established. </td> </tr> <tr> <td class="imsum_left"><a href="ConnectionLostException.html">ConnectionLostException</a></td> <td class="imsum_right">Exception thrown when the connection to the underlying backend was lost irrecoverably. </td> </tr> <tr> <td class="imsum_left"><a href="InsufficientAccessRightsException.html">InsufficientAccessRightsException</a></td> <td class="imsum_right">Exception thrown when access to the underlying backend fails because of insufficient access rights to some needed resource. </td> </tr> <tr> <td class="imsum_left"><a href="InvalidAuthenticationMechanismException.html">InvalidAuthenticationMechanismException</a></td> <td class="imsum_right">Exception thrown when authentication to the underlying backend fails because the configured authentication mechanism is not supported by the backend or no valid mechanism can be negotiated. </td> </tr> <tr> <td class="imsum_left"><a href="MalformedDataException.html">MalformedDataException</a></td> <td class="imsum_right">is raised when the data of a component schema, layer or update is not well-formed, violates the schema or is otherwise invalid. </td> </tr> <tr> <td class="imsum_left"><a href="MergeRecoveryRequest.html">MergeRecoveryRequest</a></td> <td class="imsum_right">is passed to an merging fails due to invalid layer data or access problems. </td> </tr> <tr> <td class="imsum_left"><a href="StratumCreationException.html">StratumCreationException</a></td> <td class="imsum_right">is passed to an creating a stratum backend fails. </td> </tr> </table> <a name="ConstantGroups"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Constant Groups</td> </tr> <tr> <td class="imsum_left"><a href="NodeAttribute.html">NodeAttribute</a></td> <td class="imsum_right">These values are used to specify the behavior of a node or property in a layer. </td> </tr> <tr> <td class="imsum_left"><a href="SchemaAttribute.html">SchemaAttribute</a></td> <td class="imsum_right">These values are used to specify the behavior of a node or property in the schema. </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>