org.apache.camel.impl.engine

Class DefaultConsumerCache

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.impl.engine.DefaultConsumerCache

All Implemented Interfaces:

AutoCloseable, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.ConsumerCache, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

public class DefaultConsumerCache
extends org.apache.camel.support.service.ServiceSupport
implements org.apache.camel.spi.ConsumerCache

Cache containing created Consumer.

Field Summary

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

BUILDED, FAILED, INITIALIZED, lock, log, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
DefaultConsumerCache(Object source, org.apache.camel.CamelContext camelContext, int cacheSize)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.PollingConsumer	acquirePollingConsumer(org.apache.camel.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 void	doStart()
protected void	doStop()
org.apache.camel.CamelContext	getCamelContext()
int	getCapacity() Gets the maximum cache size (capacity).
org.apache.camel.spi.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
org.apache.camel.Exchange	receive(org.apache.camel.Endpoint endpoint)
org.apache.camel.Exchange	receive(org.apache.camel.Endpoint endpoint, long timeout)
org.apache.camel.Exchange	receiveNoWait(org.apache.camel.Endpoint endpoint)
void	releasePollingConsumer(org.apache.camel.Endpoint endpoint, org.apache.camel.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.service.ServiceSupport

build, doBuild, doInit, doResume, doShutdown, doSuspend, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, 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

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Constructor Detail

DefaultConsumerCache

public DefaultConsumerCache(Object source,
                            org.apache.camel.CamelContext camelContext,
                            int cacheSize)

Method Detail

isExtendedStatistics

public boolean isExtendedStatistics()

setExtendedStatistics

public void setExtendedStatistics(boolean extendedStatistics)

Whether extended JMX statistics is enabled for EndpointUtilizationStatistics

releasePollingConsumer

public void releasePollingConsumer(org.apache.camel.Endpoint endpoint,
                                   org.apache.camel.PollingConsumer pollingConsumer)

Releases an acquired producer back after usage.

Specified by:

releasePollingConsumer in interface org.apache.camel.spi.ConsumerCache

Parameters:

endpoint - the endpoint

pollingConsumer - the pollingConsumer to release

acquirePollingConsumer

public org.apache.camel.PollingConsumer acquirePollingConsumer(org.apache.camel.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.

Specified by:

acquirePollingConsumer in interface org.apache.camel.spi.ConsumerCache

Parameters:

endpoint - the endpoint

Returns:

the PollingConsumer

receive

public org.apache.camel.Exchange receive(org.apache.camel.Endpoint endpoint)

Specified by:

receive in interface org.apache.camel.spi.ConsumerCache

receive

public org.apache.camel.Exchange receive(org.apache.camel.Endpoint endpoint,
                                         long timeout)

Specified by:

receive in interface org.apache.camel.spi.ConsumerCache

receiveNoWait

public org.apache.camel.Exchange receiveNoWait(org.apache.camel.Endpoint endpoint)

Specified by:

receiveNoWait in interface org.apache.camel.spi.ConsumerCache

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

getSource

public Object getSource()

Gets the source which uses this cache

Specified by:

getSource in interface org.apache.camel.spi.ConsumerCache

Returns:

the source

size

public int size()

Returns the current size of the cache

Specified by:

size in interface org.apache.camel.spi.ConsumerCache

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.

Specified by:

getCapacity in interface org.apache.camel.spi.ConsumerCache

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.

Specified by:

getHits in interface org.apache.camel.spi.ConsumerCache

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.

Specified by:

getMisses in interface org.apache.camel.spi.ConsumerCache

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.

Specified by:

getEvicted in interface org.apache.camel.spi.ConsumerCache

Returns:

the evicted

resetCacheStatistics

public void resetCacheStatistics()

Resets the cache statistics

Specified by:

resetCacheStatistics in interface org.apache.camel.spi.ConsumerCache

purge

public void purge()

Purges this cache

Specified by:

purge in interface org.apache.camel.spi.ConsumerCache

cleanUp

public void cleanUp()

Cleanup the cache (purging stale entries)

Specified by:

cleanUp in interface org.apache.camel.spi.ConsumerCache

getEndpointUtilizationStatistics

public org.apache.camel.spi.EndpointUtilizationStatistics getEndpointUtilizationStatistics()

Specified by:

getEndpointUtilizationStatistics in interface org.apache.camel.spi.ConsumerCache

toString

public String toString()

Overrides:

toString in class Object

doStart

protected void doStart()
                throws Exception

Specified by:

doStart in class org.apache.camel.support.service.ServiceSupport

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Specified by:

doStop in class org.apache.camel.support.service.ServiceSupport

Throws:

Exception