Field Detail

• ALL_REMAINING

  public static final java.lang.String ALL_REMAINING

  All available thread context types that are not specified elsewhere. This includes thread context types from custom ThreadContextProviders that are not specified elsewhere.

  For example, to define a ContextService that propagates SECURITY context, leaves TRANSACTION context alone, and clears every other context type:

   @ContextServiceDefinition(
       name = "java:module/concurrent/SecurityContext",
       propagated = SECURITY,
       unchanged = TRANSACTION,
       cleared = ALL_REMAINING)
   public class MyServlet extends HttpServlet ...
   

• APPLICATION

  public static final java.lang.String APPLICATION

  Context pertaining to the application component or module, including its Jakarta EE namespace (such as java:comp/env/) and thread context class loader.

  A cleared application context means that the thread is not associated with any application component and lacks access to the Jakarta EE namespace and thread context class loader of the application.

• SECURITY

  public static final java.lang.String SECURITY

  Context that controls the credentials that are associated with the thread, including the caller subject and invocation/RunAs subject.

  A cleared security context gives the thread unauthenticated subjects.

• TRANSACTION

  public static final java.lang.String TRANSACTION

  Context that controls the transaction that is associated with the thread.

  When cleared transaction context is applied to a thread, any global transaction that was previously present there is first suspended such that the contextual task or action can begin and manage, as permitted by the container, its own new UserTransaction. After the contextual task or action completes, the prior transaction is resumed on the thread. This is equivalent to the execution property, ManagedTask.TRANSACTION with a value of ManagedTask.SUSPEND.

  The execution property, ManagedTask.TRANSACTION, if specified, takes precedence over the behavior for transaction context that is specified on the resource definition annotations.

  Jakarta EE providers need not support the propagation of transactions to other threads and can reject resource definition annotations that include transaction as a propagated context.

Element Detail

• name

  public abstract java.lang.String name

  JNDI name of the ContextService instance being defined. The JNDI name must be in a valid Jakarta EE namespace, such as,

  • java:comp
  • java:module
  • java:app
  • java:global

  Returns:

  ContextService JNDI name.

• cleared

  public abstract java.lang.String[] cleared

  Types of context to clear whenever a thread runs the contextual task or action. The thread's previous context is restored afterward.

  Constants are provided on this class for the context types that are defined by the Jakarta EE Concurrency specification.

  Returns:

  context types to clear.

  Default:

  "Transaction"

• propagated

  public abstract java.lang.String[] propagated

  Types of context to capture from the requesting thread and propagate to a thread that runs the contextual task or action. The captured context is re-established when threads run the contextual task or action, with the respective thread's previous context being restored afterward.

  Constants are provided on this class for the context types that are defined by the Jakarta EE Concurrency specification.

  Returns:

  context types to capture and propagate.

  Default:

  "Remaining"

• unchanged

  public abstract java.lang.String[] unchanged

  Types of context that are left alone when a thread runs the contextual task or action.

  For example, with unchanged = TRANSACTION if a transaction is started after a function is contextualized, but before the function is run on the same thread, the transaction will be active in the contextual function:

  Consumer<String, Integer> updateDB = contextService.contextualConsumer(fn);
  
  // later, on another thread
  tx.begin();
  updateDB.accept("java:comp/env/jdbc/ds1");
  //...additional transactional work
  tx.commit();

  Constants are provided on this class for the context types that are defined by the Jakarta EE Concurrency specification.

  Returns:

  context types to leave unchanged.

  Default:

  {}