EJBTimer

This type is a class for model objects.

@since 6.0.0

Package: ejbcontainer

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Reference attributes having this type:
  EJBContainer.timerSettings

Collection attributes having this type:
  EJBContainer.EJBTimer



Attributes Summary
datasourceAlias : EString The authentication data alias associated with the TimerService datasource. Note: since this attribute existed prior to 8.0, we must leave it as it was, with isUnsettable false and no default value. This is an exception to the EJBContainer rule that all attributes are unsettable and have default values.
tablePrefix : EString A character string that uniquely distinguishes the TimerService tables from other tables that may be present in the database used by the TimerService. This is useful if the customer specifies that the TimerService events should be stored in a database that already contains a number of tables. Note: since this attribute existed prior to 8.0, we must leave it as it was, with isUnsettable false and no default value. This is an exception to the EJBContainer rule that all attributes are unsettable and have default values.
pollInterval : ELong Specifies the interval, in seconds, at which the scheduler polls the database for expiring EJB timers.
numAlarmThreads : ELong The maximum number of Java threads to be used for executing EJBTimeout method calls.
schedulerJNDIName : EString The JNDI name of a Scheduler instance to use for managing and persisting EJB Timers. The value must be a valid JNDI name. Note: since this attribute existed prior to 8.0, we must leave it as it was, with isUnsettable false and no default value. This is an exception to the EJBContainer rule that all attributes are unsettable and have default values.
numNPTimerThreads : EInt @since 8.0 The maximum number of Java threads are allocated to the TimerManager constructed for non-persistent timers, if uniqueTimerManagerForNP is configured as true.
nonPersistentTimerRetryCount : EInt @since 8.0.0 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 at least once. This setting controls how many times the container attempts to retry. When the value is not set, the default value of -1 is used, meaning the container retries until the timer is successful. If the value is set to 0, the container does not retry the timer. Attention: Setting the value to 0 results in behavior not compliant with the EJB specification.
nonPersistentTimerRetryInterval : EInt @since 8.0.0. 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 happens 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, then the default interval is 300 seconds.
uniqueTimerManagerForNP : EBoolean @since 8.0.0 Indicates whether a separate TimerManager instance is used for non-persistent timers. true - indicates that a separate TimerManager for non-persistent timers will be constructed, using the configured numNPTimerThreads. false - indicates that non-persistent timers will use the configured Scheduler's AlarmManager, whose number of threads is determined by the WorkManager used by the Scheduler.
datasourceJNDIName : EString Specifies the JNDI name of the datasource that points to the TimerService database, where persistent EJB timers are stored. The value must be a valid JNDI name. Note: since this attribute existed prior to 8.0, we must leave it as it was, with isUnsettable false and no default value. This is an exception to the EJBContainer rule that all attributes are unsettable and have default values.



Attribute Details

datasourceAlias  -  The authentication data alias associated with the TimerService datasource. Note: since this attribute existed prior to 8.0, we must leave it as it was, with isUnsettable false and no default value. This is an exception to the EJBContainer rule that all attributes are unsettable and have default values.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

tablePrefix  -  A character string that uniquely distinguishes the TimerService tables from other tables that may be present in the database used by the TimerService. This is useful if the customer specifies that the TimerService events should be stored in a database that already contains a number of tables. Note: since this attribute existed prior to 8.0, we must leave it as it was, with isUnsettable false and no default value. This is an exception to the EJBContainer rule that all attributes are unsettable and have default values.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

pollInterval  -  Specifies the interval, in seconds, at which the scheduler polls the database for expiring EJB timers.
    Data Type: ELong
    Default value:  300
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

numAlarmThreads  -  The maximum number of Java threads to be used for executing EJBTimeout method calls.
    Data Type: ELong
    Default value:  1
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

schedulerJNDIName  -  The JNDI name of a Scheduler instance to use for managing and persisting EJB Timers. The value must be a valid JNDI name. Note: since this attribute existed prior to 8.0, we must leave it as it was, with isUnsettable false and no default value. This is an exception to the EJBContainer rule that all attributes are unsettable and have default values.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

numNPTimerThreads  -  @since 8.0 The maximum number of Java threads are allocated to the TimerManager constructed for non-persistent timers, if uniqueTimerManagerForNP is configured as true.
    Data Type: EInt
    Default value:  1
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

nonPersistentTimerRetryCount  -  @since 8.0.0 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 at least once. This setting controls how many times the container attempts to retry. When the value is not set, the default value of -1 is used, meaning the container retries until the timer is successful. If the value is set to 0, the container does not retry the timer. Attention: Setting the value to 0 results in behavior not compliant with the EJB specification.
    Data Type: EInt
    Default value:  -1
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

nonPersistentTimerRetryInterval  -  @since 8.0.0. 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 happens 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, then the default interval is 300 seconds.
    Data Type: EInt
    Default value:  300
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

uniqueTimerManagerForNP  -  @since 8.0.0 Indicates whether a separate TimerManager instance is used for non-persistent timers. true - indicates that a separate TimerManager for non-persistent timers will be constructed, using the configured numNPTimerThreads. false - indicates that non-persistent timers will use the configured Scheduler's AlarmManager, whose number of threads is determined by the WorkManager used by the Scheduler.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

datasourceJNDIName  -  Specifies the JNDI name of the datasource that points to the TimerService database, where persistent EJB timers are stored. The value must be a valid JNDI name. Note: since this attribute existed prior to 8.0, we must leave it as it was, with isUnsettable false and no default value. This is an exception to the EJBContainer rule that all attributes are unsettable and have default values.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false



(C) COPYRIGHT International Business Machines Corp. 1996-2006