org.apache.camel.impl

Class ConsumerCache

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.ConsumerCache

All Implemented Interfaces:

Service, ShutdownableService, StatefulService, SuspendableService

Direct Known Subclasses:

EmptyConsumerCache

public class ConsumerCache
extends ServiceSupport

Cache containing created Consumer.

Version:

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
ConsumerCache(Object source, CamelContext camelContext)
ConsumerCache(Object source, CamelContext camelContext, int cacheSize)
ConsumerCache(Object source, CamelContext camelContext, Map<String,PollingConsumer> cache)
ConsumerCache(Object source, CamelContext camelContext, Map<String,PollingConsumer> cache, ServicePool<Endpoint,PollingConsumer> pool)

Method Summary

Modifier and Type	Method and Description
PollingConsumer	acquirePollingConsumer(Endpoint endpoint) Acquires a pooled PollingConsumer which you must release back again after usage using the releasePollingConsumer(org.apache.camel.Endpoint, org.apache.camel.PollingConsumer) method.
void	cleanUp() Cleanup the cache (purging stale entries)
protected static LRUCache<String,PollingConsumer>	createLRUCache(int cacheSize) Creates the LRUCache to be used.
protected PollingConsumer	doGetPollingConsumer(Endpoint endpoint, boolean pooled)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
CamelContext	getCamelContext()
int	getCapacity() Gets the maximum cache size (capacity).
PollingConsumer	getConsumer(Endpoint endpoint)
EndpointUtilizationStatistics	getEndpointUtilizationStatistics()
long	getEvicted() Gets the cache evicted statistic Will return -1 if it cannot determine this if a custom cache was used.
long	getHits() Gets the cache hits statistic Will return -1 if it cannot determine this if a custom cache was used.
long	getMisses() Gets the cache misses statistic Will return -1 if it cannot determine this if a custom cache was used.
Object	getSource() Gets the source which uses this cache
boolean	isExtendedStatistics()
void	purge() Purges this cache
Exchange	receive(Endpoint endpoint)
Exchange	receive(Endpoint endpoint, long timeout)
Exchange	receiveNoWait(Endpoint endpoint)
void	releasePollingConsumer(Endpoint endpoint, PollingConsumer pollingConsumer) Releases an acquired producer back after usage.
void	resetCacheStatistics() Resets the cache statistics
void	setExtendedStatistics(boolean extendedStatistics) Whether extended JMX statistics is enabled for EndpointUtilizationStatistics
int	size() Returns the current size of the cache
String	toString()

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, wait, wait, wait

Constructor Detail

ConsumerCache

public ConsumerCache(Object source,
                     CamelContext camelContext)

ConsumerCache

public ConsumerCache(Object source,
                     CamelContext camelContext,
                     int cacheSize)

ConsumerCache

public ConsumerCache(Object source,
                     CamelContext camelContext,
                     Map<String,PollingConsumer> cache)

ConsumerCache

public ConsumerCache(Object source,
                     CamelContext camelContext,
                     Map<String,PollingConsumer> cache,
                     ServicePool<Endpoint,PollingConsumer> pool)

Method Detail

isExtendedStatistics

public boolean isExtendedStatistics()

setExtendedStatistics

public void setExtendedStatistics(boolean extendedStatistics)

Whether extended JMX statistics is enabled for EndpointUtilizationStatistics

createLRUCache

protected static LRUCache<String,PollingConsumer> createLRUCache(int cacheSize)

Creates the LRUCache to be used.

This implementation returns a LRUCache instance.

Parameters:

cacheSize - the cache size

Returns:

the cache

acquirePollingConsumer

public PollingConsumer acquirePollingConsumer(Endpoint endpoint)

Acquires a pooled PollingConsumer which you must release back again after usage using the releasePollingConsumer(org.apache.camel.Endpoint, org.apache.camel.PollingConsumer) method.

Parameters:

endpoint - the endpoint

Returns:

the PollingConsumer

releasePollingConsumer

public void releasePollingConsumer(Endpoint endpoint,
                                   PollingConsumer pollingConsumer)

Releases an acquired producer back after usage.

Parameters:

endpoint - the endpoint

pollingConsumer - the pollingConsumer to release

getConsumer

public PollingConsumer getConsumer(Endpoint endpoint)

doGetPollingConsumer

protected PollingConsumer doGetPollingConsumer(Endpoint endpoint,
                                               boolean pooled)

receive

public Exchange receive(Endpoint endpoint)

receive

public Exchange receive(Endpoint endpoint,
                        long timeout)

receiveNoWait

public Exchange receiveNoWait(Endpoint endpoint)

getCamelContext

public CamelContext getCamelContext()

getSource

public Object getSource()

Gets the source which uses this cache

Returns:

the source

size

public int size()

Returns the current size of the cache

Returns:

the current size

getCapacity

public int getCapacity()

Gets the maximum cache size (capacity).

Will return -1 if it cannot determine this if a custom cache was used.

Returns:

the capacity

getHits

public long getHits()

Gets the cache hits statistic

Will return -1 if it cannot determine this if a custom cache was used.

Returns:

the hits

getMisses

public long getMisses()

Gets the cache misses statistic

Will return -1 if it cannot determine this if a custom cache was used.

Returns:

the misses

getEvicted

public long getEvicted()

Gets the cache evicted statistic

Will return -1 if it cannot determine this if a custom cache was used.

Returns:

the evicted

resetCacheStatistics

public void resetCacheStatistics()

Resets the cache statistics

purge

public void purge()

Purges this cache

cleanUp

public void cleanUp()

Cleanup the cache (purging stale entries)

getEndpointUtilizationStatistics

public EndpointUtilizationStatistics getEndpointUtilizationStatistics()

toString

public String toString()

Overrides:

toString in class Object

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()