Task (Infinispan JavaDoc 13.0.10.Final-redhat-00001 API)

All Superinterfaces:

org.infinispan.commons.dataconversion.internal.JsonSerialization

All Known Subinterfaces:

ServerTask<V>
```
public interface Task
extends org.infinispan.commons.dataconversion.internal.JsonSerialization
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default Optional<String>`	`getAllowedRole()`	An optional role, for which the task is accessible.
`default TaskExecutionMode`	`getExecutionMode()`	Provides info whether the task execution should be local - on one node or distributed - on all nodes.
`String`	`getName()`	Provides a name for the task.
`default Set<String>`	`getParameters()`	The named parameters accepted by this task
`String`	`getType()`	Returns the type of task.
`default org.infinispan.commons.dataconversion.internal.Json`	`toJson()`

- Method Detail
  - getName
```
String getName()
```
    Provides a name for the task. This is the name by which the task will be executed. Make sure the name is unique for each task.
    
    Returns:
    
    name of the task
  - getType
```
String getType()
```
    Returns the type of task. This is dependent on the specific implementation.
  - getExecutionMode
```
default TaskExecutionMode getExecutionMode()
```
    Provides info whether the task execution should be local - on one node or distributed - on all nodes. ONE_NODE execution is the default.
    
    Returns:
    
    TaskExecutionMode.ONE_NODE for single node execution, TaskExecutionMode.ALL_NODES for distributed execution,
  - getParameters
```
default Set<String> getParameters()
```
    The named parameters accepted by this task
    
    Returns:
    
    a java.util.Set of parameter names
  - getAllowedRole
```
default Optional<String> getAllowedRole()
```
    An optional role, for which the task is accessible. If the task executor has the role in the set, the task will be executed. If the role is not provided - all users can invoke the task
    
    Returns:
    
    a user role, for which the task can be executed
  - toJson
```
default org.infinispan.commons.dataconversion.internal.Json toJson()
```