org.apache.camel.processor

Class ThroughputLogger

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.processor.ThroughputLogger

All Implemented Interfaces:

AsyncProcessor, Processor, Service, ShutdownableService, HasId, IdAware, StatefulService, SuspendableService

public class ThroughputLogger
extends ServiceSupport
implements AsyncProcessor, IdAware

A logger for logging message throughput.

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
ThroughputLogger(CamelLogger log)
ThroughputLogger(CamelLogger log, CamelContext camelContext, Long groupInterval, Long groupDelay, Boolean groupActiveOnly)
ThroughputLogger(CamelLogger log, Integer groupSize)

Method Summary

Modifier and Type	Method and Description
protected void	createGroupIntervalLogMessage()
protected String	createLogMessage(Exchange exchange, int receivedCount)
void	doStart() Implementations override this method to support customized start/stop.
void	doStop() Implementations override this method to support customized start/stop.
String	getAction()
double	getAverage()
boolean	getGroupActiveOnly()
long	getGroupDelay()
Long	getGroupInterval()
Integer	getGroupSize()
String	getId() Returns the id
String	getLastLogMessage()
NumberFormat	getNumberFormat()
double	getRate()
int	getReceivedCounter()
protected double	messagesPerSecond(long messageCount, long startTime, long endTime)
void	process(Exchange exchange) Processes the message exchange
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
void	reset()
void	setAction(String action)
void	setGroupDelay(long groupDelay)
void	setGroupInterval(Long groupInterval)
void	setGroupSize(Integer groupSize)
void	setId(String id) Sets the id
void	setNumberFormat(NumberFormat numberFormat)

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

Constructor Detail

ThroughputLogger

public ThroughputLogger(CamelLogger log)

ThroughputLogger

public ThroughputLogger(CamelLogger log,
                        Integer groupSize)

ThroughputLogger

public ThroughputLogger(CamelLogger log,
                        CamelContext camelContext,
                        Long groupInterval,
                        Long groupDelay,
                        Boolean groupActiveOnly)

Method Detail

getId

public String getId()

Description copied from interface: HasId

Returns the id

Specified by:

getId in interface HasId

Returns:

the id

setId

public void setId(String id)

Description copied from interface: IdAware

Sets the id

Specified by:

setId in interface IdAware

Parameters:

id - the id

process

public void process(Exchange exchange)
             throws Exception

Description copied from interface: Processor

Processes the message exchange

Specified by:

process in interface Processor

Parameters:

exchange - the message exchange

Throws:

Exception - if an internal processing error has occurred.

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

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

getGroupSize

public Integer getGroupSize()

setGroupSize

public void setGroupSize(Integer groupSize)

getGroupInterval

public Long getGroupInterval()

setGroupInterval

public void setGroupInterval(Long groupInterval)

getGroupDelay

public long getGroupDelay()

setGroupDelay

public void setGroupDelay(long groupDelay)

getGroupActiveOnly

public boolean getGroupActiveOnly()

getNumberFormat

public NumberFormat getNumberFormat()

setNumberFormat

public void setNumberFormat(NumberFormat numberFormat)

getAction

public String getAction()

setAction

public void setAction(String action)

reset

public void reset()

getRate

public double getRate()

getAverage

public double getAverage()

getReceivedCounter

public int getReceivedCounter()

getLastLogMessage

public String getLastLogMessage()

doStart

public 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

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

createLogMessage

protected String createLogMessage(Exchange exchange,
                                  int receivedCount)

createGroupIntervalLogMessage

protected void createGroupIntervalLogMessage()

messagesPerSecond

protected double messagesPerSecond(long messageCount,
                                   long startTime,
                                   long endTime)