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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#if ! defined INCLUDED_com_sun_star_deployment_XExtensionManager_idl
#define INCLUDED_com_sun_star_deployment_XExtensionManager_idl
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/task/XAbortChannel.idl>
#include <com/sun/star/util/XModifyBroadcaster.idl>
#include <com/sun/star/deployment/XPackage.idl>
#include <com/sun/star/deployment/XPackageTypeInfo.idl>
#include <com/sun/star/ucb/XCommandEnvironment.idl>
#include <com/sun/star/deployment/DeploymentException.idl>
#include <com/sun/star/container/NoSuchElementException.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/beans/NamedValue.idl>
module com { module sun { module star { module deployment {
/** The <type>XExtensionManager</type> interface is used to manage extensions
in the user, shared and bundled repository.
@see ExtensionManager
@since OOo 3.3
*/
interface XExtensionManager
{
/** interface to notify disposing
*/
interface com::sun::star::lang::XComponent;
/** interface to notify changes of the set of deployed packages of
this manager
*/
interface com::sun::star::util::XModifyBroadcaster;
/** gets the supported <type>XPackageTypeInfo</type>s.
@return
supported <type>XPackageTypeInfo</type>s.
*/
sequence<XPackageTypeInfo> getSupportedPackageTypes();
/** creates a command channel to be used to asynchronously abort a command.
@return
abort channel
*/
com::sun::star::task::XAbortChannel createAbortChannel();
/** adds an extension.
The properties argument is currently only used to suppress the license information
for shared extensions.
@param url
package URL, must be UCB conform
@param properties
additional properties, for example, that the license is to be
suppressed (if supported by the extension)
@param repository
the name of the repository
@param xAbortChannel
abort channel to asynchronously abort the adding process,
or null
@param xCmdEnv
command environment for error and progress handling
@return
object representing the extension.
*/
XPackage addExtension( [in] string url,
[in] sequence<com::sun::star::beans::NamedValue> properties,
[in] string repository,
[in] com::sun::star::task::XAbortChannel xAbortChannel,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
/** removes an extension.
@param identifier
package identifier
@param fileName
package file name
@param repository
the name of the repository
@param xAbortChannel
abort channel to asynchronously abort the removing process,
or null
@param xCmdEnv
command environment for error and progress handling
*/
void removeExtension(
[in] string identifier,
[in] string fileName,
[in] string repository,
[in] com::sun::star::task::XAbortChannel xAbortChannel,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
/** enable an extension.
If the extension is not from the user repository then an
IllegalArgumentException is thrown.
@param extension
the extension which is to be enabled.
@param xAbortChannel
abort channel to asynchronously abort the removing process,
or null
@param xCmdEnv
command environment for error and progress handling
*/
void enableExtension(
[in] XPackage extension,
[in] com::sun::star::task::XAbortChannel xAbortChannel,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
/** disable an extension.
If the extension is not from the user repository then an
IllegalArgumentException is thrown.
@param extension
the extension which is to be disabled
@param xAbortChannel
abort channel to asynchronously abort the removing process,
or null
@param xCmdEnv
command environment for error and progress handling
*/
void disableExtension(
[in] XPackage extension,
[in] com::sun::star::task::XAbortChannel xAbortChannel,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
/** gets all currently installed extensions, including disabled
user extensions.
@param repository
the repository from which the extensions are returned
@param xAbortChannel
abort channel to asynchronously abort the removing process,
or null
@param xCmdEnv
command environment for error and progress handling
@return
all currently installed packages
*/
sequence<XPackage> getDeployedExtensions(
[in] string repository,
[in] com::sun::star::task::XAbortChannel xAbortChannel,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
/** gets an installed extensions.
@param repositroy
the name of the repository
@param identifier
extension identifier
@param fileName
extension file name
@param xCmdEnv
command environment for error and progress handling
@return
<type>XPackage</type> object
*/
XPackage getDeployedExtension(
[in] string repository,
[in] string identifier,
[in] string fileName,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::lang::IllegalArgumentException);
/** gets all extensions with the same identifer from all repositories.
The extension at the first position in the returned sequence represents
the extension from the user repository. The next element is from the shared
and the last one is from the bundled repository.
If one repository does not contain this extension, then the respective
element is a null reference.
*/
sequence<XPackage> getExtensionsWithSameIdentifier(
[in] string identifier,
[in] string fileName,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::lang::IllegalArgumentException);
/** returns a sequence containing all installed extensions.
The members of the returned sequence correspond to an extension with a
particular extension identifer. The members are also sequences which
contain as many elements as there are repositories. Those are ordered
according to the priority of the repository. That is, the first member
is the extension from the user repository, the second is from the shared
repository and the last is from the bundled repository.
*/
sequence<sequence<XPackage> > getAllExtensions(
[in] com::sun::star::task::XAbortChannel xAbortChannel,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
/** Expert feature: erases the underlying registry cache and reinstalls
all previously added extensions. Please keep in mind that all
registration status get lost.
<p>
Please use this in case of suspected cache inconsistencies only.
</p>
@param repositroy
the name of the repository
@param xAbortChannel
abort channel to asynchronously abort the adding process
@param xCmdEnv
command environment for error and progress handling
*/
void reinstallDeployedExtensions(
[in] string repository,
[in] com::sun::star::task::XAbortChannel xAbortChannel,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
/** synchronizes the extension database with the contents of the extensions
folder of shared and bundled extensinos.
Added extensions will be added to the database and removed extensions
will be removed from the database.
The active extensions are determined. That is, shared or bundled extensions
are not necessaryly registered (<member>XPackage::registerPackage</member>).
@return
If true - then at least one extension was removed or added. Otherwise
nothing was chaned.
*/
boolean synchronize(
[in] com::sun::star::task::XAbortChannel xAbortChannel,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
/** synchronizes the special bundled_prereg repository, which is based on
the bundled extensions and has its registration data folder at
$BUNDLED_EXTENSIONS_PREREG (for example openoffice.org3/share/prereg).
All bundled extensions are registered (<member>XPackage::registerPackage</member>).
The active extensions are NOT determined, because this function only works
with bundled extensions.
This function is intended to be called during the installation of OOo.
OOo will copy parts of the registration data folder to the user installation at the
first startup.
*/
void synchronizeBundledPrereg(
[in] com::sun::star::task::XAbortChannel xAbortChannel,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException);
/** returns all extensions which are currently not in use
because the user did not accept the license.
The function will not return any object for the user repository, because
a user extension will not be kept in the user repository if its license
is declined. Only extensions which are registered at start-up of OOo,
that is, shared and bundled extensions, can be returned.
Extensions which allow the license to be suppressed, that is, it does not
need to be displayed, and which are installed with the corresponding option,
are also not returned.
Extensions returned by this functions are not returned by
<member>XExtensionManger::getDeployedExtension</member>
<member>XExtensionManger::getDeployedExtensions</member>
<member>XExtensionManger::getAllExtensions</member>
<member>XExtensionManger::getExtensionsWithSameIdentifier</member>
*/
sequence<XPackage> getExtensionsWithUnacceptedLicenses(
[in] string repository,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::lang::IllegalArgumentException);
/** check if all prerequisites for the extension are fulfilled
and activates it, if possible.
*/
long checkPrerequisitesAndEnable(
[in] XPackage extension,
[in] com::sun::star::task::XAbortChannel xAbortChannel,
[in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
raises (DeploymentException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::ucb::CommandAbortedException,
com::sun::star::lang::IllegalArgumentException);
/** determines if the current user has write access to the extensions folder
of the repository.
*/
boolean isReadOnlyRepository([in] string repository);
};
}; }; }; };
#endif
|
