org.bedework.util.misc

Class AbstractProcessorThread

java.lang.Object

java.lang.Thread

org.bedework.util.misc.AbstractProcessorThread

All Implemented Interfaces:

Runnable

public abstract class AbstractProcessorThread
extends Thread

Something to help the handling and graceful shutdown of processes.

Author:

douglm

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	debug
protected boolean	running

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractProcessorThread(String name)

Method Summary

Modifier and Type	Method and Description
abstract void	close() Close the processor.
protected void	debug(String msg)
protected void	error(String msg)
protected void	error(Throwable t)
protected org.apache.log4j.Logger	getLogger()
boolean	getRunning()
boolean	handleException(Throwable val) Override to handle certain exception types.
protected void	info(String msg)
void	run()
abstract void	runInit() Called to initialise at start of run.
abstract void	runProcess() Do whatever we're supposed to be doing.
void	setRunning(boolean val) Set the running flag
static boolean	stopProcess(AbstractProcessorThread proc) Shut down a running process.
protected void	warn(String msg)

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected boolean debug

running

protected boolean running

Constructor Detail

AbstractProcessorThread

public AbstractProcessorThread(String name)

Parameters:

name - for the thread

Method Detail

runInit

public abstract void runInit()

Called to initialise at start of run. We've already output the start of the startup message. This can add more info.

runProcess

public abstract void runProcess()
                         throws Throwable

Do whatever we're supposed to be doing.

Throws:

Throwable

close

public abstract void close()

Close the processor.

handleException

public boolean handleException(Throwable val)

Override to handle certain exception types. .

Parameters:

val - the exception

Returns:

false if we did nothing

setRunning

public void setRunning(boolean val)

Set the running flag

Parameters:

val - the flag

getRunning

public boolean getRunning()

Returns:

the running flag

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

stopProcess

public static boolean stopProcess(AbstractProcessorThread proc)

Shut down a running process.

Parameters:

proc - the thread process

Returns:

false for exception or timeout

info

protected void info(String msg)

warn

protected void warn(String msg)

debug

protected void debug(String msg)

error

protected void error(Throwable t)

error

protected void error(String msg)

getLogger

protected org.apache.log4j.Logger getLogger()