LibreOffice: com/sun/star/deployment/XExtensionManager.idl Source File

LibreOffice LibreOffice 7.2 SDK API Reference

XExtensionManager.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef _com_sun_star_deployment_XExtensionManager_idl
21#define _com_sun_star_deployment_XExtensionManager_idl
22
23#include <com/sun/star/lang/XComponent.idl>
24#include <com/sun/star/task/XAbortChannel.idl>
25#include <com/sun/star/util/XModifyBroadcaster.idl>
26#include <com/sun/star/deployment/XPackage.idl>
27#include <com/sun/star/deployment/XPackageTypeInfo.idl>
28#include <com/sun/star/ucb/XCommandEnvironment.idl>
29#include <com/sun/star/deployment/DeploymentException.idl>
30#include <com/sun/star/container/NoSuchElementException.idl>
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#include <com/sun/star/beans/NamedValue.idl>
33
34module com { module sun { module star { module deployment {
35
42 interface XExtensionManager
43{
46 interface com::sun::star::lang::XComponent;
47
51 interface com::sun::star::util::XModifyBroadcaster;
52
53
59 sequence<XPackageTypeInfo> getSupportedPackageTypes();
60
66 com::sun::star::task::XAbortChannel createAbortChannel();
67
88 XPackage addExtension( [in] string url,
89 [in] sequence<com::sun::star::beans::NamedValue> properties,
90 [in] string repository,
91 [in] com::sun::star::task::XAbortChannel xAbortChannel,
92 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
93 raises (DeploymentException,
94 com::sun::star::ucb::CommandFailedException,
95 com::sun::star::ucb::CommandAbortedException,
96 com::sun::star::lang::IllegalArgumentException);
97
112 void removeExtension(
113 [in] string identifier,
114 [in] string fileName,
115 [in] string repository,
116 [in] com::sun::star::task::XAbortChannel xAbortChannel,
117 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
118 raises (DeploymentException,
119 com::sun::star::ucb::CommandFailedException,
120 com::sun::star::ucb::CommandAbortedException,
121 com::sun::star::lang::IllegalArgumentException);
122
123
137 void enableExtension(
138 [in] XPackage extension,
139 [in] com::sun::star::task::XAbortChannel xAbortChannel,
140 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
141 raises (DeploymentException,
142 com::sun::star::ucb::CommandFailedException,
143 com::sun::star::ucb::CommandAbortedException,
144 com::sun::star::lang::IllegalArgumentException);
145
159 void disableExtension(
160 [in] XPackage extension,
161 [in] com::sun::star::task::XAbortChannel xAbortChannel,
162 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
163 raises (DeploymentException,
164 com::sun::star::ucb::CommandFailedException,
165 com::sun::star::ucb::CommandAbortedException,
166 com::sun::star::lang::IllegalArgumentException);
167
181 sequence<XPackage> getDeployedExtensions(
182 [in] string repository,
183 [in] com::sun::star::task::XAbortChannel xAbortChannel,
184 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
185 raises (DeploymentException,
186 com::sun::star::ucb::CommandFailedException,
187 com::sun::star::ucb::CommandAbortedException,
188 com::sun::star::lang::IllegalArgumentException);
189
190
204 XPackage getDeployedExtension(
205 [in] string repository,
206 [in] string identifier,
207 [in] string fileName,
208 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
209 raises (DeploymentException,
210 com::sun::star::ucb::CommandFailedException,
211 com::sun::star::lang::IllegalArgumentException);
212
221 sequence<XPackage> getExtensionsWithSameIdentifier(
222 [in] string identifier,
223 [in] string fileName,
224 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
225 raises (DeploymentException,
226 com::sun::star::ucb::CommandFailedException,
227 com::sun::star::lang::IllegalArgumentException);
228
229
239 sequence<sequence<XPackage> > getAllExtensions(
240 [in] com::sun::star::task::XAbortChannel xAbortChannel,
241 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
242 raises (DeploymentException,
243 com::sun::star::ucb::CommandFailedException,
244 com::sun::star::ucb::CommandAbortedException,
245 com::sun::star::lang::IllegalArgumentException);
246
247
264 void reinstallDeployedExtensions(
265 [in] boolean force,
266 [in] string repository,
267 [in] com::sun::star::task::XAbortChannel xAbortChannel,
268 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
269 raises (DeploymentException,
270 com::sun::star::ucb::CommandFailedException,
271 com::sun::star::ucb::CommandAbortedException,
272 com::sun::star::lang::IllegalArgumentException);
273
274
287 boolean synchronize(
288 [in] com::sun::star::task::XAbortChannel xAbortChannel,
289 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
290 raises (DeploymentException,
291 com::sun::star::ucb::CommandFailedException,
292 com::sun::star::ucb::CommandAbortedException,
293 com::sun::star::lang::IllegalArgumentException);
294
313 sequence<XPackage> getExtensionsWithUnacceptedLicenses(
314 [in] string repository,
315 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
316 raises (DeploymentException,
317 com::sun::star::lang::IllegalArgumentException);
318
322 long checkPrerequisitesAndEnable(
323 [in] XPackage extension,
324 [in] com::sun::star::task::XAbortChannel xAbortChannel,
325 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
326 raises (DeploymentException,
327 com::sun::star::ucb::CommandFailedException,
328 com::sun::star::ucb::CommandAbortedException,
329 com::sun::star::lang::IllegalArgumentException);
330
334 boolean isReadOnlyRepository([in] string repository);
335};
336
337}; }; }; };
338
339#endif
340
341/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
IllegalArgumentException.idl
NamedValue.idl
NoSuchElementException.idl
XAbortChannel.idl
XCommandEnvironment.idl
XComponent.idl
XModifyBroadcaster.idl
XPackageTypeInfo.idl
XPackage.idl
com::sun::star::deployment::DeploymentException
A DeploymentException reflects a deployment error.
Definition: DeploymentException.idl:33
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::ucb::CommandAbortedException
This exception is thrown to indicate that a command was aborted.
Definition: CommandAbortedException.idl:34
com::sun::star::ucb::CommandFailedException
This exception is thrown if an exception situation occurred during the processing of a command and an...
Definition: CommandFailedException.idl:40
com::sun::star::deployment::XExtensionManager
The XExtensionManager interface is used to manage extensions in the user, shared and bundled reposito...
Definition: XExtensionManager.idl:43
com::sun::star::deployment::XExtensionManager::removeExtension
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)
removes an extension.
com::sun::star::deployment::XExtensionManager::addExtension
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)
adds an extension.
com::sun::star::deployment::XExtensionManager::getSupportedPackageTypes
sequence< XPackageTypeInfo > getSupportedPackageTypes()
gets the supported XPackageTypeInfos.
com::sun::star::deployment::XExtensionManager::isReadOnlyRepository
boolean isReadOnlyRepository([in] string repository)
determines if the current user has write access to the extensions folder of the repository.
com::sun::star::deployment::XExtensionManager::getDeployedExtensions
sequence< XPackage > getDeployedExtensions([in] string repository, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
gets all currently installed extensions, including disabled user extensions.
com::sun::star::deployment::XExtensionManager::getAllExtensions
sequence< sequence< XPackage > > getAllExtensions([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
returns a sequence containing all installed extensions.
com::sun::star::deployment::XExtensionManager::enableExtension
void enableExtension([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
enable an extension.
com::sun::star::deployment::XExtensionManager::checkPrerequisitesAndEnable
long checkPrerequisitesAndEnable([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
check if all prerequisites for the extension are fulfilled and activates it, if possible.
com::sun::star::deployment::XExtensionManager::disableExtension
void disableExtension([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
disable an extension.
com::sun::star::deployment::XExtensionManager::getExtensionsWithUnacceptedLicenses
sequence< XPackage > getExtensionsWithUnacceptedLicenses([in] string repository, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
returns all extensions which are currently not in use because the user did not accept the license.
com::sun::star::deployment::XExtensionManager::getDeployedExtension
XPackage getDeployedExtension([in] string repository, [in] string identifier, [in] string fileName, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
gets an installed extensions.
com::sun::star::deployment::XExtensionManager::createAbortChannel
com::sun::star::task::XAbortChannel createAbortChannel()
creates a command channel to be used to asynchronously abort a command.
com::sun::star::deployment::XExtensionManager::getExtensionsWithSameIdentifier
sequence< XPackage > getExtensionsWithSameIdentifier([in] string identifier, [in] string fileName, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
gets all extensions with the same identifier from all repositories.
com::sun::star::deployment::XExtensionManager::reinstallDeployedExtensions
void reinstallDeployedExtensions([in] boolean force, [in] string repository, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
Expert feature: erases the underlying registry cache and reinstalls all previously added extensions.
com::sun::star::deployment::XExtensionManager::synchronize
boolean synchronize([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
synchronizes the extension database with the contents of the extensions folder of shared and bundled ...
com::sun::star::deployment::XPackage
Objects of this interface reflect a bound package and are issued by a PackageRegistryBackend.
Definition: XPackage.idl:47
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:43
com::sun::star::task::XAbortChannel
Use this interface to abort a command asynchronously.
Definition: XAbortChannel.idl:31
com::sun::star::ucb::XCommandEnvironment
defines the environment for a command.
Definition: XCommandEnvironment.idl:36
com::sun::star::util::XModifyBroadcaster
broadcasts each modification made on the date data of the object which supports this interface.
Definition: XModifyBroadcaster.idl:38
com
Definition: Ambiguous.idl:22
DeploymentException.idl