Timer service commands

Information about EJB timers is specific to the application that the timers are created for, and the timers are not visible outside of that application. Therefore, when you manage EJB timers, use the application containing the enterprise bean and creates the EJB timer.

We can use the following commands during application development to provide basic EJB timer management functions. These commands are not available on client only installations.

findEJBTimers

This command displays information about existing persistent EJB timers, based on specified filter criteria.

This command displays information about existing persistent EJB timers, based on specified filter criteria. The syntax for this command is:

findEJBTimers server filter [options]
   filter: -all | -timer | -app [-mod [-bean ]]
           -all
           -timer timer id
           -app   application name
           -mod   module name
           -bean  bean name
   options: -host  host name
           -port  portnumber
           -conntype connector type
           -user  userid
           -password password
           -quiet
           -logfile filename
           -replacelog
           -trace
           -help

The following options exist:

server

Name of the server process where the EJB timers are located

-all

Specifies to find all EJB timers associated with the server process

timer id

Specifies the EJB Timer ID that uniquely identifies the timer

application name

Specifies to find all EJB timers associated with the application

module name

Specifies to find all EJB timers associated with the module

bean name

Specifies to find all EJB timers associated with the enterprise bean

host name

Host name of the server process

portnumber

Port of the server process

connector type

Type of connection. For example, SOAP, RMI, or NONE.

userid

User to use when connecting to the server process

password

Password to use when connecting to the server process

quiet

Specifies to disable output

logfile

Specifies to direct output to a file

replacelog

Specifies to clear the existing log before executing the command

trace

Specifies to enable trace

help

Specifies to provide command-specific help

If the server specified is configured to use a scheduler instance that is shared by multiple servers, then EJB timers created in any of the server processes might be found.

See the information about locating EJB timers using the findEJBTimers command.

cancelEJBTimers

This command cancels and removes from persistent storage EJB persistent timers based on the specified filter criteria.

The syntax for this command is:

cancelEJBTimers server filter [options]
   filter: -all | -timer | -app [-mod [-bean ]]
           -all
           -timer timer id
           -app   application name
           -mod   module name
           -bean  bean name
   options: -host  host name
           -port  portnumber
           -conntype connector type
           -user  userid
           -password password
           -quiet
           -logfile filename
           -replacelog
           -trace
           -help

the following options exist:

server

Name of the server process where the EJB timers are located

-all

Specifies to find all EJB timers associated with the server process

timer id

Specifies the EJB Timer ID that uniquely identifies the timer

application name

Specifies to find all EJB timers associated with the application

module name

Specifies to find all EJB timers associated with the module

bean name

Specifies to find all EJB timers associated with the enterprise bean

host name

Host name of the server process

portnumber

Port of the server process

connector type

Type of connection. For example, SOAP, RMI, or NONE.

userid

User to use when connecting to the server process

password

Password to use when connecting to the server process

quiet

Specifies to disable output

logfile

Specifies to direct output to a file

replacelog

Specifies to clear the existing log before executing the command

trace

Specifies to enable trace

help

Specifies to provide command-specific help

If the server specified is configured to use a scheduler instance that is shared by multiple servers, then EJB timers created in any of the server processes might be canceled.

For an example of the cancelEJBTimers command, see the topic CancelEJBTimers command example.

Subtopics

• findEJBTimers command
  The following examples illustrate how to use the findEJBTimers command to find EJB timers and explain the output statement. For relevant parameters and syntax information, read about the timer service commands.

• CancelEJBTimers command example
  The following examples illustrate how to use the command to cancel EJB timers.

• EJB command group
  The EJB command group for the AdminTask object provides commands that we can use to manipulate enterprise beans.

• Example: Use the Timer Service with the TimedObject interface
  This example shows the implementation of the ejbTimeout() method that is called when the scheduled event occurs.

Related tasks

Create timers using the EJB timer service for enterprise beans