Package org.infinispan.tasks

Class TaskContext

java.lang.Object
org.infinispan.tasks.TaskContext
@ProtoTypeId(4804) 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 Details

    • TaskContext

      public TaskContext()

    • TaskContext

      public TaskContext(TaskContext other)

  • Method Details

    • cacheManager

      public TaskContext cacheManager(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(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 via Security.getSubject()

    • addParameter

      public TaskContext addParameter(String name, Object value)
      Adds a named parameter to the task context

    • addOptionalParameter

      public TaskContext addOptionalParameter(String name, Object value)
      Adds a named parameter to the task context only if it is non-null

    • logEvent

      public TaskContext logEvent(boolean logEvent)
      Whether execution will generate an event in the event log

    • remoteQueryAccess

      public TaskContext remoteQueryAccess(RemoteQueryAccess remoteQueryAccess)

    • getCacheManager

      public 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<Cache<?,?>> getCache()
      The default cache. Other caches can be obtained from cache manager (Cache.getCacheManager())
      Returns:
      optional cache

    • getParameters

      public Optional<Map<String,Object>> 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 optional Subject 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

    • getRemoteQueryAccess

      public Optional<RemoteQueryAccess> getRemoteQueryAccess()
      Provides the access to the remote queries even if the task is executed in the server JVM. This can be useful if the indexes are defined to support remote queries, and we want the access to the same indexed queries from the server tasks.
      Returns:
      the RemoteQueryAccess

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • subject

      @ProtoField(2) public Subject subject()