org.jboss.as.ejb3.timerservice.spi

Interface TimedObjectInvoker

All Known Implementing Classes:

TimedObjectInvokerImpl

public interface TimedObjectInvoker

An implementation can invoke the ejbTimeout method on a TimedObject.

The TimedObjectInvoker has knowledge of the TimedObjectId, it knows which object to invoke.

Author:

Thomas.Diesler@jboss.org, Carlo de Wolf

Method Summary

Modifier and Type	Method and Description
void	callTimeout(TimerImpl timer) Invokes the ejbTimeout method on the TimedObject with the given id.
void	callTimeout(TimerImpl timer, Method timeoutMethod) Responsible for invoking the timeout method on the target object.
ClassLoader	getClassLoader()
String	getTimedObjectId() The globally unique identifier for this timed object invoker.

Method Detail

getTimedObjectId

String getTimedObjectId()

The globally unique identifier for this timed object invoker.

Returns:

the identifier

callTimeout

void callTimeout(TimerImpl timer)
          throws Exception

Invokes the ejbTimeout method on the TimedObject with the given id.

Parameters:

timer - the Timer that is passed to ejbTimeout

Throws:

Exception

callTimeout

void callTimeout(TimerImpl timer,
                 Method timeoutMethod)
          throws Exception

Responsible for invoking the timeout method on the target object.

The timerservice implementation invokes this method as a callback when a timeout occurs for the passed timer. The timerservice implementation will be responsible for passing the correct timeout method corresponding to the timer on which the timeout has occurred.

Parameters:

timer - the Timer that is passed to ejbTimeout

timeoutMethod - The timeout method

Throws:

Exception

getClassLoader

ClassLoader getClassLoader()

Returns:

The class loader that should be used to load restore any timers for this object