org.openforis.concurrency

Class Worker

java.lang.Object

org.openforis.concurrency.Worker

Direct Known Subclasses:

Job, Task

public abstract class Worker
extends Object

Base class for asynchronous

Author:

M. Togna, S. Ricci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Worker.Status

Constructor Summary

Constructors

Constructor and Description
Worker()

Method Summary

Modifier and Type	Method and Description
void	abort()
void	addStatusChangeListener(WorkerStatusChangeListener listener)
protected void	afterExecute()
protected void	afterExecuteInternal()
protected void	beforeExecute()
protected void	beforeExecuteInternal()
protected void	changeStatus(Worker.Status newStatus)
protected void	createInternalVariables()
void	destroy()
protected abstract void	execute()
long	getDuration()
long	getEndTime()
String	getErrorMessage()
String[]	getErrorMessageArgs()
UUID	getId()
Throwable	getLastException()
String	getName()
abstract int	getProgressPercent()
long	getStartTime()
Worker.Status	getStatus()
int	getWeight()
void	initialize()
protected void	initializeInternalVariables()
boolean	isAborted()
boolean	isCompleted()
boolean	isEnded() If task was run and finished, aborted or failed
boolean	isFailed()
boolean	isPending()
boolean	isRunning()
protected org.apache.commons.logging.Log	log()
protected void	notifyAllStatusChangeListeners(WorkerStatusChangeEvent event)
protected void	onAborted()
protected void	onCompleted()
protected void	onEnd()
protected void	onFailed()
protected void	release() Releases the resource used during the execution
void	removeStatusChangeListener(WorkerStatusChangeListener listener)
protected void	run()
protected void	setErrorMessage(String errorMessage)
protected void	setErrorMessageArgs(String[] errorMessageArgs)
protected void	setLastException(Throwable lastException)
void	setWeight(int weight)
protected void	validateInput()
boolean	waitFor(int timeoutMillis)

Methods inherited from class java.lang.Object

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

Constructor Detail

Worker

public Worker()

Method Detail

initialize

public void initialize()

validateInput

protected void validateInput()
                      throws Throwable

Throws:

Throwable

createInternalVariables

protected void createInternalVariables()
                                throws Throwable

Throws:

Throwable

initializeInternalVariables

protected void initializeInternalVariables()
                                    throws Throwable

Throws:

Throwable

beforeExecute

protected void beforeExecute()

beforeExecuteInternal

protected void beforeExecuteInternal()
                              throws Throwable

Throws:

Throwable

execute

protected abstract void execute()
                         throws Throwable

Throws:

Throwable

afterExecute

protected void afterExecute()

afterExecuteInternal

protected void afterExecuteInternal()

addStatusChangeListener

public void addStatusChangeListener(WorkerStatusChangeListener listener)

removeStatusChangeListener

public void removeStatusChangeListener(WorkerStatusChangeListener listener)

getName

public String getName()

run

protected void run()

abort

public void abort()

changeStatus

protected void changeStatus(Worker.Status newStatus)

onEnd

protected void onEnd()

onCompleted

protected void onCompleted()

onFailed

protected void onFailed()

onAborted

protected void onAborted()

destroy

public void destroy()

release

protected void release()

Releases the resource used during the execution

notifyAllStatusChangeListeners

protected void notifyAllStatusChangeListeners(WorkerStatusChangeEvent event)

getDuration

public long getDuration()

isPending

public boolean isPending()

isRunning

public boolean isRunning()

isFailed

public boolean isFailed()

isAborted

public boolean isAborted()

isCompleted

public boolean isCompleted()

getProgressPercent

public abstract int getProgressPercent()

isEnded

public boolean isEnded()

If task was run and finished, aborted or failed

Returns:

getStatus

public Worker.Status getStatus()

getStartTime

public long getStartTime()

getEndTime

public long getEndTime()

getLastException

public Throwable getLastException()

getId

public UUID getId()

log

protected org.apache.commons.logging.Log log()

getErrorMessage

public String getErrorMessage()

setErrorMessage

protected void setErrorMessage(String errorMessage)

getErrorMessageArgs

public String[] getErrorMessageArgs()

getWeight

public int getWeight()

setWeight

public void setWeight(int weight)

setErrorMessageArgs

protected void setErrorMessageArgs(String[] errorMessageArgs)

setLastException

protected void setLastException(Throwable lastException)

waitFor

public boolean waitFor(int timeoutMillis)