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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef __com_sun_star_ucb_XContentProviderManager_idl__
#define __com_sun_star_ucb_XContentProviderManager_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/ucb/XContentProvider.idl>
#include <com/sun/star/ucb/DuplicateProviderException.idl>
#include <com/sun/star/ucb/ContentProviderInfo.idl>
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
*/
published 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.
<p>This may be <NULL/>, in which case a later
<member>XContentProvider::queryContent</member> with an
<type>XContentIdentifier</type> that matches the <var>Scheme</var>
will simply return <NULL/>. These "dummy" content providers are useful
in combination with other content providers that are registered on a
wildcard URL template: For example, imagine that you want to route all
http URLs to a HTTP content provider, but want to block all URLs for
the server <code>www.dont.go</code>. One solution would be to register
the HTTP content provider on the <var>Scheme</var> <code>http</code>,
and to register a "dummy" (i.e., <NULL/>) content provider on the
<var>Scheme</var> <code>"http://www.dont.go"([/?#].*)?</code>.
@param Scheme
the URL scheme for the provided contents. More generally, this may not
only be a URL scheme, but a URL template.
<p>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:
<p><ul>
<li><code>regexp = scheme / simple / translation</code></li>
<li><code>scheme = ALPHA *(ALPHA / DIGIT / "+" / "-" / ".")</code></li>
<li><code>simple = simple-prefix / simple-authority / simple-domain</code></li>
<li><code>translation = trans-prefix / trans-authority / trans-domain</code></li>
<li><code>simple-prefix = [string] ".*"</code></li>
<li><code>trans-prefix = [string] "(.*)->" [string] "\1"</code></li>
<li><code>simple-authority = [string] "([/?#].*)?"</code></li>
<li><code>trans-authority = [string] "(([/?#].*)?)->" string "\1"</code></li>
<li><code>simple-domain = [string] "[^/?#]*" string "([/?#].*)?"</code></li>
<li><code>trans-domain = [string] "([^/?#]*" string "([/?#].*)?)->" string "\1"</code></li>
<li><code>string = DQUOTE 1*(schar / sescape) DQUOTE ; DQUOTE is "</code></li>
<li><code>schar = < any UTF-16 character except " or \></code></li>
<li><code>sescape = "\" (DQUOTE / "\")</code></li>
</ul>
<p>A <code><scheme>:</code> matches any URL of exactly the given
scheme (ignoring case), keeping the extension from URL schemes to URL
templates backwards compatible. The <code><simple>:</code>
regexps match any URL starting with a given string literal, followed
by arbitrary characters (<code><simple-prefix>:</code>), or
by arbitrary characters that start with one of '/', '?', or '#', if any
(<code><simple-authority>:</code>), 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 comparison of string literals is done ignoring the
case of ASCII letters. The <code><translation>:</code> regexps
match the same URLs as their <code><simple>:</code> 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, <code><translation>:</code> regexps have the same semantics
as their <code><simple>:</code> 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.
<p><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
<member>registerContentProvider</member> for a discussion of URL
templates).
*/
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 content
identifier.
@param Identifier
a content identifier (i.e., a URL).
@returns
a content provider.
*/
com::sun::star::ucb::XContentProvider queryContentProvider(
[in] string Identifier );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
