org.apache.camel.processor
Class SamplingThrottler

java.lang.Object
  org.apache.camel.support.ServiceSupport
      org.apache.camel.processor.DelegateAsyncProcessor
          org.apache.camel.processor.SamplingThrottler

All Implemented Interfaces:

AsyncProcessor, DelegateProcessor, Navigate<Processor>, Processor, Service, ShutdownableService, StatefulService, SuspendableService

public class SamplingThrottler
extends DelegateAsyncProcessor

A SamplingThrottler is a special kind of throttler. It also limits the number of exchanges sent to a downstream endpoint. It differs from a normal throttler in that it will not queue exchanges above the threshold for a given period. Instead these exchanges will be stopped, precluding them from being processed at all by downstream consumers.

This kind of throttling can be useful for taking a sample from an exchange stream, rough consolidation of noisy and bursty exchange traffic or where queuing of throttled exchanges is undesirable.

Version:

Field Summary

protected org.slf4j.Logger

log

Fields inherited from class org.apache.camel.processor.DelegateAsyncProcessor

processor

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

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

Constructor Summary

SamplingThrottler(Processor processor, long messageFrequency)

SamplingThrottler(Processor processor, long samplePeriod, TimeUnit units)

Method Summary

String	getTraceLabel()
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
String	toString()

Methods inherited from class org.apache.camel.processor.DelegateAsyncProcessor

doStart, doStop, getProcessor, hasNext, next, process, processNext, setProcessor, setProcessor

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

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

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final transient org.slf4j.Logger log

Constructor Detail

SamplingThrottler

public SamplingThrottler(Processor processor,
                         long messageFrequency)

SamplingThrottler

public SamplingThrottler(Processor processor,
                         long samplePeriod,
                         TimeUnit units)

Method Detail

toString

public String toString()

Overrides:

toString in class DelegateAsyncProcessor

getTraceLabel

public String getTraceLabel()

process

public boolean process(Exchange exchange,
                       AsyncCallback callback)

Description copied from interface: AsyncProcessor

Processes the message exchange. Similar to Processor.process(org.apache.camel.Exchange), but the caller supports having the exchange asynchronously processed.

If there was a failure processing then the caused Exception would be set on the Exchange.

Specified by:

process in interface AsyncProcessor

Overrides:

process in class DelegateAsyncProcessor

Parameters:

exchange - the message exchange

callback - the AsyncCallback will be invoked when the processing of the exchange is completed. If the exchange is completed synchronously, then the callback is also invoked synchronously. The callback should therefore be careful of starting recursive loop.

Returns:

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

See Also:

AsyncProcessorHelper.process(AsyncProcessor, Exchange, AsyncCallback)