org.xwiki.extension.job

Interface ExtensionRequest

All Superinterfaces:

Request, Serializable

All Known Implementing Classes:

AbstractExtensionRequest, InstallRequest, UninstallRequest

public interface ExtensionRequest
extends Request

Extension manipulation related Request.

Since:

4.0M1

Version:

$Id: b22e5d403060bb91e548438ddb49b09c0c04dc9c $

Field Summary

Fields

Modifier and Type	Field and Description
static String	JOBID_ACTION_PREFIX The prefix put behind all job ids which are actual actions.
static String	JOBID_PLAN_PREFIX The prefix put behind all job ids which are information gathering.
static String	JOBID_PREFIX The prefix put behind all job ids.

Fields inherited from interface org.xwiki.job.Request

PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Method Summary

Modifier and Type	Method and Description
Collection<ExtensionId>	getExtensions()
static List<String>	getJobId(String prefix, String extensionId, String namespace)
Collection<String>	getNamespaces()
default ExtensionRewriter	getRewriter() Allow modifying manipulated Extensions on the fly (change allowed namespaces, dependencies, etc.).
boolean	hasNamespaces()
default boolean	isRootModificationsAllowed()

Methods inherited from interface org.xwiki.job.Request

containsProperty, getId, getProperty, getProperty, getPropertyNames, isInteractive, isRemote, isVerbose

Field Detail

JOBID_PREFIX

static final String JOBID_PREFIX

The prefix put behind all job ids.

Since:

8.2RC1

See Also:

Constant Field Values

JOBID_ACTION_PREFIX

static final String JOBID_ACTION_PREFIX

The prefix put behind all job ids which are actual actions.

Since:

8.2RC1

See Also:

Constant Field Values

JOBID_PLAN_PREFIX

static final String JOBID_PLAN_PREFIX

The prefix put behind all job ids which are information gathering.

Since:

8.2RC1

See Also:

Constant Field Values

Method Detail

getJobId

static List<String> getJobId(String prefix,
                             String extensionId,
                             String namespace)

Parameters:

prefix - the prefix, usually JOBID_ACTION_PREFIX or JOBID_PLAN_PREFIX

extensionId - the id of the extension for which to create a job id

namespace - the namespace for which to create a job id

Returns:

the job id

Since:

8.2RC1

getExtensions

Collection<ExtensionId> getExtensions()

Returns:

the extension on which to apply the task.

getNamespaces

Collection<String> getNamespaces()

Returns:

the namespaces on which to apply the task.

hasNamespaces

boolean hasNamespaces()

Returns:

indicate if the request is applied on specific namespace or all of them

isRootModificationsAllowed

default boolean isRootModificationsAllowed()

Returns:

indicate if it's allowed to do modifications on root namespace during the job execution (not taken into account if the target of the request is root namespace)

Since:

8.1M1

getRewriter

@Unstable
default ExtensionRewriter getRewriter()

Allow modifying manipulated Extensions on the fly (change allowed namespaces, dependencies, etc.).

Returns:

the filter

Since:

8.4.2, 9.0RC1