EJB Container (ejbContainer)

Defines the behavior of the EJB container.

Name Type Default Description

cacheCleanupInterval

A period of time with second precision

3s

The interval between passivating unused stateful session bean instances when the size is exceeded. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

cacheSize

int
Min: 1

2053

The number of stateful session bean instances that should be cached in memory.

poolCleanupInterval

A period of time with second precision

30s

The interval between removing unused bean instances. This setting only applies to stateless session and message-driven beans. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

startEJBsAtAppStart

boolean

Specifies when EJB types will be initialized. If this property is set to true, EJB types will be initialized at the time applications are first started. If this property is set to false, EJB types will be initialized at the time the EJB type is first used by an application. If this property is not set, the behavior is determined on a bean-by-bean basis from the start-at-app-start attribute in the ibm-ejb-jar-ext.xml file. This setting does not apply to either message-driven or startup singleton beans. Message-driven and startup singleton beans will always be initialized at the time applications are started.

asynchronous

Defines the behavior of EJB asynchronous methods.

Name Type Default Description

contextServiceRef

A reference to top level contextService element (string).

The context service used to manage context propagation to asynchronous EJB method threads.

maxUnclaimedRemoteResults

int
Min: 1

1000

The maximum number of unclaimed results that the server retains from all remote asynchronous method calls that return a Future object. If the maximum is exceeded, the server purges the result of the method call that completed the longest ago to prevent memory leakage.

unclaimedRemoteResultTimeout

A period of time with second precision

24h

The amount of time that the server retains the result for each remote asynchronous method call that returns a Future object. If an application does not claim the result within the specified period of time, the server purges the result of that method call to prevent memory leakage. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

asynchronous > contextService

The context service used to manage context propagation to asynchronous EJB method threads.

Name Type Default Description

jndiName

string

JNDI name

onError

  • FAIL

  • IGNORE

  • 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.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
IGNORE
Server will not issue any warning and error messages when it incurs a configuration error.
WARN
Server will issue warning and error messages when it incurs a configuration error.

Advanced Properties

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.

asynchronous > contextService > baseContext

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

Name Type Default Description

id

string

A unique configuration ID.

jndiName

string

JNDI name

onError

  • FAIL

  • IGNORE

  • 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.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
IGNORE
Server will not issue any warning and error messages when it incurs a configuration error.
WARN
Server will issue warning and error messages when it incurs a configuration error.

Advanced Properties

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.

asynchronous > contextService > baseContext > classloaderContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

asynchronous > contextService > baseContext > jeeMetadataContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

asynchronous > contextService > baseContext > securityContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

asynchronous > contextService > classloaderContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

asynchronous > contextService > jeeMetadataContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

asynchronous > contextService > securityContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService

Defines the behavior of the EJB timer service.

Name Type Default Description

lateTimerThreshold

A period of time with minute precision

5m

Number of minutes after the scheduled expiration of a timer that the start of the timer will be considered late. When a timer does start late, a warning message will be logged indicating that the timer has started later than scheduled. The default threshold is 5 minutes and a value of 0 minutes turns off the warning message feature. Specify a positive integer followed by a unit of time, which can be hours (h) or minutes (m). For example, specify 30 minutes as 30m. You can include multiple values in a single entry. For example, 1h30m is equivalent to 90 minutes.

missedPersistentTimerAction

  • ALL

  • ONCE

Specifies the action to perform when the expiration of an interval or schedule-based persistent timer is missed. One or more expirations of a persistent timer are classified as missed if the current expiration is scheduled before application server start or the next expiration is scheduled before the current time. The default action when failover of persistent timers is enabled is ONCE, otherwise the default action is ALL.
ALL
The timeout method is invoked immediately for all missed expirations. When multiple expirations are missed for the same timer, each invocation occurs synchronously until all missed expirations are processed, then the timer resumes with the next future expiration.
ONCE
The timeout method is invoked once immediately. All other missed expirations are skipped and the timer resumes with the next future expiration.

nonPersistentContextServiceRef

A reference to top level contextService element (string).

The context service is used to manage context propagation to non-persistent timer method threads.

nonPersistentMaxRetries

int
Min: -1

-1

When a non-persistent timer expires, the timeout callback method is called. This setting controls how many times the EJB container attempts to retry the timer. If the transaction for this callback method fails or is rolled back, the EJB container must retry the timer at least once. The default value is -1, which means the EJB container retries infinitely until the timer is successful. If the value is set to 0, the EJB container does not retry the timer, however, this results in behavior that is not compliant with the EJB specification.

nonPersistentRetryInterval

A period of time with second precision

300s

