LibreOffice: UniversalContentBroker Service Reference

LibreOffice LibreOffice 7.4 SDK API Reference

Loading...
Searching...
No Matches
Public Member Functions | List of all members
UniversalContentBroker Service Referencepublished

is a one-instance service that provides access to a set of Contents via ContentProviders. More...

Inheritance diagram for UniversalContentBroker:

## Public Member Functions
| create ()
| The (default) constructor.
Public Member Functions inherited from XComponent
void | dispose ()
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references.
void | addEventListener ([in] XEventListener xListener)
| adds an event listener to the object.
void | removeEventListener ([in] XEventListener aListener)
| removes an event listener from the listener list.
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object.
void | acquire ()
| increases the reference counter by one.
void | release ()
| decreases the reference counter by one.
Public Member Functions inherited from XContentProvider
com::sun::star::ucb::XContent | queryContent ([in] com::sun::star::ucb::XContentIdentifier Identifier) raises ( com::sun::star::ucb::IllegalIdentifierException )
| creates a new XContent instance, if the given XContentIdentifier matches a content provided by the implementation of this interface.
long | compareContentIds ([in] com::sun::star::ucb::XContentIdentifier Id1, [in] com::sun::star::ucb::XContentIdentifier Id2)
| compares two XContentIdentifiers.
Public Member Functions inherited from XContentProviderManager
com::sun::star::ucb::XContentProvider | registerContentProvider ([in] com::sun::star::ucb::XContentProvider Provider, [in] string Scheme, [in] boolean ReplaceExisting) raises ( com::sun::star::ucb::DuplicateProviderException )
| registers a content provider for a specific URL template.
void | deregisterContentProvider ([in] com::sun::star::ucb::XContentProvider Provider, [in] string Scheme)
| deregisters a content provider.
sequence< com::sun::star::ucb::ContentProviderInfo > | queryContentProviders ()
| returns a list of information on all registered content providers.
com::sun::star::ucb::XContentProvider | queryContentProvider ([in] string Identifier)
| returns the currently active content provider for a content identifier.
Public Member Functions inherited from XContentIdentifierFactory
com::sun::star::ucb::XContentIdentifier | createContentIdentifier ([in] string ContentId)
| creates an identifier.
Public Member Functions inherited from XCommandProcessor2
void | releaseCommandIdentifier ([in] long CommandId)
| releases a command identifier obtained through XCommandProcessor::createCommandIdentifier() when it is no longer used.
Public Member Functions inherited from XCommandProcessor
long | createCommandIdentifier ()
| creates a unique identifier for a command.
any | execute ([in] Command aCommand, [in] long CommandId, [in] XCommandEnvironment Environment) raises ( com::sun::star::uno::Exception, CommandAbortedException )
| executes a command.
void | abort ([in] long CommandId)
| ends the command associated with the given id.

## Additional Inherited Members
Exported Interfaces inherited from XUniversalContentBroker
interface | com::sun::star::lang::XComponent
| must be implemented to make it possible to resolve cyclic object references.
interface | com::sun::star::ucb::XContentProvider
| provides access to all kind of contents provided by the registered content providers.
interface | com::sun::star::ucb::XContentProviderManager
| provides access to a set of content providers registered with the UCB.
interface | com::sun::star::ucb::XContentIdentifierFactory
| creates XContentIdentifier implementation objects for all kind of contents provided by the UCB.
interface | com::sun::star::ucb::XCommandProcessor2
| Enables the caller to execute commands at the broker.

## Detailed Description

is a one-instance service that provides access to a set of Contents via ContentProviders.

Traditionally, this service implements com::sun::star::lang::XInitialization and needed to be instantiated once with two arguments via com::sun::star::lang::XMultiComponentFactory::createInstanceWithArgumentsAndContext() for configuration before it could be obtained via plain com::sun::star::lang::XMultiComponentFactory::createInstanceWithContext().

However, the only pair of initialization arguments used in practice is `"Local"`/`"Office"`, so this service is simplified now to automatically configure itself with that argument pair upon first instantiation.

(For backwards compatibility, the service implementation still supports com::sun::star::lang::XInitialization and can still explicitly be initialized via com::sun::star::lang::XMultiComponentFactory::createInstanceWithArgumentsAndContext() with two arguments of type string. These strings are used as a pair of keys to retrieve a set of content provider descriptions from the configuration management (stored at `org.openoffice.ucb.Configuration.ContentProviders.key1.SecondaryKeys.key2.ProviderData` within the configuration management's hierarchy). The retrieved descriptions are in turn used to register the corresponding content provider services at the broker.)

Developers Guide
  Universal Content Broker - Universal Content Broker - Capabilities
  Universal Content Broker - Instantiating the UCB

## Member Function Documentation

## ◆ create()

create | ( |  | ) |

The (default) constructor.

(This default constructor is only mentioned explicitly for technical reasons, so that its implementation calls the service implementation's com::sun::star::lang::XInitialization::initialize().)

The documentation for this service was generated from the following file:

- com/sun/star/ucb/UniversalContentBroker.idl