org.xwiki.job

Interface Request

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractRequest, DefaultRequest

public interface Request
extends Serializable

A Job request.

Since:

4.0M1

Version:

$Id: e904222a5e7d0f3185ace8720903a80790e8c63a $

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_CONTEXT
static String	PROPERTY_INTERACTIVE
static String	PROPERTY_REMOTE

Method Summary

Modifier and Type	Method and Description
boolean	containsProperty(String key)
default Map<String,Serializable>	getContext()
List<String>	getId()
<T> T	getProperty(String key)
<T> T	getProperty(String key, T def)
Collection<String>	getPropertyNames()
boolean	isInteractive()
boolean	isRemote()
default Boolean	isStatusLogIsolated()
default Boolean	isStatusSerialized()
boolean	isVerbose()
default void	setContext(Map<String,Serializable> context)

Field Detail

PROPERTY_REMOTE

static final String PROPERTY_REMOTE

See Also:

isRemote(), Constant Field Values

PROPERTY_INTERACTIVE

static final String PROPERTY_INTERACTIVE

See Also:

isInteractive(), Constant Field Values

PROPERTY_CONTEXT

static final String PROPERTY_CONTEXT

Since:

10.10RC1

See Also:

getContext(), Constant Field Values

Method Detail

getId

List<String> getId()

Returns:

list based identifier used to access the job. If none is provided the job will not be accessible by id and the status of the job will not be stored.

Since:

4.1M2

isRemote

boolean isRemote()

Returns:

indicate if the job has been triggered by a remote event

isInteractive

boolean isInteractive()

Returns:

indicate if the job is allowed to ask questions if it it should be fully automated (i.e. use default answers)

getProperty

<T> T getProperty(String key)

Type Parameters:

T - the type of the value

Parameters:

key - the name of the property

Returns:

the value of the property

getProperty

<T> T getProperty(String key,
                  T def)

Type Parameters:

T - the type of the value

Parameters:

key - the name of the property

def - the default value of the property

Returns:

the value of the property

getPropertyNames

Collection<String> getPropertyNames()

Returns:

the names of all the properties

containsProperty

boolean containsProperty(String key)

Parameters:

key - the name of the property

Returns:

true if this map contains a property for the specified key

Since:

4.2M2

isVerbose

boolean isVerbose()

Returns:

true if the job should log informations about what is going on

Since:

5.4RC1

isStatusSerialized

default Boolean isStatusSerialized()

Returns:

true if the job status should be serialized, null to fallback on JobStatus.isSerialized()

Since:

10.0

isStatusLogIsolated

default Boolean isStatusLogIsolated()

Returns:

true if the log should be isolated from standard output, null to fallbacl on JobStatus.isIsolated()

Since:

10.0

getContext

default Map<String,Serializable> getContext()

Returns:

the context to restore in the job thread

Since:

10.10RC1

setContext

default void setContext(Map<String,Serializable> context)

Parameters:

context - the context to restore in the job thread.

Since:

10.10RC1