Package org.infinispan.tasks
Class TaskContext
- java.lang.Object
-
- org.infinispan.tasks.TaskContext
-
public class TaskContext extends Object
TaskContext. Defines the execution context of a task by specifying parameters, cache and marshaller- Since:
- 8.1
- Author:
- Tristan Tarrant
-
-
Constructor Summary
Constructors Constructor Description TaskContext()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TaskContext
addParameter(String name, Object value)
Adds a named parameter to the task contextTaskContext
cache(org.infinispan.Cache<?,?> cache)
The cache against which this task will be executed.TaskContext
cacheManager(org.infinispan.manager.EmbeddedCacheManager cacheManager)
The cache manager with which this task should be executedOptional<org.infinispan.Cache<?,?>>
getCache()
The default cache.org.infinispan.manager.EmbeddedCacheManager
getCacheManager()
CacheManager for this task executionOptional<Marshaller>
getMarshaller()
Marshaller for this task executionOptional<Map<String,?>>
getParameters()
Gets a map of named parameters for the taskOptional<Subject>
getSubject()
The optionalSubject
which is executing this taskboolean
isLogEvent()
Whether executing this task will generate an event in the event logTaskContext
logEvent(boolean logEvent)
Whether execution will generate an event in the event logTaskContext
marshaller(Marshaller marshaller)
The marshaller with which this task should be executedTaskContext
parameters(Map<String,?> parameters)
A map of named parameters that will be passed to the task.TaskContext
subject(Subject subject)
The subject to impersonate when running this task.String
toString()
-
-
-
Method Detail
-
cacheManager
public TaskContext cacheManager(org.infinispan.manager.EmbeddedCacheManager cacheManager)
The cache manager with which this task should be executed
-
marshaller
public TaskContext marshaller(Marshaller marshaller)
The marshaller with which this task should be executed
-
cache
public TaskContext cache(org.infinispan.Cache<?,?> cache)
The cache against which this task will be executed. This will be the task's default cache, but other caches can be obtained from the cache manager
-
parameters
public TaskContext parameters(Map<String,?> parameters)
A map of named parameters that will be passed to the task. Invoking this method overwrites any previously set parameters
-
subject
public TaskContext subject(Subject subject)
The subject to impersonate when running this task. If unspecified, the Subject (if any) will be retrieved viaSecurity.getSubject()
-
addParameter
public TaskContext addParameter(String name, Object value)
Adds a named parameter to the task context
-
logEvent
public TaskContext logEvent(boolean logEvent)
Whether execution will generate an event in the event log
-
getCacheManager
public org.infinispan.manager.EmbeddedCacheManager getCacheManager()
CacheManager for this task execution- Returns:
- the cache manager
-
getMarshaller
public Optional<Marshaller> getMarshaller()
Marshaller for this task execution- Returns:
- optional marshaller
-
getCache
public Optional<org.infinispan.Cache<?,?>> getCache()
The default cache. Other caches can be obtained from cache manager (Cache.getCacheManager()
)- Returns:
- optional cache
-
getParameters
public Optional<Map<String,?>> getParameters()
Gets a map of named parameters for the task- Returns:
- optional map of named parameters for the task
-
getSubject
public Optional<Subject> getSubject()
The optionalSubject
which is executing this task- Returns:
- the
Subject
-
isLogEvent
public boolean isLogEvent()
Whether executing this task will generate an event in the event log- Returns:
- true if an event will be logged, false otherwise
-
-