Concurrency Utilities for Java EE 1.0

This feature enables the creation of managed executors that allow applications to submit tasks to run concurrently, with thread context managed by the application server.It also enables the creation of managed thread factories to create threads that run with the threadcontext of the component that looks up the managed thread factory.

Enable this feature

To enable the Concurrency Utilities for Java EE 1.0 feature, add the following element declaration inside the featureManager element in the server.xml file:

<feature>concurrent-1.0</feature>

Developing a feature that depends on this feature

If we are developing a feature that depends on the Concurrency Utilities for Java EE 1.0 feature, include the following item in the Subsystem-Content header in the feature manifest file for the new feature:

com.ibm.websphere.appserver.concurrent-1.0; type="osgi.subsystem.feature"

API packages provided by this feature

• javax.enterprise.concurrent

Feature configuration elements

We can use the following elements in the server.xml file to configure the Concurrency Utilities for Java EE 1.0 feature:

• classloading

• contextService

  • baseContext

    • baseContext

    • classloaderContext

    • jeeMetadataContext

    • securityContext

    • syncToOSThreadContext

    • zosWLMContext

  • classloaderContext

  • jeeMetadataContext

  • securityContext

  • syncToOSThreadContext

  • zosWLMContext

• managedExecutorService

  • contextService

    • baseContext

    • classloaderContext

    • jeeMetadataContext

    • securityContext

    • syncToOSThreadContext

    • zosWLMContext

• managedScheduledExecutorService

  • contextService

    • baseContext

    • classloaderContext

    • jeeMetadataContext

    • securityContext

    • syncToOSThreadContext

    • zosWLMContext

• managedThreadFactory

  • contextService

    • baseContext

    • classloaderContext

    • jeeMetadataContext

    • securityContext

    • syncToOSThreadContext

    • zosWLMContext

classloading

Global classloading

Attribute name	Data type	Default value	Description
useJarUrls	boolean	false	Whether to use jar: or wsjar: URLs for referencing files in archives

contextService

Configures how context is propagated to threads

Attribute name	Data type	Default value	Description
baseContextRef	A reference to top level contextService element (string).		Specifies a base context service from which to inherit context that is not already defined on this context service.
id	string		A unique configuration ID.
jndiName	string		JNDI name
onError	IGNORE FAIL WARN	WARN	Determines the action to take in response to configuration errors. For example, if securityContext is configured for this contextService, but the security feature is not enabled, then onError determines whether to fail, raise a warning, or ignore the parts of the configuration which are incorrect. IGNORE Server will not issue any warning and error messages when it incurs a configuration error. FAIL Server will issue a warning or error message on the first error occurrence and then stop the server. WARN Server will issue warning and error messages when it incurs a configuration error.

contextService > baseContext

Description: Specifies a base context service from which to inherit context that is not already defined on this context service.

Required: false

Data type:

Attribute name	Data type	Default value	Description
baseContextRef	A reference to top level contextService element (string).		Specifies a base context service from which to inherit context that is not already defined on this context service.
jndiName	string		JNDI name
onError	IGNORE FAIL WARN	WARN	Determines the action to take in response to configuration errors. For example, if securityContext is configured for this contextService, but the security feature is not enabled, then onError determines whether to fail, raise a warning, or ignore the parts of the configuration which are incorrect. IGNORE Server will not issue any warning and error messages when it incurs a configuration error. FAIL Server will issue a warning or error message on the first error occurrence and then stop the server. WARN Server will issue warning and error messages when it incurs a configuration error.

contextService > baseContext > baseContext

Description: Specifies a base context service from which to inherit context that is not already defined on this context service.

Required: false

Data type: com.ibm.ws.context.service

contextService > baseContext > classloaderContext

Description: Classloader context propagation configuration.

Required: false

Data type:

contextService > baseContext > jeeMetadataContext

Description: Makes the namespace of the application component that submits a contextual task available to the task.

Required: false

Data type:

contextService > baseContext > securityContext

Description: When specified, the security context of the work initiator is propagated to the unit of work.

Required: false

Data type:

contextService > baseContext > syncToOSThreadContext

Description: When specified, the identity of the runAs Subject for the unit of work is synchronized with the Operating System identity.

Required: false

Data type:

contextService > baseContext > zosWLMContext

Description: Indicates that the z/OS WLM Context should be managed as part of the thread context.

Required: false

Data type:

