org.xwiki.extension.index

Interface ExtensionIndex

All Superinterfaces:

AdvancedSearchable, ExtensionRepository, Searchable

@Unstable
 @Role
public interface ExtensionIndex
extends ExtensionRepository, AdvancedSearchable

A local index of extensions coming from various repositories.

Since:

12.10

Version:

$Id: b5a210d91a3510ddb370d91ccafb1d817b74e1f2 $

Method Summary

Modifier and Type	Method and Description
ExtensionIndexStatus	getStatus(Namespace namespace)
ExtensionIndexStatus	index(Namespace namespace) Start a new indexing process or return the status of the currently running one.
IndexedExtension	resolve(ExtensionDependency extensionDependency) Return extension descriptor from the repository.
IndexedExtension	resolve(ExtensionId extensionId) Return extension descriptor from the repository.

Methods inherited from interface org.xwiki.extension.repository.ExtensionRepository

exists, getDescriptor, getId, resolveVersions

Methods inherited from interface org.xwiki.extension.repository.search.AdvancedSearchable

isFilterable, isSortable, search

Methods inherited from interface org.xwiki.extension.repository.search.Searchable

search

Method Detail

getStatus

ExtensionIndexStatus getStatus(Namespace namespace)

Parameters:

namespace - the namespace for which the validation was executed

Returns:

the status of the currently running or last indexing process

index

ExtensionIndexStatus index(Namespace namespace)
                    throws org.xwiki.job.JobException

Start a new indexing process or return the status of the currently running one.

Parameters:

namespace - the namespace for which to validate the extensions

Returns:

the status of the running indexing process

Throws:

org.xwiki.job.JobException - when failing to start indexing

resolve

IndexedExtension resolve(ExtensionDependency extensionDependency)
                  throws ResolveException

Description copied from interface: ExtensionRepository

Return extension descriptor from the repository. If the extension can't be found a ResolveException is thrown.

Specified by:

resolve in interface ExtensionRepository

Parameters:

extensionDependency - the target extension as a dependency

Returns:

the found extension descriptor

Throws:

ExtensionNotFoundException - when the dependency does not match any extension in the repository

ResolveException - failed to find extension in the repository

resolve

IndexedExtension resolve(ExtensionId extensionId)
                  throws ResolveException

Description copied from interface: ExtensionRepository

Return extension descriptor from the repository. If the extension can't be found a ResolveException is thrown.

Specified by:

resolve in interface ExtensionRepository

Parameters:

extensionId - the extension identifier

Returns:

the found extension descriptor

Throws:

ExtensionNotFoundException - when the extension does not exist in the repository

ResolveException - failed to find extension in the repository