org.apache.camel.impl

Class DefaultProducerCache

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.impl.DefaultProducerCache

All Implemented Interfaces:

org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.ProducerCache, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

public class DefaultProducerCache
extends org.apache.camel.support.service.ServiceSupport
implements org.apache.camel.spi.ProducerCache

Cache containing created Producer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.spi.ProducerCache

org.apache.camel.spi.ProducerCache.AsyncProducerCallback

Field Summary

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
org.apache.camel.AsyncProducer	acquireProducer(org.apache.camel.Endpoint endpoint) Acquires a pooled producer which you must release back again after usage using the releaseProducer(org.apache.camel.Endpoint, org.apache.camel.AsyncProducer) method.
protected boolean	asyncDispatchExchange(org.apache.camel.Endpoint endpoint, org.apache.camel.AsyncProducer producer, org.apache.camel.Processor resultProcessor, org.apache.camel.Exchange exchange, org.apache.camel.AsyncCallback callback)
CompletableFuture<org.apache.camel.Exchange>	asyncSend(org.apache.camel.Endpoint endpoint, org.apache.camel.ExchangePattern pattern, org.apache.camel.Processor processor, org.apache.camel.Processor resultProcessor, CompletableFuture<org.apache.camel.Exchange> future) Asynchronously sends an exchange to an endpoint using a supplied Processor to populate the exchange
CompletableFuture<org.apache.camel.Exchange>	asyncSendExchange(org.apache.camel.Endpoint endpoint, org.apache.camel.ExchangePattern pattern, org.apache.camel.Processor processor, org.apache.camel.Processor resultProcessor, org.apache.camel.Exchange exchange, CompletableFuture<org.apache.camel.Exchange> future) Asynchronously sends an exchange to an endpoint using a supplied Processor to populate the exchange
void	cleanUp() Cleanup the cache (purging stale entries)
protected CompletableFuture<org.apache.camel.Exchange>	doAsyncSendExchange(org.apache.camel.Endpoint endpoint, org.apache.camel.Processor processor, org.apache.camel.Processor resultProcessor, org.apache.camel.Exchange exchange, CompletableFuture<org.apache.camel.Exchange> f)
protected org.apache.camel.AsyncProducer	doGetProducer(org.apache.camel.Endpoint endpoint)
boolean	doInAsyncProducer(org.apache.camel.Endpoint endpoint, org.apache.camel.Exchange exchange, org.apache.camel.AsyncCallback callback, org.apache.camel.spi.ProducerCache.AsyncProducerCallback producerCallback) Sends an exchange to an endpoint using a supplied callback supporting the asynchronous routing engine.
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	isEventNotifierEnabled()
boolean	isExtendedStatistics()
void	purge() Purges this cache
void	releaseProducer(org.apache.camel.Endpoint endpoint, org.apache.camel.AsyncProducer producer) Releases an acquired producer back after usage.
void	resetCacheStatistics() Resets the cache statistics
org.apache.camel.Exchange	send(org.apache.camel.Endpoint endpoint, org.apache.camel.Exchange exchange, org.apache.camel.Processor resultProcessor) Sends the exchange to the given endpoint.
void	setEventNotifierEnabled(boolean eventNotifierEnabled) Whether EventNotifier is enabled
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

doInit, doResume, doShutdown, doSuspend, getStatus, init, 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

init, start, stop

Constructor Detail

DefaultProducerCache

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

Method Detail

isEventNotifierEnabled

public boolean isEventNotifierEnabled()

Specified by:

isEventNotifierEnabled in interface org.apache.camel.spi.ProducerCache

setEventNotifierEnabled

public void setEventNotifierEnabled(boolean eventNotifierEnabled)

Whether EventNotifier is enabled

Specified by:

setEventNotifierEnabled in interface org.apache.camel.spi.ProducerCache

isExtendedStatistics

public boolean isExtendedStatistics()

setExtendedStatistics

public void setExtendedStatistics(boolean extendedStatistics)

Whether extended JMX statistics is enabled for EndpointUtilizationStatistics

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.ProducerCache

Returns:

the source

acquireProducer

public org.apache.camel.AsyncProducer acquireProducer(org.apache.camel.Endpoint endpoint)

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

Specified by:

acquireProducer in interface org.apache.camel.spi.ProducerCache

Parameters:

endpoint - the endpoint

Returns:

the producer

releaseProducer

public void releaseProducer(org.apache.camel.Endpoint endpoint,
                            org.apache.camel.AsyncProducer producer)

Releases an acquired producer back after usage.

Specified by:

releaseProducer in interface org.apache.camel.spi.ProducerCache

Parameters:

endpoint - the endpoint

producer - the producer to release

send

public org.apache.camel.Exchange send(org.apache.camel.Endpoint endpoint,
                                      org.apache.camel.Exchange exchange,
                                      org.apache.camel.Processor resultProcessor)

Sends the exchange to the given endpoint.

