EE4J 10.0.0 · jakarta.enterprise.concurrent.ManagedThreadFactoryDefinition

Defines a ManagedThreadFactory to be registered in JNDI by the container under the JNDI name that is specified in the name() attribute.

Application components can refer to this JNDI name in the lookup attribute of a jakarta.annotation.Resource annotation,

@ManagedThreadFactoryDefinition(
    name = "java:global/concurrent/MyThreadFactory",
    context = "java:global/concurrent/MyThreadFactoryContext",
    priority = 4)
@ContextServiceDefinition(
    name = "java:global/concurrent/MyThreadFactoryContext",
    propagated = APPLICATION)
 public class MyServlet extends HttpServlet {
   @Resource(lookup = "java:global/concurrent/MyThreadFactory",
              name = "java:module/concurrent/env/MyThreadFactoryRef")
    ManagedThreadFactory myThreadFactory;

Resource environment references in a deployment descriptor can similarly specify the lookup-name,

<resource-env-ref>
   <resource-env-ref-name>java:module/env/concurrent/MyThreadFactoryRef</resource-env-ref-name>
   <resource-env-ref-type>jakarta.enterprise.concurrent.ManagedThreadFactory</resource-env-ref-type>
   <lookup-name>java:global/concurrent/MyThreadFactory</lookup-name>
</resource-env-ref>

You can also define a ManagedThreadFactory with the <managed-thread-factory> deployment descriptor element. For example,

<managed-thread-factory>
   <name>java:global/concurrent/MyThreadFactory</name>
   <context-service-ref>java:global/concurrent/MyThreadFactoryContext</context-service-ref>
   <priority>4</priority>
</managed-thread-factory>

If a managed-thread-factory and ManagedThreadFactoryDefinition have the same name, their attributes are merged to define a single ManagedThreadFactory definition, with each attribute that is specified in the managed-thread-factory deployment descriptor entry taking precedence over the corresponding attribute of the annotation.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static @interface	ManagedThreadFactoryDefinition.List Enables multiple `ManagedThreadFactoryDefinition` annotations on the same type.

Method Summary

Modifier and Type	Method and Description
public String	Returns: instructions for capturing and propagating or clearing context. context() Determines how context is applied to threads from this thread factory.
public String	Returns: `ManagedThreadFactory` JNDI name. name() JNDI name of the `ManagedThreadFactory` instance.
public int	Returns: the priority for new threads. priority() Priority for threads created by this thread factory.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

context back to summary

context	back to summary
public String context() Determines how context is applied to threads from this thread factory. The name can be the name of a `ContextServiceDefinition` or the name of a `context-service` deployment descriptor element or the JNDI name of the Jakarta EE default `ContextService` instance, `java:comp/DefaultContextService`. The name of the `ContextService` must be no more granular than the name of this `ManagedThreadFactoryDefinition`. For example, if this `ManagedThreadFactoryDefinition` has a name in `java:app`, the `ContextService` can be in `java:app` or `java:global`, but not in `java:module` which would be ambiguous as to which module's `ContextService` definition should be used. The default value, `java:comp/DefaultContextService`, is the JNDI name of the Jakarta EE default `ContextService`. Returns:String instructions for capturing and propagating or clearing context.

public String context()

Determines how context is applied to threads from this thread factory.

The name can be the name of a ContextServiceDefinition or the name of a context-service deployment descriptor element or the JNDI name of the Jakarta EE default ContextService instance, java:comp/DefaultContextService.

The name of the ContextService must be no more granular than the name of this ManagedThreadFactoryDefinition. For example, if this ManagedThreadFactoryDefinition has a name in java:app, the ContextService can be in java:app or java:global, but not in java:module which would be ambiguous as to which module's ContextService definition should be used.

The default value, java:comp/DefaultContextService, is the JNDI name of the Jakarta EE default ContextService.

Returns:String: instructions for capturing and propagating or clearing context.

name back to summary

name	back to summary
public String name() JNDI name of the `ManagedThreadFactory` instance. The JNDI name must be in a valid Jakarta EE namespace, such as, java:comp java:module java:app java:global Returns:String `ManagedThreadFactory` JNDI name.

public String name()

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

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

Returns:String: ManagedThreadFactory JNDI name.

priority back to summary

priority	back to summary
public int priority() Priority for threads created by this thread factory. The default is `java.lang.Thread#NORM_PRIORITY`. Returns:int the priority for new threads.

public int priority()

Priority for threads created by this thread factory.

The default is java.lang.Thread#NORM_PRIORITY.

Returns:int: the priority for new threads.

public @Interface ManagedThreadFactoryDefinition

Nested and Inner Type Summary

Method Summary

Method Detail

public @Interface ManagedThreadFactoryDefinition.List

Method Summary

Method Detail