org.xwiki.extension.job

Class AbstractExtensionRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.extension.job.AbstractExtensionRequest

All Implemented Interfaces:

Serializable, ExtensionRequest, Request

Direct Known Subclasses:

InstallRequest, UninstallRequest

public abstract class AbstractExtensionRequest
extends AbstractRequest
implements ExtensionRequest

Base class for extension manipulation related Request implementations.

Since:

4.0M1

Version:

$Id: 74df46022a213c34fbe1bbe62bd3a2fea598010b $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_EXCLUDEDEXTENSIONS
static String	PROPERTY_EXTENSIONS
static String	PROPERTY_NAMESPACES
static String	PROPERTY_ROOTMODIFICATIONSALLOWED

Fields inherited from interface org.xwiki.extension.job.ExtensionRequest

JOBID_ACTION_PREFIX, JOBID_PLAN_PREFIX, JOBID_PREFIX

Fields inherited from interface org.xwiki.job.Request

PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Constructor and Description
AbstractExtensionRequest() Default constructor.
AbstractExtensionRequest(Request request)

Method Summary

Modifier and Type	Method and Description
void	addExcludedExtension(ExtensionId extensionId)
void	addExtension(ExtensionId extensionId)
void	addNamespace(String namespace)
Collection<ExtensionId>	getExcludedExtensions()
Collection<ExtensionId>	getExtensions()
Collection<String>	getNamespaces()
ExtensionRewriter	getRewriter() Allow modifying manipulated Extensions on the fly (change allowed namespaces, dependencies, etc.).
boolean	hasNamespaces()
boolean	isRootModificationsAllowed()
void	setRewriter(ExtensionRewriter rewriter) Allow modifying manipulated Extensions on the fly (change allowed namespaces, dependencies, etc.).
void	setRootModificationsAllowed(boolean allowed)

Methods inherited from class org.xwiki.job.AbstractRequest

containsProperty, getId, getProperty, getProperty, getPropertyNames, isInteractive, isRemote, isVerbose, removeProperty, setId, setId, setId, setInteractive, setProperty, setRemote, setVerbose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xwiki.extension.job.ExtensionRequest

getJobId

Methods inherited from interface org.xwiki.job.Request

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

Field Detail

PROPERTY_EXTENSIONS

public static final String PROPERTY_EXTENSIONS

See Also:

getExtensions(), Constant Field Values

PROPERTY_EXCLUDEDEXTENSIONS

public static final String PROPERTY_EXCLUDEDEXTENSIONS

See Also:

getExtensions(), Constant Field Values

PROPERTY_NAMESPACES

public static final String PROPERTY_NAMESPACES

See Also:

getNamespaces(), Constant Field Values

PROPERTY_ROOTMODIFICATIONSALLOWED

public static final String PROPERTY_ROOTMODIFICATIONSALLOWED

See Also:

isRootModificationsAllowed(), Constant Field Values

Constructor Detail

AbstractExtensionRequest

public AbstractExtensionRequest()

Default constructor.

AbstractExtensionRequest

public AbstractExtensionRequest(Request request)

Parameters:

request - the request to copy

Method Detail

getExtensions

public Collection<ExtensionId> getExtensions()

Specified by:

getExtensions in interface ExtensionRequest

Returns:

the extension on which to apply the task.

getExcludedExtensions

public Collection<ExtensionId> getExcludedExtensions()

Returns:

extensions to not take into account

getNamespaces

public Collection<String> getNamespaces()

Specified by:

getNamespaces in interface ExtensionRequest

Returns:

the namespaces on which to apply the task.

hasNamespaces

public boolean hasNamespaces()

Specified by:

hasNamespaces in interface ExtensionRequest

Returns:

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

addExtension

public void addExtension(ExtensionId extensionId)

Parameters:

extensionId - the extension identifier

addExcludedExtension

public void addExcludedExtension(ExtensionId extensionId)

Parameters:

extensionId - the extension identifier

addNamespace

public void addNamespace(String namespace)

Parameters:

namespace - the namespace

isRootModificationsAllowed

public boolean isRootModificationsAllowed()

Specified by:

isRootModificationsAllowed in interface ExtensionRequest

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)

setRootModificationsAllowed

public void setRootModificationsAllowed(boolean allowed)

Parameters:

allowed - 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)

setRewriter

@Unstable
public void setRewriter(ExtensionRewriter rewriter)

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

Parameters:

rewriter - the filter

Since:

8.4.2, 9.0RC1

getRewriter

public ExtensionRewriter getRewriter()

Description copied from interface: ExtensionRequest

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

Specified by:

getRewriter in interface ExtensionRequest

Returns:

the filter