When a non-persistent timer expires, the timeout callback method is called. If the transaction for this callback method fails or is rolled back, the container must retry the timer. The first retry attempt occurs immediately, and subsequent retry attempts are delayed by the number of seconds specified. If the value is set to 0, then all retries occur immediately. If you do not specify a value, the default interval is 300 seconds. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

persistentExecutorRef

A reference to top level persistentExecutor element (string).

Schedules and runs EJB persistent timer tasks.

timerService > nonPersistentContextService

The context service is used to manage context propagation to non-persistent timer method threads.

Name Type Default Description

jndiName

string

JNDI name

onError

  • FAIL

  • IGNORE

  • 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.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
IGNORE
Server will not issue any warning and error messages when it incurs a configuration error.
WARN
Server will issue warning and error messages when it incurs a configuration error.

Advanced Properties

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.

timerService > nonPersistentContextService > baseContext

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

Name Type Default Description

id

string

A unique configuration ID.

jndiName

string

JNDI name

onError

  • FAIL

  • IGNORE

  • 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.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
IGNORE
Server will not issue any warning and error messages when it incurs a configuration error.
WARN
Server will issue warning and error messages when it incurs a configuration error.

Advanced Properties

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.

timerService > nonPersistentContextService > baseContext > classloaderContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > nonPersistentContextService > baseContext > jeeMetadataContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > nonPersistentContextService > baseContext > securityContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > nonPersistentContextService > classloaderContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > nonPersistentContextService > jeeMetadataContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > nonPersistentContextService > securityContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > persistentExecutor

Schedules and runs EJB persistent timer tasks.

Name Type Default Description

contextServiceRef

A reference to top level contextService element (string).

DefaultContextService

Configures how context is captured and propagated to threads.

enableTaskExecution

boolean

true

Determines whether or not this instance may run tasks.

initialPollDelay

A period of time with millisecond precision

0

Duration of time to wait before this instance might poll the persistent store for tasks to run. A value of -1 delays polling until it is started programmatically. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

missedTaskThreshold

A period of time with second precision

-1

The amount of time after the expected start of a task run to reserve for running the task. Other members are prevented from running the task before the expiration of this interval. If the interval elapses without the task running successfully, or the task rolls back, then the task run is considered missed, enabling another member to attempt to run it. Missed task threshold values within the supported range of 100 seconds to 9000 seconds (2.5 hours) enable failover. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

pollInterval

A period of time with millisecond precision

Interval at which the executor looks for tasks in the persistent store to run. If unspecified and fail over is enabled, a poll interval is automatically computed. If fail over is not enabled, the default is -1, which disables all polling after the initial poll. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

pollSize

int
Min: 1

The maximum number of task entries to find when polling the persistent store for tasks to run. If unspecified, there is no limit.

retryInterval

A period of time with millisecond precision

The amount of time that must pass between consecutive retries of a failed task. The retry interval applies only when failover is disabled. When failover is enabled, servers retry at their next poll. When failover is not enabled, the first retry occurs immediately on the same server, and at the retry interval thereafter. The default retry interval is 1 minute. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

retryLimit

short
Min: -1
Max: 10000

10

Limit of consecutive retries for a task that has failed or rolled back, after which the task is considered permanently failed and does not attempt further retries. A value of -1 allows for unlimited retries.

taskStoreRef

A reference to top level databaseStore element (string).

defaultDatabaseStore

Persistent store for scheduled tasks.

timerService > persistentExecutor > contextService

Configures how context is captured and propagated to threads.

Name Type Default Description

jndiName

string

JNDI name

onError

  • FAIL

  • IGNORE

  • 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.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
IGNORE
Server will not issue any warning and error messages when it incurs a configuration error.
WARN
Server will issue warning and error messages when it incurs a configuration error.

Advanced Properties

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.

timerService > persistentExecutor > contextService > baseContext

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

Name Type Default Description

id

string

A unique configuration ID.

jndiName

string

JNDI name

onError

  • FAIL

  • IGNORE

  • 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.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
IGNORE
Server will not issue any warning and error messages when it incurs a configuration error.
WARN
Server will issue warning and error messages when it incurs a configuration error.

Advanced Properties

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.

timerService > persistentExecutor > contextService > baseContext > classloaderContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > persistentExecutor > contextService > baseContext > jeeMetadataContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > persistentExecutor > contextService > baseContext > securityContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > persistentExecutor > contextService > classloaderContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > persistentExecutor > contextService > jeeMetadataContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.

timerService > persistentExecutor > contextService > securityContext

A unique configuration ID.

Name Type Default Description

id

string

A unique configuration ID.