org.apache.camel.support

Class DefaultTimeoutMap<K,V>

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.support.DefaultTimeoutMap<K,V>

All Implemented Interfaces:

Runnable, Service, ShutdownableService, StatefulService, SuspendableService, TimeoutMap<K,V>

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

Default implementation of the TimeoutMap.

This implementation supports thread safe and non thread safe, in the manner you can enable locking or not. By default locking is enabled and thus we are thread safe.

You must provide a ScheduledExecutorService in the constructor which is used to schedule a background task which check for old entries to purge. This implementation will shutdown the scheduler if its being stopped. You must also invoke ServiceSupport.start() to startup the timeout map, before its ready to be used. And you must invoke ServiceSupport.stop() to stop the map when no longer in use.

Version:

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
DefaultTimeoutMap(ScheduledExecutorService executor)
DefaultTimeoutMap(ScheduledExecutorService executor, long requestMapPollTimeMillis)
DefaultTimeoutMap(ScheduledExecutorService executor, long requestMapPollTimeMillis, boolean useLock)

Method Summary

Methods

Modifier and Type	Method and Description
protected long	currentTime()
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
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
boolean	onEviction(K key, V value) Callback when the value has been evicted
void	purge() Purges any old entries from the map
V	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
V	putIfAbsent(K key, V value, long timeoutMillis) Adds the key value pair into the map if the specified key is not already associated with a value such that some time after the given timeout the entry will be evicted
V	remove(K key) 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
protected void	updateExpireTime(TimeoutMapEntry<K,V> entry)

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

DefaultTimeoutMap

public DefaultTimeoutMap(ScheduledExecutorService executor)

DefaultTimeoutMap

public DefaultTimeoutMap(ScheduledExecutorService executor,
                 long requestMapPollTimeMillis)

DefaultTimeoutMap

public DefaultTimeoutMap(ScheduledExecutorService executor,
                 long requestMapPollTimeMillis,
                 boolean useLock)

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 V 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

Returns:

the previous value associated with key, or null if there was no mapping for key.

putIfAbsent

public V putIfAbsent(K key,
            V value,
            long timeoutMillis)

Description copied from interface: TimeoutMap

Adds the key value pair into the map if the specified key is not already associated with a value such that some time after the given timeout the entry will be evicted

Specified by:

putIfAbsent in interface TimeoutMap<K,V>

Parameters:

key - the key

value - the value

timeoutMillis - timeout in millis

Returns:

the value associated with key, or null if there was no mapping for key.

remove

public V remove(K key)

Description copied from interface: TimeoutMap

Removes the object with the given key

Specified by:

remove in interface TimeoutMap<K,V>

Parameters:

key - key for the object to remove

Returns:

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

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 boolean 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

Returns:

true to remove the evicted value, or false to veto the eviction and thus keep the value.

updateExpireTime

protected void updateExpireTime(TimeoutMapEntry<K,V> entry)

currentTime

protected long currentTime()

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Specified by:

doStart in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Specified by:

doStop in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStart()