service UniversalContentBroker in module com::sun::star::ucb::

(Global Index)

Syntax

service UniversalContentBroker;

Description

is a one-instance service that provides access to a set of Content s via ContentProvider s.

If the instance is created with two arguments of type string, these two strings are used to configure the newly instantiated broker; see the description of the required XInitialization interface for details.

If the instance is created without arguments, the newly instatiated broker is not configured.

Exported Interfaces

com::sun::star::lang::XComponent

Description

must be implemented to make it possible to resolve cyclic object references.

Those references i.e. may occure if content provider implementations hold references to the Broker. The Broker itself always holds its providers. If the Broker shall be released, XComponent::dispose must be called at the Broker. The implementation of this method must call XEventListener::disposing on the registered listeners (the providers holding the Broker must be those listeners) and release the appropriate object references. At the other hand, the implementation of XEventListener::disposing must release its appropriate references.

This interface is required.


com::sun::star::ucb::XContentProvider

Description

provides access to all kind of contents provided by the registered content providers.

This interface is required.


com::sun::star::ucb::XContentProviderManager

Description

provides access to a set of content providers registered with the UCB.

This interface is required.


com::sun::star::ucb::XContentIdentifierFactory

Description

creates XContentIdentifier implementation objects for all kind of contents provided by the UCB.

This interface is required.


com::sun::star::lang::XInitialization

Description

supports the configuration of a newly created broker.

The method should be called 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. key 1 .SecondaryKeys. key 2 .ProviderData within the configuration management's hierarchy). The retrieved descriptions are in turn used to register the corresponding content provider services at the broker.

Typical values for the pair of strings would be "Local" / "Office" , to configure a broker that contains all the relevant content providers.

This interface is required.


com::sun::star::ucb::XCommandProcessor

Description

enables the caller to execute commands at the broker.

This interface is required.

 =======================================================================
 Commands:
 =======================================================================

 [return type]
 [command name]
 [parameter type and name]

 -----------------------------------------------------------------------
 Requiered commands:
 -----------------------------------------------------------------------

 // This command obtains an interface which allows to query
 // information on commands supported by the Content Broker.

 XCommandInfo
 getCommandInfo
 void

 // This command transfers Contents from one location to another.
 // Additionally, it can be used to create a link to a Content.
 // The implementation must be able to handle Contents provided
 // by any Content Provider. This is different from the command
 // 'transfer' that can be supported by a Content. That command
 // typically can only handle Content s provided by one
 // ContentProvider .

 void
 globalTransfer
 GlobalTransferCommandArgument

Top of Page