org.jboss.ejb.txtimer
Interface EJBTimerService

All Known Implementing Classes:

EJBTimerServiceLocator.MBeanDelegate (src)

public interface EJBTimerService

A service that implements this interface provides an Tx aware EJBTimerService.

Since:

07-Apr-2004

OBJECT_NAME

public static final ObjectName (src)  OBJECT_NAME

default object name

createTimerService

public TimerService (src)  createTimerService(ObjectName (src)  containerId,
                                       java.lang.Object pKey,
                                       Container (src)  container)
                                throws java.lang.IllegalStateException

Create a TimerService for a given TimedObjectId that lives in a JBoss Container. The TimedObjectInvoker is constructed from the invokerClassName.

Parameters:

containerId - The string identifier for a class of TimedObjects

pKey - The rimary key for an instance of a TimedObject, may be null

container - The Container that is associated with the TimerService

Returns:

the TimerService

Throws:

java.lang.IllegalStateException

createTimerService

public TimerService (src)  createTimerService(ObjectName (src)  containerId,
                                       java.lang.Object pKey,
                                       TimedObjectInvoker (src)  invoker)
                                throws java.lang.IllegalStateException

Create a TimerService for a given TimedObjectId that is invoked through the given invoker

Parameters:

containerId - The string identifier for a class of TimedObjects

pKey - The rimary key for an instance of a TimedObject, may be null

invoker - The TimedObjectInvoker

Returns:

the TimerService

Throws:

java.lang.IllegalStateException

getTimerService

public TimerService (src)  getTimerService(ObjectName (src)  containerId,
                                    java.lang.Object pKey)
                             throws java.lang.IllegalStateException

Get the TimerService for a given TimedObjectId

Parameters:

containerId - The string identifier for a class of TimedObjects

pKey - The rimary key for an instance of a TimedObject, may be null

Returns:

The TimerService, or null if it does not exist

Throws:

java.lang.IllegalStateException

retryTimeout

public void retryTimeout(ObjectName (src)  containerId,
                         java.lang.Object pKey,
                         Timer (src)  timer)

Invokes the ejbTimeout method a given TimedObjectId

Parameters:

containerId - The string identifier for a class of TimedObjects

pKey - The rimary key for an instance of a TimedObject, may be null

timer - the Timer that is passed to ejbTimeout

removeTimerService

public void removeTimerService(ObjectName (src)  containerId,
                               java.lang.Object pKey)
                        throws java.lang.IllegalStateException

Remove the TimerService for a given TimedObjectId

Parameters:

containerId - The string identifier for a class of TimedObjects

pKey - The rimary key for an instance of a TimedObject, may be null

Throws:

java.lang.IllegalStateException