Attribute name	Data type	Default value	Description
daemonTransactionClass	string	ASYNCDMN	The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work.
defaultTransactionClass	string	ASYNCBN	The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work.
wlm	Propagate PropagateOrNew New	Propagate	Indicates how the WLM context should be handled for non-Daemon work. Propagate Use the same WLM Context (if one exists). PropagateOrNew Use the same WLM context or create a new one if no current context exists. New Always create a new WLM context.

contextService > classloaderContext

Description: Classloader context propagation configuration.

Required: false

Data type:

contextService > jeeMetadataContext

Description: Makes the namespace of the application component that submits a contextual task available to the task.

Required: false

Data type:

contextService > securityContext

Description: When specified, the security context of the work initiator is propagated to the unit of work.

Required: false

Data type:

contextService > syncToOSThreadContext

Description: When specified, the identity of the runAs Subject for the unit of work is synchronized with the Operating System identity.

Required: false

Data type:

contextService > zosWLMContext

Description: Indicates that the z/OS WLM Context should be managed as part of the thread context.

Required: false

Data type:

Attribute name	Data type	Default value	Description
daemonTransactionClass	string	ASYNCDMN	The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work.
defaultTransactionClass	string	ASYNCBN	The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work.
wlm	Propagate PropagateOrNew New	Propagate	Indicates how the WLM context should be handled for non-Daemon work. Propagate Use the same WLM Context (if one exists). PropagateOrNew Use the same WLM context or create a new one if no current context exists. New Always create a new WLM context.

managedExecutorService

Managed executor service

Attribute name	Data type	Default value	Description
contextServiceRef	A reference to top level contextService element (string).	DefaultContextService	Configures how context is propagated to threads
id	string		A unique configuration ID.
jndiName	string		JNDI name

managedExecutorService > contextService

Description: Configures how context is propagated to threads

Required: false

Data type:

Attribute name	Data type	Default value	Description
baseContextRef	A reference to top level contextService element (string).		Specifies a base context service from which to inherit context that is not already defined on this context service.
jndiName	string		JNDI name
onError	IGNORE FAIL WARN	WARN	Determines the action to take in response to configuration errors. For example, if securityContext is configured for this contextService, but the security feature is not enabled, then onError determines whether to fail, raise a warning, or ignore the parts of the configuration which are incorrect. IGNORE Server will not issue any warning and error messages when it incurs a configuration error. FAIL Server will issue a warning or error message on the first error occurrence and then stop the server. WARN Server will issue warning and error messages when it incurs a configuration error.

managedExecutorService > contextService > baseContext

Description: Specifies a base context service from which to inherit context that is not already defined on this context service.

Required: false

Data type: com.ibm.ws.context.service

managedExecutorService > contextService > classloaderContext

Description: Classloader context propagation configuration.

Required: false

Data type:

managedExecutorService > contextService > jeeMetadataContext

Description: Makes the namespace of the application component that submits a contextual task available to the task.

Required: false

Data type:

managedExecutorService > contextService > securityContext

Description: When specified, the security context of the work initiator is propagated to the unit of work.

Required: false

Data type:

managedExecutorService > contextService > syncToOSThreadContext

Description: When specified, the identity of the runAs Subject for the unit of work is synchronized with the Operating System identity.

Required: false

Data type:

managedExecutorService > contextService > zosWLMContext

Description: Indicates that the z/OS WLM Context should be managed as part of the thread context.

Required: false

Data type:

Attribute name	Data type	Default value	Description
daemonTransactionClass	string	ASYNCDMN	The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work.
defaultTransactionClass	string	ASYNCBN	The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work.
wlm	Propagate PropagateOrNew New	Propagate	Indicates how the WLM context should be handled for non-Daemon work. Propagate Use the same WLM Context (if one exists). PropagateOrNew Use the same WLM context or create a new one if no current context exists. New Always create a new WLM context.

managedScheduledExecutorService

Managed scheduled executor service

Attribute name	Data type	Default value	Description
contextServiceRef	A reference to top level contextService element (string).	DefaultContextService	Configures how context is propagated to threads
id	string		A unique configuration ID.
jndiName	string		JNDI name

managedScheduledExecutorService > contextService

Description: Configures how context is propagated to threads

Required: false

Data type:

Attribute name	Data type	Default value	Description
baseContextRef	A reference to top level contextService element (string).		Specifies a base context service from which to inherit context that is not already defined on this context service.
jndiName	string		JNDI name
onError	IGNORE FAIL WARN	WARN	Determines the action to take in response to configuration errors. For example, if securityContext is configured for this contextService, but the security feature is not enabled, then onError determines whether to fail, raise a warning, or ignore the parts of the configuration which are incorrect. IGNORE Server will not issue any warning and error messages when it incurs a configuration error. FAIL Server will issue a warning or error message on the first error occurrence and then stop the server. WARN Server will issue warning and error messages when it incurs a configuration error.

