kieker.analysis.plugin
Class SilentCountingRecordConsumer

java.lang.Object
  kieker.analysis.plugin.SilentCountingRecordConsumer

All Implemented Interfaces:

IAnalysisPlugin, IMonitoringRecordConsumerPlugin, IMonitoringRecordReceiver

public final class SilentCountingRecordConsumer
extends Object
implements IMonitoringRecordConsumerPlugin

Author:

Jan Waller

Constructor Summary

SilentCountingRecordConsumer()
Constructs a SilentCountingRecordConsumer.

Method Summary

boolean	execute() Initiates the start of a component.
long	getMessageCount()
Collection<Class<? extends IMonitoringRecord>>	getRecordTypeSubscriptionList() Simply return null to get records of all types.
boolean	newMonitoringRecord(IMonitoringRecord monitoringRecord) Called for each new record.
void	terminate(boolean error) Initiates a termination of the component.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SilentCountingRecordConsumer

public SilentCountingRecordConsumer()

Constructs a SilentCountingRecordConsumer.

Method Detail

getRecordTypeSubscriptionList

public final Collection<Class<? extends IMonitoringRecord>> getRecordTypeSubscriptionList()

Description copied from interface: IMonitoringRecordConsumerPlugin

Simply return null to get records of all types.

Specified by:

getRecordTypeSubscriptionList in interface IMonitoringRecordConsumerPlugin

Returns:

list of specific record types to subscribe to; null to subsribe to any type

newMonitoringRecord

public final boolean newMonitoringRecord(IMonitoringRecord monitoringRecord)

Description copied from interface: IMonitoringRecordReceiver

Called for each new record. Notice, that this method should not throw an exception, but indicate an error by the return value false.

Specified by:

newMonitoringRecord in interface IMonitoringRecordReceiver

Parameters:

monitoringRecord - the record.

Returns:

true on success; false in case of an error.

execute

public final boolean execute()

Description copied from interface: IAnalysisPlugin

Initiates the start of a component. This method is called once when a TpanInstance's run() method is called. This implementation must not be blocking! Asynchronous consumers would spawn (an) asynchronous thread(s) in this method.

Specified by:

execute in interface IAnalysisPlugin

Returns:

true on success; false otherwise.

terminate

public final void terminate(boolean error)

Description copied from interface: IAnalysisPlugin

Initiates a termination of the component. The value of the parameter error indicates whether an error occured.

Specified by:

terminate in interface IAnalysisPlugin

Parameters:

error - true iff an error occured.

getMessageCount

public final long getMessageCount()