Annotation Type ManagedExecutorDefinition
-
@Repeatable(List.class) @Retention(RUNTIME) @Target(TYPE) public @interface ManagedExecutorDefinition
Defines a
ManagedExecutorService
to be registered in JNDI by the container under the JNDI name that is specified in thename()
attribute.Application components can refer to this JNDI name in the
lookup
attribute of aResource
annotation,@ManagedExecutorDefinition( name = "java:module/concurrent/MyExecutor", context = "java:module/concurrent/MyExecutorContext", hungTaskThreshold = 120000, maxAsync = 5) @ContextServiceDefinition( name = "java:module/concurrent/MyExecutorContext", propagated = { SECURITY, APPLICATION }) public class MyServlet extends HttpServlet { @Resource(lookup = "java:module/concurrent/MyExecutor", name = "java:module/concurrent/env/MyExecutorRef") ManagedExecutorService myExecutor;
Resource environment references in a deployment descriptor can similarly specify the
lookup-name
,<resource-env-ref> <resource-env-ref-name>java:module/env/concurrent/MyExecutorRef</resource-env-ref-name> <resource-env-ref-type>jakarta.enterprise.concurrent.ManagedExecutorService</resource-env-ref-type> <lookup-name>java:module/concurrent/MyExecutor</lookup-name> </resource-env-ref>
You can also define aManagedExecutorService
with the<managed-executor>
deployment descriptor element. For example,<managed-executor> <name>java:module/concurrent/MyExecutor</name> <context-service-ref>java:module/concurrent/MyExecutorContext</context-service-ref> <hung-task-threshold>120000</hung-task-threshold> <max-async>5</max-async> </managed-executor>
If amanaged-executor
andManagedExecutorDefinition
have the same name, their attributes are merged to define a singleManagedExecutorService
definition, with each attribute that is specified in themanaged-executor
deployment descriptor entry taking precedence over the corresponding attribute of the annotation.- Since:
- 3.0
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description String
name
JNDI name of theManagedExecutorService
instance.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String
context
The name of aContextService
instance which determines how context is applied to tasks and actions that run on this executor.long
hungTaskThreshold
The amount of time in milliseconds that a task or action can execute before it is considered hung.int
maxAsync
Upper bound on contextual tasks and actions that this executor will simultaneously execute asynchronously.
-
-
-
Element Detail
-
name
String name
JNDI name of theManagedExecutorService
instance. The JNDI name must be in a valid Jakarta EE namespace, such as,- java:comp
- java:module
- java:app
- java:global
- Returns:
ManagedExecutorService
JNDI name.
-
-
-
context
String context
The name of aContextService
instance which determines how context is applied to tasks and actions that run on this executor.The name can be the name of a
ContextServiceDefinition
or the name of acontext-service
deployment descriptor element or the JNDI name of the Jakarta EE defaultContextService
instance,java:comp/DefaultContextService
.The name of the
ContextService
must be no more granular than the name of thisManagedExecutorDefinition
. For example, if thisManagedExecutorDefinition
has a name injava:app
, theContextService
can be injava:app
orjava:global
, but not injava:module
which would be ambiguous as to which module'sContextService
definition should be used.The default value,
java:comp/DefaultContextService
, is the JNDI name of the Jakarta EE defaultContextService
.- Returns:
- name of the
ContextService
for capturing and propagating or clearing context.
- Default:
- "java:comp/DefaultContextService"
-
-
-
maxAsync
int maxAsync
Upper bound on contextual tasks and actions that this executor will simultaneously execute asynchronously. This constraint does not apply to tasks and actions that the executor runs inline, such as when a thread requests
CompletableFuture.join()
and the action runs inline if it has not yet started.The default value of
-1
indicates unbounded, although still subject to resource constraints of the system.- Returns:
- upper limit on asynchronous execution.
- Default:
- -1
-
-