Package org.copperengine.core.common

Class PriorityProcessorPool

java.lang.Object

org.copperengine.core.common.PriorityProcessorPool

All Implemented Interfaces:

ProcessorPool, org.copperengine.management.ProcessorPoolMXBean

Direct Known Subclasses:

PersistentPriorityProcessorPool, TransientPriorityProcessorPool

public abstract class PriorityProcessorPool
extends java.lang.Object
implements ProcessorPool, org.copperengine.management.ProcessorPoolMXBean

A ProcessorPool implementation using a priority queue.

Field Summary

Fields

Modifier and Type	Field	Description
protected ProcessorFactory	processorFactory
protected SuspendableQueue<Workflow<?>>	queue

Constructor Summary

Constructors

Constructor	Description
PriorityProcessorPool()	Creates a new PriorityProcessorPool with as many worker threads as processors available on the corresponding environment.
PriorityProcessorPool(java.lang.String id)	Creates a new PriorityProcessorPool with as many worker threads as processors available on the corresponding environment.
PriorityProcessorPool(java.lang.String id, int numberOfThreads)

Method Summary

Modifier and Type	Method	Description
protected java.util.Queue<Workflow<?>>	createQueue()	Creates a new instance of WfPriorityQueue
protected ProcessingEngine	getEngine()
java.lang.String	getId()
int	getMemoryQueueSize()
int	getNumberOfActiveThreads()
int	getNumberOfThreads()
java.lang.String	getProcessorPoolState()
ProcessorPoolState	getState()
int	getThreadPriority()
void	resume()	Resume processing of workflows
void	setEngine(ProcessingEngine engine)	Called internally by COPPER during initialization
void	setId(java.lang.String id)
void	setNumberOfThreads(int numberOfThreads)
void	setProcessorFactory(ProcessorFactory processorFactory)
void	setShutdownWaitIntervalMSec(int shutdownWaitIntervalMSec)	This processor pool wait up to the specified number of milliseconds until all of its Processors are terminated.
void	setThreadPriority(int threadPriority)
void	shutdown()	Shuts down the processor pool
void	startup()	Starts up the processor pool
void	suspend()	Suspend processing of workflows.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.copperengine.management.ProcessorPoolMXBean

getQueueSize

Field Detail

queue

protected final SuspendableQueue<Workflow<?>> queue

processorFactory

protected ProcessorFactory processorFactory

Constructor Detail

PriorityProcessorPool

public PriorityProcessorPool()

Creates a new PriorityProcessorPool with as many worker threads as processors available on the corresponding environment. id needs to be initialized later using the setter.

PriorityProcessorPool

public PriorityProcessorPool(java.lang.String id)

Creates a new PriorityProcessorPool with as many worker threads as processors available on the corresponding environment.

Parameters:

id - id for the new created pool. Must be unique and shall not be longer than 32 characters which is the limit to be stored for the processor pool ids when using persistent engines.

PriorityProcessorPool

public PriorityProcessorPool(java.lang.String id,
                             int numberOfThreads)

Method Detail

createQueue

protected java.util.Queue<Workflow<?>> createQueue()

Creates a new instance of WfPriorityQueue

Returns:

the new created instance.

setShutdownWaitIntervalMSec

public void setShutdownWaitIntervalMSec(int shutdownWaitIntervalMSec)

This processor pool wait up to the specified number of milliseconds until all of its Processors are terminated. A value ≤ 0 means, that the processor pool will not wait at all.

Parameters:

shutdownWaitIntervalMSec - wait interval in milliseconds

setEngine

public void setEngine(ProcessingEngine engine)

Description copied from interface: ProcessorPool

Called internally by COPPER during initialization

Specified by:

setEngine in interface ProcessorPool

Parameters:

engine - engine which holds the ProcessorPool

setId

public void setId(java.lang.String id)

setNumberOfThreads

public void setNumberOfThreads(int numberOfThreads)

Specified by:

setNumberOfThreads in interface org.copperengine.management.ProcessorPoolMXBean

getNumberOfThreads

public int getNumberOfThreads()

Specified by:

getNumberOfThreads in interface org.copperengine.management.ProcessorPoolMXBean

setThreadPriority

public void setThreadPriority(int threadPriority)

Specified by:

setThreadPriority in interface org.copperengine.management.ProcessorPoolMXBean

getThreadPriority

public int getThreadPriority()

Specified by:

getThreadPriority in interface org.copperengine.management.ProcessorPoolMXBean

getId

public java.lang.String getId()

Specified by:

getId in interface ProcessorPool

Specified by:

getId in interface org.copperengine.management.ProcessorPoolMXBean

Returns:

the processor pools identifier

shutdown

public void shutdown()

Description copied from interface: ProcessorPool

Shuts down the processor pool

Specified by:

shutdown in interface ProcessorPool

startup

public void startup()

Description copied from interface: ProcessorPool

Starts up the processor pool

Specified by:

startup in interface ProcessorPool

getEngine

protected ProcessingEngine getEngine()

getMemoryQueueSize

public int getMemoryQueueSize()

Specified by:

getMemoryQueueSize in interface org.copperengine.management.ProcessorPoolMXBean

resume

public void resume()

Description copied from interface: ProcessorPool

Resume processing of workflows

Specified by:

resume in interface ProcessorPool

Specified by:

resume in interface org.copperengine.management.ProcessorPoolMXBean

suspend

public void suspend()

Description copied from interface: ProcessorPool

Suspend processing of workflows.

Specified by:

suspend in interface ProcessorPool

Specified by:

suspend in interface org.copperengine.management.ProcessorPoolMXBean

setProcessorFactory

public void setProcessorFactory(ProcessorFactory processorFactory)

getProcessorPoolState

public java.lang.String getProcessorPoolState()

Specified by:

getProcessorPoolState in interface org.copperengine.management.ProcessorPoolMXBean

getState

public ProcessorPoolState getState()

getNumberOfActiveThreads

public int getNumberOfActiveThreads()

Specified by:

getNumberOfActiveThreads in interface org.copperengine.management.ProcessorPoolMXBean