org.apache.excalibur.event.command

Class AbstractThreadManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.excalibur.event.command.AbstractThreadManager

All Implemented Interfaces:

java.lang.Runnable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.logger.LogEnabled, org.apache.excalibur.event.command.ThreadManager

Direct Known Subclasses:

DefaultThreadManager, TPCThreadManager

public abstract class AbstractThreadManager
extends org.apache.avalon.framework.logger.AbstractLogEnabled
implements java.lang.Runnable, org.apache.excalibur.event.command.ThreadManager, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.activity.Disposable

Abstract base class for a ThreadManager that has a single ThreadPool for all pipelines

Author:

Avalon Development Team

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractThreadManager.PipelineRunner The PipelineRunner class pulls all the events from the Source, and puts them in the EventHandler.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	m_done Whether we are done or not
private EDU.oswego.cs.dl.util.concurrent.Executor	m_executor The ThreadPool we are using
private boolean	m_initialized Whether this class has been initialized or not
private org.apache.commons.collections.StaticBucketMap	m_pipelines The pipelines we are managing
private long	m_sleepTime The number of milliseconds to sleep before runngin again: 1000 (1 sec.)

Fields inherited from interface org.apache.excalibur.event.command.ThreadManager

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractThreadManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	deregister(org.apache.excalibur.event.command.EventPipeline pipeline) Deregister an EventPipeline with the ThreadManager
void	deregisterAll() Deregisters all EventPipelines from this ThreadManager
void	dispose() Get rid of the ThreadManager.
protected void	doDispose()
protected long	getSleepTime() Get the current amount of sleep time.
void	initialize() Set up the ThreadManager.
protected boolean	isInitialized() Return whether the thread manager has been initialized or not
void	register(org.apache.excalibur.event.command.EventPipeline pipeline) Register an EventPipeline with the ThreadManager.
void	run() The code that is run in the background to manage the ThreadPool and the EventPipelines
protected void	setExecutor(EDU.oswego.cs.dl.util.concurrent.Executor executor) Set the executor we are using
protected void	setSleepTime(long sleepTime) Set the amount of time to sleep between checks on the queue

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.excalibur.event.command.ThreadManager

Field Detail

m_pipelines

private final org.apache.commons.collections.StaticBucketMap m_pipelines

The pipelines we are managing

m_executor

private EDU.oswego.cs.dl.util.concurrent.Executor m_executor

The ThreadPool we are using

m_done

private volatile boolean m_done

Whether we are done or not

m_sleepTime

private long m_sleepTime

The number of milliseconds to sleep before runngin again: 1000 (1 sec.)

m_initialized

private volatile boolean m_initialized

Whether this class has been initialized or not

Constructor Detail

AbstractThreadManager

public AbstractThreadManager()

Method Detail

isInitialized

protected boolean isInitialized()

Return whether the thread manager has been initialized or not

setSleepTime

protected void setSleepTime(long sleepTime)

Set the amount of time to sleep between checks on the queue

Parameters:

sleepTime - Number of milliseconds

getSleepTime

protected long getSleepTime()

Get the current amount of sleep time.

setExecutor

protected void setExecutor(EDU.oswego.cs.dl.util.concurrent.Executor executor)

Set the executor we are using

Parameters:

executor - to use

initialize

public void initialize()
                throws java.lang.Exception

Set up the ThreadManager. All required parameters must have already been set.

Specified by:

initialize in interface org.apache.avalon.framework.activity.Initializable

Throws:

java.lang.Exception - if there is any problem setting up the ThreadManager

register

public void register(org.apache.excalibur.event.command.EventPipeline pipeline)

Register an EventPipeline with the ThreadManager.

Specified by:

register in interface org.apache.excalibur.event.command.ThreadManager

Parameters:

pipeline - The pipeline we are registering

deregister

public void deregister(org.apache.excalibur.event.command.EventPipeline pipeline)

Deregister an EventPipeline with the ThreadManager

Specified by:

deregister in interface org.apache.excalibur.event.command.ThreadManager

Parameters:

pipeline - The pipeline we are de-registering

deregisterAll

public void deregisterAll()

Deregisters all EventPipelines from this ThreadManager

Specified by:

deregisterAll in interface org.apache.excalibur.event.command.ThreadManager

dispose

public void dispose()

Get rid of the ThreadManager.

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable

doDispose

protected void doDispose()

run

public void run()

The code that is run in the background to manage the ThreadPool and the EventPipelines

Specified by:

run in interface java.lang.Runnable