org.xwiki.extension

Interface ExtensionManager

@Role
public interface ExtensionManager

Main entry point for some extensions management tasks.

Since:

4.0M1

Version:

$Id: bbacea7f6c86621f5497a86b183bdb744cad6254 $

Method Summary

Methods

Modifier and Type	Method and Description
ExtensionRepository	getRepository(String repositoryId) Return a repository based on its id.
Extension	resolveExtension(ExtensionDependency extensionDependency) Deprecated.
Extension	resolveExtension(ExtensionDependency extensionDependency, String namespace) Search the provided extension as a dependency of another extension among all repositories including core and local repositories.
Extension	resolveExtension(ExtensionId extensionId) Search the provided extension among all repositories including core and local repositories.

Method Detail

resolveExtension

Extension resolveExtension(ExtensionId extensionId)
                           throws ResolveException

Search the provided extension among all repositories including core and local repositories.

The search is done in the following order:

• Is it a core extension ?
• Is it a local extension ?
• Is it a remote extension in one of the configured remote repositories ?

The first one found is returned.

Parameters:

extensionId - the extension identifier

Returns:

the resolved extension

Throws:

ResolveException - error when trying to resolve extension

resolveExtension

@Deprecated
Extension resolveExtension(ExtensionDependency extensionDependency)
                           throws ResolveException

Deprecated.

Search the provided extension as a dependency of another extension among all repositories including core and local repositories.

The search is done in the following order:

• Is it a core extension ?
• Is it a local extension ?
• Is it a remote extension in one of the configured remote repositories ?

The first one found is returned.

Parameters:

extensionDependency - the extension as dependency

Returns:

the resolved extension

Throws:

ResolveException - error when trying to resolve extension

Since:

since 5.3M1, use resolveExtension(ExtensionDependency, String) instead

resolveExtension

Extension resolveExtension(ExtensionDependency extensionDependency,
                         String namespace)
                           throws ResolveException

Search the provided extension as a dependency of another extension among all repositories including core and local repositories.

The search is done in the following order:

• Is it a core extension ?
• Is it a local extension ?
• Is this feature installed in current namespace or parent ?
• Is it a remote extension in one of the configured remote repositories ?

The first one found is returned.

Parameters:

extensionDependency - the extension as dependency

namespace - the namespace where to search for the dependency

Returns:

the resolved extension

Throws:

ResolveException - error when trying to resolve extension

Since:

5.3M1

getRepository

ExtensionRepository getRepository(String repositoryId)

Return a repository based on its id.

This method also return local, installed and core repositories.

Parameters:

repositoryId - the id of the repository

Returns:

the repository

Since:

4.0M2