org.apache.jetspeed.aggregator

Interface Worker

public interface Worker

A Worker represents a single thread in the parallel aggregation engine. These worker threads process RenderingJob and notify its WorkerMonitor when completed. When no work is available, the worker simply sets itself in a waiting mode pending reactivation by the WorkerMonitor.

Version:

$Id: $

Author:

David Sean Taylor

Method Summary

Methods

Modifier and Type	Method and Description
Runnable	getJob() Retrieves the job to execute for this worker
int	getJobCount() Return the count of jobs this worker is processing
void	resetJobCount() Reset the processed job counter
void	setJob(Runnable job) Sets the job to execute
void	setJob(Runnable job, AccessControlContext context) Deprecated. Use only setJob(Runnable) because AccessControlContext must not be directly accessed by a worker thread. Instead AccessControlContext must be accessed directly by the job implementation in order to use the AccessControlContext instance safely regardless of the physical worker thread implementation (e.g, WorkerImpl or container managed thread by commonj worker monitor).
void	setMonitor(WorkerMonitor monitor) Sets the WorkMonitor for this worker
void	setRunning(boolean status) Sets the running status of this Worker.
void	start() Start executing the job on this worker thread

Method Detail

getJobCount

int getJobCount()

Return the count of jobs this worker is processing

Returns:

the count of jobs

resetJobCount

void resetJobCount()

Reset the processed job counter

setRunning

void setRunning(boolean status)

Sets the running status of this Worker. If set to false, the Worker will stop after processing its current job.

Parameters:

status - set to true to set this worker to running, false to turn off running

setMonitor

void setMonitor(WorkerMonitor monitor)

Sets the WorkMonitor for this worker

Parameters:

monitor - the WorkerMonitor who is monitoring this worker

setJob

void setJob(Runnable job,
          AccessControlContext context)

Deprecated. Use only setJob(Runnable) because AccessControlContext must not be directly accessed by a worker thread. Instead AccessControlContext must be accessed directly by the job implementation in order to use the AccessControlContext instance safely regardless of the physical worker thread implementation (e.g, WorkerImpl or container managed thread by commonj worker monitor).

Sets the job to execute in security context

Parameters:

job - the job to run

setJob

void setJob(Runnable job)

Sets the job to execute

Parameters:

job - the job to execute for this worker

getJob

Runnable getJob()

Retrieves the job to execute for this worker

Returns:

the job executing

start

void start()

Start executing the job on this worker thread