Skip navigation links
A C D E F G I J L N O P R S T U W X 

A

AbstractExtensionScriptService - Class in org.xwiki.extension.script
Base class for all extension related script services.
AbstractExtensionScriptService() - Constructor for class org.xwiki.extension.script.AbstractExtensionScriptService
 
authorization - Variable in class org.xwiki.extension.script.AbstractExtensionScriptService
 

C

contextualize(AbstractRequest) - Method in class org.xwiki.extension.script.AbstractExtensionScriptService
Add to the job request various information about the current context.
CoreExtensionScriptService - Class in org.xwiki.extension.script
Various script APIs related to core extensions.
CoreExtensionScriptService() - Constructor for class org.xwiki.extension.script.CoreExtensionScriptService
 
createExtensionDependency(String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Creates an extension dependency object.
createExtensionDependency(String, String, boolean) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Creates an extension dependency object.
createExtensionId(String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Create an instance of ExtensionId.
createInstallPlan(InstallRequest) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Start the asynchronous installation plan creation process for an extension.
createInstallPlan(String, String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Start the asynchronous installation plan creation process for an extension.
createInstallPlanRequest(String, String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Create an InstallRequest instance based on given parameters, to be used to create the install plan.
createInstallRequest(String, String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Create an InstallRequest instance based on passed parameters.
createReplayPlan(List<ExtensionJobHistoryRecord>, boolean, Collection<String>) - Method in class org.xwiki.extension.script.ExtensionHistoryScriptService
Prepares a list of history records for replay.
createUninstallPlan(String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Start the asynchronous uninstallation plan creation process for an extension.
createUninstallPlan(ExtensionId) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Start the asynchronous uninstallation plan creation process for an extension if no other job is in progress already.
createUninstallRequest(String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Create an UninstallRequest instance based on passed parameters.
createUpgradePlan(InstallRequest) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Schedule the upgrade plan creation job.
createUpgradePlan(String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Start the asynchronous upgrade plan creation process for the provided namespace.
createUpgradePlan() - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Start the asynchronous upgrade plan creation process for all the namespaces.
createUpgradePlanRequest(String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Create a request used when asking for the upgrade plan on a namespace.
createUpgradePlanRequest(ExtensionId, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Create a request used when asking for the upgrade plan of an extension on a namespace.

D

deserialize(String) - Method in class org.xwiki.extension.script.ExtensionHistoryScriptService
Deserializes a list of history records.
documentAccessBridge - Variable in class org.xwiki.extension.script.AbstractExtensionScriptService
Needed for getting the current user reference.

E

execution - Variable in class org.xwiki.extension.script.AbstractExtensionScriptService
Provides access to the current context.
EXTENSION_JOBID_PREFIX - Static variable in class org.xwiki.extension.script.ExtensionManagerScriptService
Deprecated.
since 8.2RC1, use ExtensionRequest.JOBID_PREFIX instead
EXTENSIONACTION_JOBID_PREFIX - Static variable in class org.xwiki.extension.script.ExtensionManagerScriptService
Deprecated.
since 8.2RC1, use ExtensionRequest.JOBID_ACTION_PREFIX instead
EXTENSIONERROR_KEY - Static variable in class org.xwiki.extension.script.AbstractExtensionScriptService
The key under which the last encountered error is stored in the current execution context.
ExtensionHistoryFilter() - Constructor for class org.xwiki.extension.script.ExtensionHistoryScriptService.ExtensionHistoryFilter
 
ExtensionHistoryScriptService - Class in org.xwiki.extension.script
Various script APIs related to extension job history.
ExtensionHistoryScriptService() - Constructor for class org.xwiki.extension.script.ExtensionHistoryScriptService
 
ExtensionHistoryScriptService.ExtensionHistoryFilter - Class in org.xwiki.extension.script
Utility class to build filters for the extension job history.
ExtensionManagerScriptService - Class in org.xwiki.extension.script
Entry point of extension manager from scripts.
ExtensionManagerScriptService() - Constructor for class org.xwiki.extension.script.ExtensionManagerScriptService
 
EXTENSIONPLAN_JOBID_PREFIX - Static variable in class org.xwiki.extension.script.ExtensionManagerScriptService
Deprecated.
since 8.2RC1, use ExtensionRequest.JOBID_PLAN_PREFIX instead
ExtensionRatingScriptService - Class in org.xwiki.extension.script
Various script APIs related to ratable extensions.
ExtensionRatingScriptService() - Constructor for class org.xwiki.extension.script.ExtensionRatingScriptService
 

F

fromThisWiki() - Method in class org.xwiki.extension.script.ExtensionHistoryScriptService.ExtensionHistoryFilter
Filters the jobs that have been executed on the current wiki or on the entire farm.
fromWikitoNamespace(String) - Method in class org.xwiki.extension.script.AbstractExtensionScriptService
 

G

get(String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
 
getBackwardDependencies(String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
getBackwardDependencies(String) - Method in class org.xwiki.extension.script.InstalledExtensionScriptService
Get all the installed extensions that depend on the specified root extension.
getBackwardDependencies(ExtensionId) - Method in class org.xwiki.extension.script.InstalledExtensionScriptService
Get all backward dependencies by namespace for the provided installed extension.
getBackwardDependencies(String, String) - Method in class org.xwiki.extension.script.InstalledExtensionScriptService
Get provided installed extension backward dependencies in the provided namespace.
getCallerDocument() - Method in class org.xwiki.extension.script.AbstractExtensionScriptService
 
getCoreExtension(String) - Method in class org.xwiki.extension.script.CoreExtensionScriptService
Get the extension handler corresponding to the given core extension ID.
getCoreExtension(String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Deprecated.
getCoreExtensions() - Method in class org.xwiki.extension.script.CoreExtensionScriptService
Get a list of core extensions provided by the current version of the platform.
getCoreExtensions() - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Deprecated.
getCurrentJob() - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Get a reference to the currently job executed.
getCurrentJobStatus() - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Get the status of the currently executing job, if any.
getExtensionJobStatus(String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Return job status corresponding to the provided extension id from the current executed job or stored history.
getExtensionPlanJobStatus(String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Return extension plan corresponding to the provided extension id from the current executed job or stored history.
getInstalledExtension(String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
getInstalledExtension(String, String) - Method in class org.xwiki.extension.script.InstalledExtensionScriptService
Get the extension handler corresponding to the given installed extension ID or feature (virtual ID) provided by the extension and namespace.
getInstalledExtensions() - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Deprecated.
getInstalledExtensions(String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
getInstalledExtensions() - Method in class org.xwiki.extension.script.InstalledExtensionScriptService
Get a list of all currently installed extensions.
getInstalledExtensions(String) - Method in class org.xwiki.extension.script.InstalledExtensionScriptService
Return all the extensions available for the provide namespace.
getJobStatus(List<String>) - Method in class org.xwiki.extension.script.AbstractExtensionScriptService
 
getLastError() - Method in class org.xwiki.extension.script.AbstractExtensionScriptService
Get the error generated while performing the previously called action.
getLocalExtensions() - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
getLocalExtensions() - Method in class org.xwiki.extension.script.LocalExtensionScriptService
Get a list of cached extensions from the local extension repository.
getRating(ExtensionId) - Method in class org.xwiki.extension.script.ExtensionRatingScriptService
 
getRating(String, Version) - Method in class org.xwiki.extension.script.ExtensionRatingScriptService
 
getRating(String, String) - Method in class org.xwiki.extension.script.ExtensionRatingScriptService
 
getRecords() - Method in class org.xwiki.extension.script.ExtensionHistoryScriptService
 
getReplayJobStatus(String) - Method in class org.xwiki.extension.script.ExtensionHistoryScriptService
 
getRepositories() - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
 
getRepository() - Method in class org.xwiki.extension.script.CoreExtensionScriptService
 
getRepository(String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
 
getRepository() - Method in class org.xwiki.extension.script.InstalledExtensionScriptService
 
getRepository() - Method in class org.xwiki.extension.script.LocalExtensionScriptService
 
getRepository() - Method in class org.xwiki.extension.script.RecommendedExtensionScriptService
 

I

ID - Static variable in class org.xwiki.extension.script.CoreExtensionScriptService
The identifier of the sub extension ScriptService.
ID - Static variable in class org.xwiki.extension.script.ExtensionHistoryScriptService
The identifier of the sub extension ScriptService.
ID - Static variable in class org.xwiki.extension.script.ExtensionRatingScriptService
The identifier of the sub extension ScriptService.
ID - Static variable in class org.xwiki.extension.script.InstalledExtensionScriptService
The identifier of the sub extension ScriptService.
ID - Static variable in class org.xwiki.extension.script.LocalExtensionScriptService
The identifier of the sub extension ScriptService.
install(String, String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Start the asynchronous installation process for an extension if the context document has programming rights.
install(InstallRequest) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Start the asynchronous installation process for an extension if the context document has programming rights.
InstalledExtensionScriptService - Class in org.xwiki.extension.script
Various script APIs related to installed extensions.
InstalledExtensionScriptService() - Constructor for class org.xwiki.extension.script.InstalledExtensionScriptService
 
installExtensionTypeOnRootNamespace(String) - Method in class org.xwiki.extension.script.ScriptExtensionRewriter
 
isAllowed(Collection<String>, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
 
isAllowed(Extension, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
 

J

jobExecutor - Variable in class org.xwiki.extension.script.AbstractExtensionScriptService
 

L

list(String, int) - Method in class org.xwiki.extension.script.ExtensionHistoryScriptService.ExtensionHistoryFilter
Lists the history records that match this filter and that are older than the specified offset record.
LocalExtensionScriptService - Class in org.xwiki.extension.script
Various script APIs related to installed extensions.
LocalExtensionScriptService() - Constructor for class org.xwiki.extension.script.LocalExtensionScriptService
 

N

newQuery(String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Create a new instance of a ExtensionQuery to be used in other APIs.

O

ofType(List<String>) - Method in class org.xwiki.extension.script.ExtensionHistoryScriptService.ExtensionHistoryFilter
Filters the history records with the specified job type.
org.xwiki.extension.script - package org.xwiki.extension.script
 

P

parseVersion(String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
 
parseVersionConstraint(String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
 
parseVersionRange(String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
 
PROPERTY_CALLERREFERENCE - Static variable in class org.xwiki.extension.script.AbstractExtensionScriptService
 
PROPERTY_CHECKRIGHTS - Static variable in class org.xwiki.extension.script.AbstractExtensionScriptService
 
PROPERTY_CONTEXT_ACTION - Static variable in class org.xwiki.extension.script.AbstractExtensionScriptService
Extension request property that specifies from which document action the job was started.
PROPERTY_CONTEXT_WIKI - Static variable in class org.xwiki.extension.script.AbstractExtensionScriptService
Extension request property that specifies from which wiki the job was started.
PROPERTY_USERREFERENCE - Static variable in class org.xwiki.extension.script.AbstractExtensionScriptService
 

R

read(InputStream) - Method in class org.xwiki.extension.script.ExtensionHistoryScriptService
Reads a list of history records from a given input stream (e.g.
RecommendedExtensionScriptService - Class in org.xwiki.extension.script
Various script APIs related to recommended extensions.
RecommendedExtensionScriptService() - Constructor for class org.xwiki.extension.script.RecommendedExtensionScriptService
 
replay(List<ExtensionJobHistoryRecord>) - Method in class org.xwiki.extension.script.ExtensionHistoryScriptService
Replay the given list of extension history records.
resolve(String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Get the extension handler corresponding to the given extension ID and version.
resolve(ExtensionDependency) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Deprecated.
since 5.3M1, use resolve(ExtensionDependency, String) instead
resolve(ExtensionDependency, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Search the provided extension as a dependency of another extension among all repositories including core and local repositories.
resolveVersions(String, int, int) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Return ordered (ascendent) versions for the provided extension id.
rewrite(Extension) - Method in class org.xwiki.extension.script.ScriptExtensionRewriter
 
ROLEHINT - Static variable in class org.xwiki.extension.script.ExtensionManagerScriptService
The role hint of this component.

S

safe(T) - Method in class org.xwiki.extension.script.AbstractExtensionScriptService
 
ScriptExtensionRewriter - Class in org.xwiki.extension.script
Script oriented helper with various ways of rewriting extensions.
ScriptExtensionRewriter() - Constructor for class org.xwiki.extension.script.ScriptExtensionRewriter
 
scriptProvider - Variable in class org.xwiki.extension.script.AbstractExtensionScriptService
 
search(String, int, int) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Search among all remote (those listed in xwiki.properties) Searchable repositories for extensions matching the search terms.
search(ExtensionQuery) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Search among all remote (those listed in xwiki.properties) AdvancedSearchable repositories for extensions matching the search query.
serialize(ExtensionJobHistoryRecord) - Method in class org.xwiki.extension.script.ExtensionHistoryScriptService
Serializes a history record.
setError(Exception) - Method in class org.xwiki.extension.script.AbstractExtensionScriptService
Store a caught exception in the context, so that it can be later retrieved using AbstractExtensionScriptService.getLastError().
setRightsProperties(T) - Method in class org.xwiki.extension.script.AbstractExtensionScriptService
 

T

toWikiId(String) - Method in class org.xwiki.extension.script.AbstractExtensionScriptService
 

U

uninstall(String, String) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Start the asynchronous uninstall process for an extension if the context document has programming rights.
uninstall(ExtensionId) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Start the asynchronous uninstall process for an extension if the context document has programming rights.
uninstall(UninstallRequest) - Method in class org.xwiki.extension.script.ExtensionManagerScriptService
Adds a new job to the job queue to perform the given uninstall request.

W

WIKI_NAMESPACE_PREFIX - Static variable in class org.xwiki.extension.script.AbstractExtensionScriptService
The prefix used for wiki namespace id.

X

xcontextProvider - Variable in class org.xwiki.extension.script.AbstractExtensionScriptService
 
A C D E F G I J L N O P R S T U W X 
Skip navigation links

Copyright © 2004–2017 XWiki. All rights reserved.