xref: /AOO41X/main/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_XRemoteContentProviderDistributor_idl__
24#define __com_sun_star_ucb_XRemoteContentProviderDistributor_idl__
25
26#ifndef __com_sun_star_connection_ConnectionSetupException_idl__
27#include <com/sun/star/connection/ConnectionSetupException.idl>
28#endif
29
30#ifndef __com_sun_star_connection_NoConnectException_idl__
31#include <com/sun/star/connection/NoConnectException.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38#ifndef __com_sun_star_uno_XInterface_idl__
39#include <com/sun/star/uno/XInterface.idl>
40#endif
41
42
43//=============================================================================
44
45module com { module sun { module star { module ucb {
46
47//=============================================================================
48/** Distribute a content broker to variuos
49    <type>XRemoteContentProviderAcceptor</type>s.
50
51    @version 1.0
52    @author Stephan Bergmann
53    @see XRemoteContentProviderAcceptor
54*/
55published interface XRemoteContentProviderDistributor: com::sun::star::uno::XInterface
56{
57    //-------------------------------------------------------------------------
58    /** Offer the local content broker to a remote content provider acceptor.
59
60        <p> The Uno Url is handed to the
61        <type scope="com::sun::star::bridge">UnoUrlResolver</type> service,
62        which is responsible for raising any of the advertised exceptions. </p>
63
64        @param Url  A Uno Url to address the
65        <type>XRemoteContentProviderAcceptor</type>.
66
67        @param Identifier  An identifier handed to the
68        <type>XRemoteContentProviderAcceptor</type>.
69
70        @returns success indicator.  Escpecially, if there's already a
71        connection to the given Url, the call will fail, no matter whether
72        that connection uses the same identifier as the given one or not.
73    */
74    boolean connectToRemoteAcceptor([in] string Url,
75                                    [in] string Identifier)
76        raises (com::sun::star::connection::NoConnectException,
77                com::sun::star::connection::ConnectionSetupException,
78                com::sun::star::lang::IllegalArgumentException);
79
80    //-------------------------------------------------------------------------
81    /** Undo the offering of the local content broker to a specific remote
82        content provider acceptor.
83
84        @param Url  A Uno Url to address the
85        <type>XRemoteContentProviderAcceptor</type>.
86
87        @returns success indicator.
88    */
89    boolean disconnectFromRemoteAcceptor([in] string Url);
90
91    //-------------------------------------------------------------------------
92    /** Undo the offering of the local content broker to all remote content
93        provider acceptors.
94    */
95    void disconnectFromAll();
96};
97
98//=============================================================================
99
100}; }; }; };
101
102#endif
103