org.infinispan.tasks

Interface Task

All Known Subinterfaces:

ServerTask<V>

public interface Task

Method Summary

Modifier and Type	Method and Description
default java.util.Optional<java.lang.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.
java.lang.String	getName() Provides a name for the task.
default java.util.Set<java.lang.String>	getParameters() The named parameters accepted by this task
java.lang.String	getType() Returns the type of task.

Method Detail

getName

java.lang.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 task.

Returns:

name of the server task

getType

java.lang.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 java.util.Set<java.lang.String> getParameters()

The named parameters accepted by this task

Returns:

a java.util.Set of parameter names

getAllowedRole

default java.util.Optional<java.lang.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