This method will not throw an exception. If processing of the given Exchange failed then the exception is stored on the provided Exchange

Specified by:

send in interface org.apache.camel.spi.ProducerCache

Parameters:

endpoint - the endpoint to send the exchange to

exchange - the exchange to send

asyncSend

public CompletableFuture<org.apache.camel.Exchange> asyncSend(org.apache.camel.Endpoint endpoint,
                                                              org.apache.camel.ExchangePattern pattern,
                                                              org.apache.camel.Processor processor,
                                                              org.apache.camel.Processor resultProcessor,
                                                              CompletableFuture<org.apache.camel.Exchange> future)

Asynchronously sends an exchange to an endpoint using a supplied Processor to populate the exchange

This method will neither throw an exception nor complete future exceptionally. If processing of the given Exchange failed then the exception is stored on the return Exchange

Parameters:

endpoint - the endpoint to send the exchange to

pattern - the message ExchangePattern such as ExchangePattern.InOnly or ExchangePattern.InOut

processor - the transformer used to populate the new exchange

resultProcessor - a processor to process the exchange when the send is complete.

future - the preexisting future to complete when processing is done or null if to create new one

Returns:

future that completes with exchange when processing is done. Either passed into future parameter or new one if parameter was null

asyncSendExchange

public CompletableFuture<org.apache.camel.Exchange> asyncSendExchange(org.apache.camel.Endpoint endpoint,
                                                                      org.apache.camel.ExchangePattern pattern,
                                                                      org.apache.camel.Processor processor,
                                                                      org.apache.camel.Processor resultProcessor,
                                                                      org.apache.camel.Exchange exchange,
                                                                      CompletableFuture<org.apache.camel.Exchange> future)

Asynchronously sends an exchange to an endpoint using a supplied Processor to populate the exchange

This method will neither throw an exception nor complete future exceptionally. If processing of the given Exchange failed then the exception is stored on the return Exchange

Specified by:

asyncSendExchange in interface org.apache.camel.spi.ProducerCache

Parameters:

endpoint - the endpoint to send the exchange to

pattern - the message ExchangePattern such as ExchangePattern.InOnly or ExchangePattern.InOut

processor - the transformer used to populate the new exchange

resultProcessor - a processor to process the exchange when the send is complete.

exchange - an exchange to use in processing. Exchange will be created if parameter is null.

future - the preexisting future to complete when processing is done or null if to create new one

Returns:

future that completes with exchange when processing is done. Either passed into future parameter or new one if parameter was null

doAsyncSendExchange

protected CompletableFuture<org.apache.camel.Exchange> doAsyncSendExchange(org.apache.camel.Endpoint endpoint,
                                                                           org.apache.camel.Processor processor,
                                                                           org.apache.camel.Processor resultProcessor,
                                                                           org.apache.camel.Exchange exchange,
                                                                           CompletableFuture<org.apache.camel.Exchange> f)

doInAsyncProducer

public boolean doInAsyncProducer(org.apache.camel.Endpoint endpoint,
                                 org.apache.camel.Exchange exchange,
                                 org.apache.camel.AsyncCallback callback,
                                 org.apache.camel.spi.ProducerCache.AsyncProducerCallback producerCallback)

Sends an exchange to an endpoint using a supplied callback supporting the asynchronous routing engine.

If an exception was thrown during processing, it would be set on the given Exchange

Specified by:

doInAsyncProducer in interface org.apache.camel.spi.ProducerCache

Parameters:

endpoint - the endpoint to send the exchange to

exchange - the exchange, can be null if so then create a new exchange from the producer

callback - the asynchronous callback

producerCallback - the producer template callback to be executed

Returns:

(doneSync) true to continue execute synchronously, false to continue being executed asynchronously

asyncDispatchExchange

protected boolean asyncDispatchExchange(org.apache.camel.Endpoint endpoint,
                                        org.apache.camel.AsyncProducer producer,
                                        org.apache.camel.Processor resultProcessor,
                                        org.apache.camel.Exchange exchange,
                                        org.apache.camel.AsyncCallback callback)

doGetProducer

protected org.apache.camel.AsyncProducer doGetProducer(org.apache.camel.Endpoint endpoint)
                                                throws Exception

Throws:

Exception

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

size

public int size()

Returns the current size of the cache

Specified by:

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

Returns:

the current size

getCapacity

public int getCapacity()

Gets the maximum cache size (capacity).

Specified by:

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

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.ProducerCache

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.ProducerCache

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.ProducerCache

Returns:

the evicted

resetCacheStatistics

public void resetCacheStatistics()

Resets the cache statistics

Specified by:

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

purge

public void purge()

Purges this cache

Specified by:

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

cleanUp

public void cleanUp()

Cleanup the cache (purging stale entries)

Specified by:

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

getEndpointUtilizationStatistics

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

Specified by:

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

toString

public String toString()

Overrides:

toString in class Object