managedScheduledExecutorService > contextService > baseContext

Description: Specifies a base context service from which to inherit context that is not already defined on this context service.

Required: false

Data type: com.ibm.ws.context.service

managedScheduledExecutorService > contextService > classloaderContext

Description: Classloader context propagation configuration.

Required: false

Data type:

managedScheduledExecutorService > contextService > jeeMetadataContext

Description: Makes the namespace of the application component that submits a contextual task available to the task.

Required: false

Data type:

managedScheduledExecutorService > contextService > securityContext

Description: When specified, the security context of the work initiator is propagated to the unit of work.

Required: false

Data type:

managedScheduledExecutorService > contextService > syncToOSThreadContext

Description: When specified, the identity of the runAs Subject for the unit of work is synchronized with the Operating System identity.

Required: false

Data type:

managedScheduledExecutorService > contextService > zosWLMContext

Description: Indicates that the z/OS WLM Context should be managed as part of the thread context.

Required: false

Data type:

Attribute name	Data type	Default value	Description
daemonTransactionClass	string	ASYNCDMN	The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work.
defaultTransactionClass	string	ASYNCBN	The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work.
wlm	Propagate PropagateOrNew New	Propagate	Indicates how the WLM context should be handled for non-Daemon work. Propagate Use the same WLM Context (if one exists). PropagateOrNew Use the same WLM context or create a new one if no current context exists. New Always create a new WLM context.

managedThreadFactory

Managed thread factory

Attribute name	Data type	Default value	Description
contextServiceRef	A reference to top level contextService element (string).	DefaultContextService	Configures how context is propagated to threads
createDaemonThreads	boolean	false	Configures whether or not threads created by the managed thread factory should be daemon threads.
defaultPriority	int Minimum: 1 Maximum: 10		Default priority for threads created by the managed thread factory. If unspecified, the priority of the creating thread is used. Priority cannot exceed the maximum priority for the managed thread factory, in which case the maximum priority is used instead.
id	string		A unique configuration ID.
jndiName	string		JNDI name
maxPriority	int Minimum: 1 Maximum: 10		Maximum priority for threads created by the managed thread factory.

managedThreadFactory > contextService

Description: Configures how context is propagated to threads

Required: false

Data type:

Attribute name	Data type	Default value	Description
baseContextRef	A reference to top level contextService element (string).		Specifies a base context service from which to inherit context that is not already defined on this context service.
jndiName	string		JNDI name
onError	IGNORE FAIL WARN	WARN	Determines the action to take in response to configuration errors. For example, if securityContext is configured for this contextService, but the security feature is not enabled, then onError determines whether to fail, raise a warning, or ignore the parts of the configuration which are incorrect. IGNORE Server will not issue any warning and error messages when it incurs a configuration error. FAIL Server will issue a warning or error message on the first error occurrence and then stop the server. WARN Server will issue warning and error messages when it incurs a configuration error.

managedThreadFactory > contextService > baseContext

Description: Specifies a base context service from which to inherit context that is not already defined on this context service.

Required: false

Data type: com.ibm.ws.context.service

managedThreadFactory > contextService > classloaderContext

Description: Classloader context propagation configuration.

Required: false

Data type:

managedThreadFactory > contextService > jeeMetadataContext

Description: Makes the namespace of the application component that submits a contextual task available to the task.

Required: false

Data type:

managedThreadFactory > contextService > securityContext

Description: When specified, the security context of the work initiator is propagated to the unit of work.

Required: false

Data type:

managedThreadFactory > contextService > syncToOSThreadContext

Description: When specified, the identity of the runAs Subject for the unit of work is synchronized with the Operating System identity.

Required: false

Data type:

managedThreadFactory > contextService > zosWLMContext

Description: Indicates that the z/OS WLM Context should be managed as part of the thread context.

Required: false

Data type:

Attribute name	Data type	Default value	Description
daemonTransactionClass	string	ASYNCDMN	The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work.
defaultTransactionClass	string	ASYNCBN	The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work.
wlm	Propagate PropagateOrNew New	Propagate	Indicates how the WLM context should be handled for non-Daemon work. Propagate Use the same WLM Context (if one exists). PropagateOrNew Use the same WLM context or create a new one if no current context exists. New Always create a new WLM context.