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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XPackageManager.idl,v $
* $Revision: 1.10 $
*
* 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_XPackageManager_idl
#define INCLUDED_com_sun_star_deployment_XPackageManager_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>
module com { module sun { module star { module deployment {
/** The <type>XPackageManager</type> interface is used to add or remove
packages to a specific deployment context.
Packages are deployable files, e.g. scripts or UNO components.
<p>
Adding an UNO package means that a copy of the package is stored
with respect to the context of the manager and the package is registered,
thus activated.
</p>
<p>
Removing an UNO package means that the previously added package is revoked,
thus deactivated, first and then removed from the context.
</p>
<p>
Objects of this interface are created using the
<type>XPackageManagerFactory</type> service resp. the singleton
<code>
/singletons/com.sun.star.deployment.thePackageManagerFactory
</code>.
</p>
@see thePackageManagerFactory
@since OOo 2.0.0
*/
interface XPackageManager
{
/** 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;
/** returns the underlying deployment context.
@return
underlying deployment context
*/
string getContext();
/** 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 UNO package.
@param url
package URL, must be UCB conform
@param mediaType
media-type of package, empty string if to be detected
@param xAbortChannel
abort channel to asynchronously abort the adding process,
or null
@param xCmdEnv
command environment for error and progress handling
@return
<type>XPackage</type> handle
*/
XPackage addPackage( [in] string url,
[in] string mediaType,
[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 UNO package.
@param identifier
package identifier
@param fileName
package file name
@param xAbortChannel
abort channel to asynchronously abort the removing process,
or null
@param xCmdEnv
command environment for error and progress handling
*/
void removePackage( [in] string identifier,
[in] string fileName,
[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 a deployed package.
@param identifier
package identifier
@param fileName
package file name
@param xCmdEnv
command environment for error and progress handling
@return
<type>XPackage</type> handle
*/
XPackage getDeployedPackage(
[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 currently deployed packages.
@param xAbortChannel
abort channel to asynchronously abort the removing process,
or null
@param xCmdEnv
command environment for error and progress handling
@return
all currently deployed packages
*/
sequence<XPackage> getDeployedPackages(
[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 packages. Please keep in mind that all
registration status get lost.
<p>
Please use this in case of suspected cache inconsistencies only.
</p>
@param xAbortChannel
abort channel to asynchronously abort the adding process
@param xCmdEnv
command environment for error and progress handling
*/
void reinstallDeployedPackages(
[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);
/** indicates that this implementation cannot be used for tasks
which require write access to the location where the extensions
are installed.
<p>
Normally one would call a method and handle the exception
if writing failed. However, a GUI interface may need to know beforehand
if writing is allowed. For example, the Extension Manager dialog
needs to enable / disable the Add button depending if the user has
write permission. Only the XPackageManager implementation knows the
location of the installed extensions. Therefore it is not possible
to check "externally" for write permission.
</p>
*/
boolean isReadOnly();
};
}; }; }; };
#endif
|
