org.apache.commons.pipeline.stage
Interface ExtendedBaseStageMBean

All Known Implementing Classes:

ExtendedBaseStage

public interface ExtendedBaseStageMBean

Interface to JMX enable the ExtendedBaseStage.

Author:

mzsanford

Method Summary

Boolean	getCollectBranchStats()
double	getCurrentServiceTimeAverage() Get the current average service time.
Integer	getCurrentStatWindowSize() Get the size of the service time collection window
long	getObjectsReceived()
Integer	getStatusBatchSize()
Long	getStatusInterval()
String	getStatusMessage()
long	getTotalEmits()
long	getTotalEmitTime()
long	getTotalServiceTime()
void	setCollectBranchStats(Boolean collectBranchStats) Branch stats are disabled by default because they are slow.
void	setCurrentStatWindowSize(Integer newStatWindowSize) Set the size of the service time collection window
void	setStatusBatchSize(Integer statusBatchSize)
void	setStatusInterval(Long statusInterval)

Method Detail

getStatusMessage

String getStatusMessage()

Returns:

build the status message. This may have an effect on stage throughput.

getStatusInterval

Long getStatusInterval()

Returns:

number of records after which status messages are logged.

setStatusInterval

void setStatusInterval(Long statusInterval)

Parameters:

statusInterval - new status interval

getStatusBatchSize

Integer getStatusBatchSize()

Returns:

Size of batches processes by this stage (used to adjust throughput statistics)

setStatusBatchSize

void setStatusBatchSize(Integer statusBatchSize)

Parameters:

statusBatchSize - Size of batches processes by this stage (used to adjust throughput statistics)

getObjectsReceived

long getObjectsReceived()

Returns:

number of objects received

getTotalServiceTime

long getTotalServiceTime()

Returns:

total number of milliseconds spent processing

getTotalEmitTime

long getTotalEmitTime()

Returns:

total number of milliseconds spent blocked on downstream queues

getTotalEmits

long getTotalEmits()

Returns:

total number of emits to downstream queues

getCollectBranchStats

Boolean getCollectBranchStats()

Returns:

true is this stage is collecting branch stats, false otherwise.

setCollectBranchStats

void setCollectBranchStats(Boolean collectBranchStats)

Branch stats are disabled by default because they are slow. Turning this on can have a noticeable effect on stage throughput.

Parameters:

collectBranchStats - true if this stage should start collecting branch stats, false otherwise.

getCurrentServiceTimeAverage

double getCurrentServiceTimeAverage()

Get the current average service time. This works by looking only at the last X objects processed, where X is defined and reported by the getCurrentStatWindowSize and setCurrentStatWindowSize methods.

Returns:

average time to process in milliseconds

getCurrentStatWindowSize

Integer getCurrentStatWindowSize()

Get the size of the service time collection window

setCurrentStatWindowSize

void setCurrentStatWindowSize(Integer newStatWindowSize)

Set the size of the service time collection window