org.infinispan.tasks

Interface ServerTask<V>

All Superinterfaces:

Callable<V>

public interface ServerTask<V>
extends Callable<V>

An interface for deployed server tasks. In order to deploy a custom ServerTask, deploy a module containing a service that implements this interface. The task will be accessible by the name returned by getName() Before the execution, TaskContext is injected into the task to provide Cache, Marshaller and parameters.

Author: Michal Szynkiewicz, michal.l.szynkiewicz@gmail.com Date: 1/19/16 Time: 2:18 PM

Method Summary

Modifier and Type	Method and 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
void	setTaskContext(TaskContext taskContext) Sets the task context Store the value in your task implementation to be able to access caches and other resources in the task

Methods inherited from interface java.util.concurrent.Callable

call

Method Detail

setTaskContext

void setTaskContext(TaskContext taskContext)

Sets the task context Store the value in your task implementation to be able to access caches and other resources in the task

Parameters:

taskContext - task execution context

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

Returns:

name of the server task

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,

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

getParameters

default Set<String> getParameters()

The named parameters accepted by this task

Returns:

a java.util.Set of parameter names