Package org.xwiki.extension.job

Class InstallRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.extension.job.AbstractExtensionRequest

org.xwiki.extension.job.InstallRequest

All Implemented Interfaces:

Serializable, ExtensionRequest, org.xwiki.job.Request

public class InstallRequest
extends AbstractExtensionRequest

Request used in InstallJob.

Since:

4.0M1

Version:

$Id: bf642ee1aa6d63ad16bac8754382882d70defc24 $

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.xwiki.extension.job.AbstractExtensionRequest

AbstractExtensionRequest.ExtensionExtensionId

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_EXTENSION_FAIL_ON_EXIST
static final String	PROPERTY_EXTENSION_PROPERTIES

Fields inherited from class org.xwiki.extension.job.AbstractExtensionRequest

PROPERTY_COREEXTENSIONREPOSITORY, PROPERTY_EXCLUDEDEXTENSIONS, PROPERTY_EXTENSIONS, PROPERTY_INSTALLEDIGNORED, PROPERTY_NAMESPACES, PROPERTY_REWRITER, PROPERTY_ROOTMODIFICATIONSALLOWED, PROPERTY_UNINSTALLALLOWED

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_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Constructor	Description
InstallRequest()	Default constructor.
InstallRequest(org.xwiki.job.Request request)

Method Summary

Modifier and Type	Method	Description
void	addExtensionProperties(Map<String,Object> properties)	Sets custom extension properties to be set on each of the extensions that are going to be installed from this request.
Map<String,Object>	getExtensionProperties()
boolean	isFailOnExist()
Object	setExtensionProperty(String key, Object value)	Sets a custom extension property to be set on each of the extensions that are going to be installed from this request.
void	setFailOnExist(boolean failOnExist)

Methods inherited from class org.xwiki.extension.job.AbstractExtensionRequest

addCoreExtension, addExcludedExtension, addExtension, addExtension, addNamespace, getCoreExtensionRepository, getCoreExtensions, getExcludedExtensions, getExtensions, getNamespaces, getRewriter, hasNamespaces, isInstalledIgnored, isRootModificationsAllowed, isUninstallAllowed, setCoreExtensionRepository, setInstalledIgnored, setRewriter, setRootModificationsAllowed, setUninstallAllowed

Methods inherited from class org.xwiki.job.AbstractRequest

containsProperty, equals, getContext, getId, getProperties, getProperty, getProperty, getPropertyNames, hashCode, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, removeProperty, setContext, setId, setId, setId, setInteractive, setProperty, setRemote, setStatusLogIsolated, setStatusSerialized, setVerbose

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.job.Request

containsProperty, getContext, getId, getProperty, getProperty, getPropertyNames, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, setContext

Field Details

PROPERTY_EXTENSION_PROPERTIES

public static final String PROPERTY_EXTENSION_PROPERTIES

See Also:

• getExtensionProperties()
• Constant Field Values

PROPERTY_EXTENSION_FAIL_ON_EXIST

public static final String PROPERTY_EXTENSION_FAIL_ON_EXIST

See Also:

• isFailOnExist()
• Constant Field Values

Constructor Details

InstallRequest

public InstallRequest()

Default constructor.

InstallRequest

public InstallRequest(org.xwiki.job.Request request)

Parameters:

request - the request to copy

Method Details

isFailOnExist

public boolean isFailOnExist()

Returns:

whether or not the wiki creation should fail if the database already exists

Since:

14.5

setFailOnExist

public void setFailOnExist(boolean failOnExist)

Parameters:

failOnExist - whether or not the wiki creation should fail if the database already exists

Since:

14.5

getExtensionProperties

public Map<String,Object> getExtensionProperties()

Returns:

the custom extension properties to be set on each of the extensions that are going to be installed from this request

Since:

7.0M2

setExtensionProperty

public Object setExtensionProperty(String key,
 Object value)

Sets a custom extension property to be set on each of the extensions that are going to be installed from this request.

Parameters:

key - the property name

value - the new property value

Returns:

the previous property value

Since:

7.0M2

addExtensionProperties

public void addExtensionProperties(Map<String,Object> properties)

Sets custom extension properties to be set on each of the extensions that are going to be installed from this request.

Parameters:

properties - the properties to add to custom extension properties

Since:

9.5RC1

See Also:

• setExtensionProperty(String, Object)