org.apache.camel.util
Class DefaultTimeoutMap<K,V>

java.lang.Object
  org.apache.camel.util.DefaultTimeoutMap<K,V>

All Implemented Interfaces:

Runnable, Service, TimeoutMap<K,V>

public class DefaultTimeoutMap<K,V>
extends Object
implements TimeoutMap<K,V>, Runnable, Service

Default implementation of the TimeoutMap.

Version:

$Revision: 918985 $

Field Summary

protected org.apache.commons.logging.Log

log

Constructor Summary

DefaultTimeoutMap()

DefaultTimeoutMap(ScheduledExecutorService executor, long requestMapPollTimeMillis)

Method Summary

protected long	currentTime()
V	get(K key) Looks up the value in the map by the given key.
ScheduledExecutorService	getExecutor()
Object[]	getKeys() Returns a copy of the keys in the map
long	getPurgePollTime()
protected boolean	isValidForEviction(TimeoutMapEntry<K,V> entry) A hook to allow derivations to avoid evicting the current entry
void	onEviction(K key, V value) Callback when the value has been evicted
void	purge() Purges any old entries from the map
void	put(K key, V value, long timeoutMillis) Adds the key value pair into the map such that some time after the given timeout the entry will be evicted
void	remove(K id) Removes the object with the given key
void	run() The timer task which purges old requests and schedules another poll
protected void	schedulePoll() lets schedule each time to allow folks to change the time at runtime
int	size() Returns the size of the map
void	start() Starts the service
void	stop() Stops the service
protected void	updateExpireTime(TimeoutMapEntry entry)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final transient org.apache.commons.logging.Log log

Constructor Detail

DefaultTimeoutMap

public DefaultTimeoutMap()

DefaultTimeoutMap

public DefaultTimeoutMap(ScheduledExecutorService executor,
                         long requestMapPollTimeMillis)

Method Detail

get

public V get(K key)

Description copied from interface: TimeoutMap

Looks up the value in the map by the given key.

Specified by:

get in interface TimeoutMap<K,V>

Parameters:

key - the key of the value to search for

Returns:

the value for the given key or null if it is not present (or has timed out)

put

public void put(K key,
                V value,
                long timeoutMillis)

Description copied from interface: TimeoutMap

Adds the key value pair into the map such that some time after the given timeout the entry will be evicted

Specified by:

put in interface TimeoutMap<K,V>

Parameters:

key - the key

value - the value

timeoutMillis - timeout in millis

remove

public void remove(K id)

Description copied from interface: TimeoutMap

Removes the object with the given key

Specified by:

remove in interface TimeoutMap<K,V>

Parameters:

id - key for the object to remove

getKeys

public Object[] getKeys()

Description copied from interface: TimeoutMap

Returns a copy of the keys in the map

Specified by:

getKeys in interface TimeoutMap<K,V>

Returns:

the keys

size

public int size()

Description copied from interface: TimeoutMap

Returns the size of the map

Specified by:

size in interface TimeoutMap<K,V>

Returns:

the size

run

public void run()

The timer task which purges old requests and schedules another poll

Specified by:

run in interface Runnable

purge

public void purge()

Description copied from interface: TimeoutMap

Purges any old entries from the map

Specified by:

purge in interface TimeoutMap<K,V>

getPurgePollTime

public long getPurgePollTime()

getExecutor

public ScheduledExecutorService getExecutor()

schedulePoll

protected void schedulePoll()

lets schedule each time to allow folks to change the time at runtime

isValidForEviction

protected boolean isValidForEviction(TimeoutMapEntry<K,V> entry)

A hook to allow derivations to avoid evicting the current entry

onEviction

public void onEviction(K key,
                       V value)

Description copied from interface: TimeoutMap

Callback when the value has been evicted

Specified by:

onEviction in interface TimeoutMap<K,V>

Parameters:

key - the key

value - the value

updateExpireTime

protected void updateExpireTime(TimeoutMapEntry entry)

currentTime

protected long currentTime()

start

public void start()
           throws Exception

Description copied from interface: Service

Starts the service

Specified by:

start in interface Service

Throws:

Exception - is thrown if starting failed

stop

public void stop()
          throws Exception

Description copied from interface: Service

Stops the service

Specified by:

stop in interface Service

Throws:

Exception - is thrown if stopping failed