org.openksavi.sponge.core.engine.processing

Class DefaultFilterProcessingUnit

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.engine.processing.BaseProcessingUnit<org.openksavi.sponge.filter.FilterAdapter>

org.openksavi.sponge.core.engine.processing.DefaultFilterProcessingUnit

All Implemented Interfaces:

org.openksavi.sponge.engine.EngineModule, org.openksavi.sponge.engine.processing.FilterProcessingUnit, org.openksavi.sponge.engine.processing.ProcessingUnit<org.openksavi.sponge.filter.FilterAdapter>, org.openksavi.sponge.util.Manageable, org.openksavi.sponge.util.Processable

public class DefaultFilterProcessingUnit
extends BaseProcessingUnit<org.openksavi.sponge.filter.FilterAdapter>
implements org.openksavi.sponge.engine.processing.FilterProcessingUnit

Default Filter Processing Unit.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DefaultFilterProcessingUnit.FilterLoopWorker Processing unit worker to be used in a thread pool.

Nested classes/interfaces inherited from class org.openksavi.sponge.core.engine.processing.BaseProcessingUnit

BaseProcessingUnit.EventLoopWorker, BaseProcessingUnit.LoopWorker

Field Summary

Fields

Modifier and Type	Field and Description
protected org.openksavi.sponge.engine.ProcessableThreadPool	filterProcessingUnitListenerThreadPoolEntry The thread pool used by the Filter Processing Unit for listening to the Input Event Queue.

Fields inherited from class org.openksavi.sponge.core.engine.processing.BaseProcessingUnit

eventProcessorRegistrationListener, GET_ITERATION_TIMEOUT, lock

Constructor Summary

Constructors

Constructor and Description
DefaultFilterProcessingUnit(String name, org.openksavi.sponge.engine.Engine engine, org.openksavi.sponge.engine.event.EventQueue inQueue, org.openksavi.sponge.engine.event.EventQueue outQueue) Creates a new Filter Processing Unit.

Method Summary

Modifier and Type	Method and Description
Runnable	createWorker() Creates the worker.
void	doShutdown()
void	doStartup()
boolean	processEvent(org.openksavi.sponge.event.Event event) Processes the specified event.
protected boolean	runFilter(org.openksavi.sponge.filter.FilterAdapter filterContext, org.openksavi.sponge.event.Event event) Runs a filter.
boolean	supportsConcurrentListenerThreadPool()

Methods inherited from class org.openksavi.sponge.core.engine.processing.BaseProcessingUnit

addProcessor, clearUnusedEventMapping, existsProcessor, getEventProcessorRegistrationListener, getEventProcessors, getInQueue, getOutQueue, getRegisteredProcessorAdapterMap, getThreadPoolManager, invalidateCache, processorChanged, removeAllProcessors, removeProcessor, resolveEventProcessors, setEventProcessorRegistrationListener

Methods inherited from class org.openksavi.sponge.core.engine.BaseEngineModule

getEngine, getName, getService, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setEngine, setName, shutdown, startup, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.engine.processing.ProcessingUnit

addProcessor, existsProcessor, getRegisteredProcessorAdapterMap, removeAllProcessors, removeProcessor

Methods inherited from interface org.openksavi.sponge.engine.EngineModule

getEngine, getName, setEngine, setName

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

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated, shutdown, startup

Field Detail

filterProcessingUnitListenerThreadPoolEntry

protected org.openksavi.sponge.engine.ProcessableThreadPool filterProcessingUnitListenerThreadPoolEntry

The thread pool used by the Filter Processing Unit for listening to the Input Event Queue.

Constructor Detail

DefaultFilterProcessingUnit

public DefaultFilterProcessingUnit(String name,
                                   org.openksavi.sponge.engine.Engine engine,
                                   org.openksavi.sponge.engine.event.EventQueue inQueue,
                                   org.openksavi.sponge.engine.event.EventQueue outQueue)

Creates a new Filter Processing Unit.

Parameters:

name - processing unit name.

engine - the engine.

inQueue - input event queue.

outQueue - output event queue.

Method Detail

doStartup

public void doStartup()

Overrides:

doStartup in class BaseEngineModule

doShutdown

public void doShutdown()

Overrides:

doShutdown in class BaseEngineModule

createWorker

public Runnable createWorker()

Creates the worker.

Specified by:

createWorker in interface org.openksavi.sponge.util.Processable

Returns:

the worker.

processEvent

public boolean processEvent(org.openksavi.sponge.event.Event event)

Processes the specified event.

Parameters:

event - event.

Returns:

true if this event should be put in the output queue.

runFilter

protected boolean runFilter(org.openksavi.sponge.filter.FilterAdapter filterContext,
                            org.openksavi.sponge.event.Event event)

Runs a filter.

Parameters:

filterContext - a filter context.

event - an event.

Returns:

true if the filter accepts the specified event.

supportsConcurrentListenerThreadPool

public boolean supportsConcurrentListenerThreadPool()

Specified by:

supportsConcurrentListenerThreadPool in interface org.openksavi.sponge.engine.processing.ProcessingUnit<org.openksavi.sponge.filter.FilterAdapter>