| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_ucb_UniversalContentBroker_idl__ |
| #define __com_sun_star_ucb_UniversalContentBroker_idl__ |
| |
| #ifndef __com_sun_star_lang_XComponent_idl__ |
| #include <com/sun/star/lang/XComponent.idl> |
| #endif |
| |
| #ifndef __com_sun_star_ucb_XCommandProcessor_idl__ |
| #include <com/sun/star/ucb/XCommandProcessor.idl> |
| #endif |
| |
| #ifndef __com_sun_star_ucb_XCommandProcessor2_idl__ |
| #include <com/sun/star/ucb/XCommandProcessor2.idl> |
| #endif |
| |
| #ifndef __com_sun_star_ucb_XContentProviderManager_idl__ |
| #include <com/sun/star/ucb/XContentProviderManager.idl> |
| #endif |
| |
| #ifndef __com_sun_star_ucb_XContentProvider_idl__ |
| #include <com/sun/star/ucb/XContentProvider.idl> |
| #endif |
| |
| #ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__ |
| #include <com/sun/star/ucb/XContentIdentifierFactory.idl> |
| #endif |
| |
| #ifndef __com_sun_star_lang_XInitialization_idl__ |
| #include <com/sun/star/lang/XInitialization.idl> |
| #endif |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module ucb { |
| |
| //============================================================================= |
| /** is a one-instance service that provides access to a set of |
| <type>Content</type>s via <type>ContentProvider</type>s. |
| |
| <p>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 |
| <type scope="com::sun::star::lang">XInitialization</type> interface for |
| details. |
| |
| <p>If the instance is created without arguments, the newly instatiated |
| broker is not configured. |
| */ |
| published service UniversalContentBroker |
| { |
| //------------------------------------------------------------------------- |
| /** must be implemented to make it possible to resolve cyclic object |
| references. |
| |
| <p>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, |
| <member scope="com::sun::star::lang">XComponent::dispose</member> |
| must be called at the Broker. The implementation of this method must |
| call |
| <member scope="com::sun::star::lang">XEventListener::disposing</member> |
| 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. |
| |
| <p>This interface is required. |
| */ |
| interface com::sun::star::lang::XComponent; |
| |
| //------------------------------------------------------------------------- |
| /** provides access to all kind of contents provided by the registered |
| content providers. |
| |
| <p>This interface is required. |
| */ |
| interface com::sun::star::ucb::XContentProvider; |
| |
| //------------------------------------------------------------------------- |
| /** provides access to a set of content providers registered with the UCB. |
| |
| <p>This interface is required. |
| */ |
| interface com::sun::star::ucb::XContentProviderManager; |
| |
| //------------------------------------------------------------------------- |
| /** creates <type>XContentIdentifier</type> implementation objects for |
| all kind of contents provided by the UCB. |
| |
| <p>This interface is required. |
| */ |
| interface com::sun::star::ucb::XContentIdentifierFactory; |
| |
| //------------------------------------------------------------------------- |
| /** supports the configuration of a newly created broker. |
| |
| <p>The |
| <member scope="com::sun::star::lang">XInitialization::initialize</member> |
| 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 |
| <code>org.openoffice.ucb.Configuration.ContentProviders.<var>key<sub>1</sub></var>.SecondaryKeys.<var>key<sub>2</sub></var>.ProviderData</code> |
| within the configuration management's hierarchy). The retrieved |
| descriptions are in turn used to register the corresponding content |
| provider services at the broker. |
| |
| <p>Typical values for the pair of strings would be |
| <code>"Local"</code>/<code>"Office"</code>, to configure a broker that |
| contains all the relevant content providers. |
| |
| <p>This interface is required. |
| */ |
| interface com::sun::star::lang::XInitialization; |
| |
| //------------------------------------------------------------------------- |
| /** enables the caller to execute commands at the broker. |
| |
| <p>This interface is required. |
| |
| <p><pre> |
| ======================================================================= |
| 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. |
| |
| <type>XCommandInfo</type> |
| 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 <type>Content</type>s provided by one |
| // <type>ContentProvider</type>. |
| |
| void |
| globalTransfer |
| <type>GlobalTransferCommandArgument</type> |
| </pre> |
| */ |
| interface com::sun::star::ucb::XCommandProcessor; |
| |
| //------------------------------------------------------------------------- |
| /** is an enhanced version of <type>XCommandProcessor</type> that has an |
| additional method for releasing command identifiers obtained via |
| <member>XCommandProcessor::createCommandIdentifier</member> to avoid |
| resource leaks. For a detailed description of the problem refer to |
| <member>XCommandProcessor2::releaseCommandIdentifier</member>. |
| |
| <p>Where many existing <type>UniversalContentBroker</type> |
| implementations do not (yet), every new implementation should support |
| this interface. |
| */ |
| [optional] interface com::sun::star::ucb::XCommandProcessor2; |
| |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |