org.openksavi.sponge.correlator

Interface CorrelatorMeta

All Superinterfaces:

Descriptive, EventProcessorMeta, EventSetProcessorMeta, HasFeatures, HasVersion, ProcessorMeta

public interface CorrelatorMeta
extends EventSetProcessorMeta

A correlator metadata.

Method Summary

Modifier and Type	Method and Description
int	getMaxInstances() Returns the maximum number of concurrent instances allowed for this correlator.
boolean	isInstanceSynchronous() Returns the instance synchronous flag.
void	setInstanceSynchronous(boolean instanceSynchronous) Sets the instance synchronous flag.
void	setMaxInstances(int maxInstances) Sets the maximum number of concurrent instances allowed for this correlator.

Methods inherited from interface org.openksavi.sponge.EventSetProcessorMeta

getDuration, hasDuration, isSynchronous, setDuration, setSynchronous

Methods inherited from interface org.openksavi.sponge.EventProcessorMeta

addEventNames, getEventName, getEventNames, setEventNames

Methods inherited from interface org.openksavi.sponge.ProcessorMeta

getCategory, setCategory

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getLabel, getName, setDescription, setLabel, setName

Methods inherited from interface org.openksavi.sponge.util.HasVersion

getVersion, setVersion

Methods inherited from interface org.openksavi.sponge.util.HasFeatures

getFeatures, setFeatures

Method Detail

setMaxInstances

void setMaxInstances(int maxInstances)

Sets the maximum number of concurrent instances allowed for this correlator.

Parameters:

maxInstances - the maximum number of concurrent instances allowed for this correlator.

getMaxInstances

int getMaxInstances()

Returns the maximum number of concurrent instances allowed for this correlator.

Returns:

the maximum number of concurrent instances allowed for this correlator.

setInstanceSynchronous

void setInstanceSynchronous(boolean instanceSynchronous)

Sets the instance synchronous flag.

Parameters:

instanceSynchronous - the instance synchronous flag.

isInstanceSynchronous

boolean isInstanceSynchronous()

Returns the instance synchronous flag. If true (the default value), one instance of the correlator will process only one event at a time. If false, one instance of the correlator will process many events concurrently. In that case the correlator has to be thread safe.

Returns:

the instance synchronous flag.