org.xwiki.extension.script

Class InstalledExtensionScriptService

java.lang.Object

org.xwiki.extension.script.AbstractExtensionScriptService

org.xwiki.extension.script.InstalledExtensionScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
 @Named(value="extension.installed")
 @Singleton
public class InstalledExtensionScriptService
extends AbstractExtensionScriptService

Various script APIs related to installed extensions.

Since:

5.3M1

Version:

$Id: fa7775d91ac2a12081de6167383ebc81184e137a $

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID The identifier of the sub extension ScriptService.

Fields inherited from class org.xwiki.extension.script.AbstractExtensionScriptService

authorization, documentAccessBridge, execution, EXTENSIONERROR_KEY, jobExecutor, PROPERTY_CALLERREFERENCE, PROPERTY_CHECKRIGHTS, PROPERTY_CONTEXT_ACTION, PROPERTY_CONTEXT_WIKI, PROPERTY_USERREFERENCE, scriptProvider, WIKI_NAMESPACE_PREFIX, xcontextProvider

Constructor Summary

Constructors

Constructor and Description
InstalledExtensionScriptService()

Method Summary

Modifier and Type	Method and Description
Map<String,Collection<org.xwiki.extension.InstalledExtension>>	getBackwardDependencies(org.xwiki.extension.ExtensionId extensionId) Get all backward dependencies by namespace for the provided installed extension.
Map<String,Collection<org.xwiki.extension.InstalledExtension>>	getBackwardDependencies(String feature) Get all the installed extensions that depend on the specified root extension.
Collection<org.xwiki.extension.InstalledExtension>	getBackwardDependencies(String feature, String namespace) Get provided installed extension backward dependencies in the provided namespace.
org.xwiki.extension.InstalledExtension	getInstalledExtension(String feature, String namespace) Get the extension handler corresponding to the given installed extension ID or feature (virtual ID) provided by the extension and namespace.
Collection<org.xwiki.extension.InstalledExtension>	getInstalledExtensions() Get a list of all currently installed extensions.
Collection<org.xwiki.extension.InstalledExtension>	getInstalledExtensions(String namespace) Return all the extensions available for the provide namespace.
org.xwiki.extension.repository.InstalledExtensionRepository	getRepository()

Methods inherited from class org.xwiki.extension.script.AbstractExtensionScriptService

contextualize, fromWikitoNamespace, getCallerDocument, getJobStatus, getLastError, safe, safeWrapError, setError, setRightsProperties, toWikiId, wrapError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final String ID

The identifier of the sub extension ScriptService.

See Also:

Constant Field Values

Constructor Detail

InstalledExtensionScriptService

public InstalledExtensionScriptService()

Method Detail

getRepository

public org.xwiki.extension.repository.InstalledExtensionRepository getRepository()

Returns:

the installed extensions repository

getInstalledExtensions

public Collection<org.xwiki.extension.InstalledExtension> getInstalledExtensions()

Get a list of all currently installed extensions. This doesn't include core extensions, only custom extensions installed by the administrators.

Returns:

a list of read-only handlers corresponding to the installed extensions, an empty list if nothing is installed

getInstalledExtensions

public Collection<org.xwiki.extension.InstalledExtension> getInstalledExtensions(String namespace)

Return all the extensions available for the provide namespace. This also include root extension since namespaces inherit from root.

This doesn't include core extensions, only extension installed through the API.

Parameters:

namespace - the target namespace for which to retrieve the list of installed extensions

Returns:

a list of read-only handlers corresponding to the installed extensions, an empty list if nothing is installed in the target namespace

getInstalledExtension

public org.xwiki.extension.InstalledExtension getInstalledExtension(String feature,
                                                                    String namespace)

Get the extension handler corresponding to the given installed extension ID or feature (virtual ID) provided by the extension and namespace.

The returned handler can be used to get more information about the extension, such as the authors, an extension description, its license...

Parameters:

feature - the extension id or provided feature (virtual extension) of the extension to resolve

namespace - the optional namespace where the extension should be installed

Returns:

the read-only handler corresponding to the requested extension, or null if the extension isn't installed in the target namespace

getBackwardDependencies

public Map<String,Collection<org.xwiki.extension.InstalledExtension>> getBackwardDependencies(String feature)

Get all the installed extensions that depend on the specified root extension. The results are grouped by namespace.

Parameters:

feature - the extension id or provided feature (virtual extension) of the extension to resolve

Returns:

a map namespace -> list of dependent extensions, or null if any error occurs while computing the result, in which case AbstractExtensionScriptService.getLastError() contains the failure reason

getBackwardDependencies

public Map<String,Collection<org.xwiki.extension.InstalledExtension>> getBackwardDependencies(org.xwiki.extension.ExtensionId extensionId)

Get all backward dependencies by namespace for the provided installed extension.

Parameters:

extensionId - the extension identifier

Returns:

the extension backward dependencies in all namespaces, or null if any error occurs while computing the result, in which case AbstractExtensionScriptService.getLastError() contains the failure reason

getBackwardDependencies

public Collection<org.xwiki.extension.InstalledExtension> getBackwardDependencies(String feature,
                                                                                  String namespace)

Get provided installed extension backward dependencies in the provided namespace.

Only look at the backward dependencies in the provided namespace. To get all the dependencies of a root extension (namespace=null) across namespaces use getBackwardDependencies(ExtensionId) instead.

Parameters:

feature - the extension unique identifier

namespace - the namespace where to search for backward dependencies

Returns:

the backward dependencies, an empty collection of none could be found, or null if any error occurs while computing the result, in which case AbstractExtensionScriptService.getLastError() contains the failure reason