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 inInstallJob
.- Since:
- 4.0M1
- Version:
- $Id: bf642ee1aa6d63ad16bac8754382882d70defc24 $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
PROPERTY_EXTENSION_FAIL_ON_EXIST
static String
PROPERTY_EXTENSION_PROPERTIES
-
Fields inherited from class org.xwiki.extension.job.AbstractExtensionRequest
PROPERTY_EXCLUDEDEXTENSIONS, PROPERTY_EXTENSIONS, 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
-
-
Constructor Summary
Constructors Constructor Description InstallRequest()
Default constructor.InstallRequest(org.xwiki.job.Request request)
-
Method Summary
All Methods Instance Methods Concrete Methods 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
addExcludedExtension, addExtension, addNamespace, getExcludedExtensions, getExtensions, getNamespaces, getRewriter, hasNamespaces, isRootModificationsAllowed, isUninstallAllowed, 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
-
-
-
-
Field Detail
-
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
-
-
Method Detail
-
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 namevalue
- 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)
-
-