1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/*************************************************************************
*
* $RCSfile: XContentProviderManager.idl,v $
*
* $Revision: 1.1 $
*
* last change: $Author: mi $ $Date: 2000-11-06 09:22:31 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_ucb_XContentProviderManager_idl__
#define __com_sun_star_ucb_XContentProviderManager_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_ucb_XContentProvider_idl__
#include <com/sun/star/ucb/XContentProvider.idl>
#endif
#ifndef __com_sun_star_ucb_DuplicateProviderException_idl__
#include <com/sun/star/ucb/DuplicateProviderException.idl>
#endif
#ifndef __com_sun_star_ucb_ContentProviderInfo_idl__
#include <com/sun/star/ucb/ContentProviderInfo.idl>
#endif
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** makes it possible to query/register/deregister content providers.
@version 1.0
@author Kai Sommerfeld
@see XContentProvider
*/
[ uik(E2281A00-33D6-11D1-AABE00A0-249D5590), ident( "XContentProviderManager", 1.0 ) ]
interface XContentProviderManager: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** registers a content provider for a specific URL template.
@see
XContentIdentifier
@param Provider
the content provider to register.
@param Scheme
the URL scheme for the provided contents. More generally, this may not
only be a URL scheme, but a URL template.
A URL template is a regular expression (represented as a string) that
specifies a subset of the set of all possible URLs (this subset
consists of exactly those URLs that match the regular expression). The
language to denote the regular expressions is initially quite limited,
but it may be extended in the future:
regexp = scheme / simple / translation
scheme = ALPHA *(ALPHA / DIGIT / "+" / "-" / ".")
simple = simple-prefix / simple-authority / simple-domain
translation = trans-prefix / trans-authority / trans-domain
simple-prefix = [string] ".*"
trans-prefix = [string] "(.*)->" [string] "\1"
simple-authority = [string] "([/?#].*)?"
trans-authority = [string] "(([/?#].*)?)->" string "\1"
simple-domain = [string] "[^/?#]*" string "([/?#].*)?"
trans-domain = [string] "([^/?#]*" string "([/?#].*)?)->" string "\1"
string = DQUOTE 1*(schar / sescape) DQUOTE ; DQUOTE is "
schar = <any UTF-16 character except " or \>
sescape = "\" (DQUOTE / "\")
A <scheme> matches any URL of exactly the given scheme (ignoring case),
keeping the extension from URL schemes to URL templates backwards
compatible. The <simple> regexps match any URL starting with a given
string literal, followed by arbitrary characters (<simple-prefix>), or
by arbitrary characters that start with one of '/', '?', or '#', if any
(<simple-authority>), or by arbitrary characters not including any of
'/', '?', or '#', followed by a given string literal, followed by
arbitrary characters that start with one of '/', '?', or '#', if any.
The comparision of string literals is done ignoring the case of ASCII
letters. The <translation> regexps match the same URLs as their
<simple> counterparts, but they also describe how a (local) URL is
mapped to another (remote) URL. This mapping is only relevant for
methods of the <type>RemoteAccessContentProvider</type>'s
<type>XParameterizedContentProvider</type> interface; in all other
cases, <translation> regexps have the same semantics as their <simple>
counterparts.
@param ReplaceExisting
<TRUE/>: replace the provider possibly registered for
the given URL template. The replaced provider will not be
deregistered automatically! If the superseding
provider gets deregistered, the superseded one will
become active again.
<FALSE/>: do not register, if another provider is already
registered for the given URL template.
@returns
the replaced content provider, if there was one.
*/
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 );
//-------------------------------------------------------------------------
/** deregisters a content provider.
@param Provider
a content provider to deregister.
@param Scheme
the URL scheme for the provided contents. More generally, this
may not only be a URL scheme, but a URL template (see
<method>registerContentProvider</method> for a discussion of URL
templates).
*/
[oneway] void deregisterContentProvider(
[in] com::sun::star::ucb::XContentProvider Provider,
[in] string Scheme );
//-------------------------------------------------------------------------
/** returns a list of information on all registered content providers.
@returns
a list information on content providers.
*/
sequence<com::sun::star::ucb::ContentProviderInfo> queryContentProviders();
//-------------------------------------------------------------------------
/** returns the currently active content provider for a URL template.
@param Scheme
a URL scheme. More generally, this may not only be a URL scheme, but a
URL template (see <method>registerContentProvider</method> for a
discussion of URL templates).
@returns
a content provider.
*/
com::sun::star::ucb::XContentProvider queryContentProvider(
[in] string Scheme );
};
//=============================================================================
}; }; }; };
#endif
|
