AbstractExtensionScriptService (XWiki Platform - Extension

java.lang.Object
- org.xwiki.extension.script.AbstractExtensionScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

Direct Known Subclasses:

CoreExtensionScriptService, ExtensionHistoryScriptService, ExtensionIndexScriptService, ExtensionManagerScriptService, ExtensionRatingScriptService, InstalledExtensionScriptService, LocalExtensionScriptService, RecommendedExtensionScriptService
```
public abstract class AbstractExtensionScriptService
extends Object
implements org.xwiki.script.service.ScriptService
```
Base class for all extension related script services.

Since:

5.3M1

Version:

$Id: 08c97b4cfe11f086228fbeba4c8af9f1c2f4ee26 $

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.xwiki.security.authorization.ContextualAuthorizationManager`	`authorization`
`protected org.xwiki.bridge.DocumentAccessBridge`	`documentAccessBridge` Needed for getting the current user reference.
`protected org.xwiki.context.Execution`	`execution` Provides access to the current context.
`static String`	`EXTENSIONERROR_KEY` The key under which the last encountered error is stored in the current execution context.
`protected org.xwiki.job.JobExecutor`	`jobExecutor`
`protected static String`	`PROPERTY_CALLERREFERENCE`
`protected static String`	`PROPERTY_CHECKRIGHTS`
`protected static String`	`PROPERTY_CONTEXT_ACTION` Extension request property that specifies from which document action the job was started.
`protected static String`	`PROPERTY_CONTEXT_WIKI` Extension request property that specifies from which wiki the job was started.
`protected static String`	`PROPERTY_USERREFERENCE`
`protected org.xwiki.script.internal.safe.ScriptSafeProvider`	`scriptProvider`
`protected static String`	`WIKI_NAMESPACE_PREFIX` The prefix used for wiki namespace id.
`protected javax.inject.Provider<XWikiContext>`	`xcontextProvider`

Constructor Summary

Constructors
Constructor and Description

AbstractExtensionScriptService()

Constructors
Constructor and Description
`AbstractExtensionScriptService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`contextualize(org.xwiki.job.AbstractRequest request)` Add to the job request various information about the current context.
`protected String`	`fromWikitoNamespace(String wiki)`
`protected XWikiDocument`	`getCallerDocument()`
`protected org.xwiki.job.event.status.JobStatus`	`getJobStatus(List<String> jobId)`
`Exception`	`getLastError()` Get the error generated while performing the previously called action.
`protected <S> S`	`safe(Object unsafe)`
`protected <R> R`	`safeWrapError(Callable<R> callable)` Call the passed callable but try/catch and return null in case of exception (and update the last error).
`protected void`	`setError(Exception e)` Store a caught exception in the context, so that it can be later retrieved using `getLastError()`.
`protected <T extends org.xwiki.job.AbstractRequest> void`	`setRightsProperties(T extensionRequest)`
`protected String`	`toWikiId(String namespace)`
`protected <R> R`	`wrapError(Callable<R> callable)` Call the passed callable but try/catch and return null in case of exception (and update the last error).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXTENSIONERROR_KEY
```
public static final String EXTENSIONERROR_KEY
```
    The key under which the last encountered error is stored in the current execution context.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CONTEXT_WIKI
```
protected static final String PROPERTY_CONTEXT_WIKI
```
    Extension request property that specifies from which wiki the job was started.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CONTEXT_ACTION
```
protected static final String PROPERTY_CONTEXT_ACTION
```
    Extension request property that specifies from which document action the job was started.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_USERREFERENCE
```
protected static final String PROPERTY_USERREFERENCE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_CALLERREFERENCE
```
protected static final String PROPERTY_CALLERREFERENCE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_CHECKRIGHTS
```
protected static final String PROPERTY_CHECKRIGHTS
```
    See Also:
    
    Constant Field Values
  - WIKI_NAMESPACE_PREFIX
```
protected static final String WIKI_NAMESPACE_PREFIX
```
    The prefix used for wiki namespace id.
    
    See Also:
    
    Constant Field Values
  - scriptProvider
```
@Inject
protected org.xwiki.script.internal.safe.ScriptSafeProvider scriptProvider
```
  - execution
```
@Inject
protected org.xwiki.context.Execution execution
```
    Provides access to the current context.
  - documentAccessBridge
```
@Inject
protected org.xwiki.bridge.DocumentAccessBridge documentAccessBridge
```
    Needed for getting the current user reference.
  - xcontextProvider
```
@Inject
protected javax.inject.Provider<XWikiContext> xcontextProvider
```
  - jobExecutor
```
@Inject
protected org.xwiki.job.JobExecutor jobExecutor
```
  - authorization
```
@Inject
protected org.xwiki.security.authorization.ContextualAuthorizationManager authorization
```
- Constructor Detail
  - AbstractExtensionScriptService
```
public AbstractExtensionScriptService()
```
- Method Detail
  - safe
```
protected <S> S safe(Object unsafe)
```
    Type Parameters:
    
    S - the type of the safe object version
    
    Parameters:
    
    unsafe - the unsafe object
    
    Returns:
    
    the safe version of the passed object
  - setRightsProperties
```
protected <T extends org.xwiki.job.AbstractRequest> void setRightsProperties(T extensionRequest)
```
  - getCallerDocument
```
protected XWikiDocument getCallerDocument()
```
  - getJobStatus
```
protected org.xwiki.job.event.status.JobStatus getJobStatus(List<String> jobId)
```
  - toWikiId
```
protected String toWikiId(String namespace)
```
    Parameters:
    
    namespace - the namespace
    
    Returns:
    
    the wiki identifier
    
    Since:
    
    8.1M1
  - fromWikitoNamespace
```
protected String fromWikitoNamespace(String wiki)
```
    Parameters:
    
    wiki - the wiki identifier
    
    Returns:
    
    the namespace
    
    Since:
    
    8.1M1
  - contextualize
```
public void contextualize(org.xwiki.job.AbstractRequest request)
```
    Add to the job request various information about the current context.
    
    Parameters:
    
    request - the job request
    
    Since:
    
    9.5
  - getLastError
```
public Exception getLastError()
```
    Get the error generated while performing the previously called action.
    
    Returns:
    
    an eventual exception or null if no exception was thrown
  - setError
```
protected void setError(Exception e)
```
    Store a caught exception in the context, so that it can be later retrieved using getLastError().
    
    Parameters:
    
    e - the exception to store, can be null to clear the previously stored exception
    
    See Also:
    
    getLastError()
  - wrapError
```
protected <R> R wrapError(Callable<R> callable)
```
    Call the passed callable but try/catch and return null in case of exception (and update the last error).
    
    Type Parameters:
    
    R - the result type of method call
    
    Parameters:
    
    callable - a task that returns a result and may throw an exception
    
    Returns:
    
    the computed result
    
    Since:
    
    11.10
  - safeWrapError
```
protected <R> R safeWrapError(Callable<R> callable)
```
    Call the passed callable but try/catch and return null in case of exception (and update the last error). A safe verison of the result is returned.
    
    Type Parameters:
    
    R - the result type of method call
    
    Parameters:
    
    callable - a task that returns a result and may throw an exception
    
    Returns:
    
    the safe version of the computed result
    
    Since:
    
    11.10

Class AbstractExtensionScriptService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTENSIONERROR_KEY

PROPERTY_CONTEXT_WIKI

PROPERTY_CONTEXT_ACTION

PROPERTY_USERREFERENCE

PROPERTY_CALLERREFERENCE

PROPERTY_CHECKRIGHTS

WIKI_NAMESPACE_PREFIX

scriptProvider

execution

documentAccessBridge

xcontextProvider

jobExecutor

authorization

Constructor Detail

AbstractExtensionScriptService

Method Detail

safe

setRightsProperties

getCallerDocument

getJobStatus

toWikiId

fromWikitoNamespace

contextualize

getLastError

setError

wrapError

safeWrapError