org.mule.runtime.core.util.monitor

Class ExpiryMonitor

java.lang.Object

org.mule.runtime.core.util.monitor.ExpiryMonitor

All Implemented Interfaces:

Runnable, org.mule.runtime.api.lifecycle.Disposable

public class ExpiryMonitor
extends Object
implements Runnable, org.mule.runtime.api.lifecycle.Disposable

ExpiryMonitor can monitor objects beased on an expiry time and can invoke a callback method once the object time has expired. If the object does expire it is removed from this monitor.

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
ExpiryMonitor(MuleContext muleContext, boolean onPollingNodeOnly)
ExpiryMonitor(String name, long monitorFrequency, MuleContext muleContext, boolean onPollingNodeOnly)

Method Summary

Modifier and Type	Method and Description
void	addExpirable(long value, TimeUnit timeUnit, Expirable expirable) Adds an expirable object to monitor.
void	dispose()
protected void	init()
boolean	isRegistered(Expirable expirable)
void	removeExpirable(Expirable expirable)
void	resetExpirable(Expirable expirable)
void	run() The action to be performed by this timer task.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExpiryMonitor

public ExpiryMonitor(MuleContext muleContext,
                     boolean onPollingNodeOnly)

ExpiryMonitor

public ExpiryMonitor(String name,
                     long monitorFrequency,
                     MuleContext muleContext,
                     boolean onPollingNodeOnly)

Method Detail

init

protected void init()

addExpirable

public void addExpirable(long value,
                         TimeUnit timeUnit,
                         Expirable expirable)

Adds an expirable object to monitor. If the Object is already being monitored it will be reset and the millisecond timeout will be ignored

Parameters:

value - the expiry value

timeUnit - The time unit of the Expiry value

expirable - the objec that will expire

isRegistered

public boolean isRegistered(Expirable expirable)

removeExpirable

public void removeExpirable(Expirable expirable)

resetExpirable

public void resetExpirable(Expirable expirable)

run

public void run()

The action to be performed by this timer task.

Specified by:

run in interface Runnable

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

toString

public String toString()

Overrides:

toString in class Object