Package eu.rarogsoftware.rarog.platform.api.task

Interface TaskManager

All Known Implementing Classes:

DefaultTaskManager

public interface TaskManager

Manages background task ran using ExecutorService.

It can be treated as adapter on ExecutorService, that adds support for:

• task monitoring,
• system wide thread pool,
• manageable pool size,
• throttling,
• easy scheduling and conditioning.

Overall it is always preferable to use TaskManager instead of ExecutorService or Thread. It is designed for short tasks, tasks that share the same memory pool (JVM) as main job, tasks that blocks request execution and all other kinds of light tasks, that don't need to be plugin state aware.

If you need support for long running tasks, tasks that must work even after restart, tasks that may wait for execution, or even can be started on different machine, you should consider using BackgroundJobManager. It provides support for heavy jobs and is plugin aware.

Usage:

         Some source code here
     

See Also:

• BackgroundJobManager
• ScheduledFuture
• FutureTask

Method Summary

Modifier and Type	Method	Description
AdvancedScheduledExecutorService	asExecutorService()	Returns ScheduledExecutorService that provide the same functionality as TaskManager
ThreadFactory	asThreadFactory()	Returns ThreadFactory that provide the same functionality as TaskManager
Thread	createThread(Runnable task)	Start new monitored thread outside of thread pool.
Future<?>	runTask(Runnable task)	Runs provided task as soon as there is free thread in the pool.
<T> Future<T>	runTask(Callable<T> task)	Runs provided task as soon as there is free thread in the pool.
ScheduledFuture<?>	scheduleTask(Runnable task, ScheduleConfig<Void> scheduleConfig)	Runs provided task using provided config
<T> ScheduledFuture<T>	scheduleTask(Callable<T> task, ScheduleConfig<T> scheduleConfig)	Runs provided task using provided config

Method Details

createThread

Thread createThread(Runnable task)

Start new monitored thread outside of thread pool. It's equivalent of Thread(Runnable)

Parameters:

task - task to run

Returns:

not started thread with monitoring

runTask

Future<?> runTask(Runnable task)

Runs provided task as soon as there is free thread in the pool.

Parameters:

task - task to run

Returns:

the same Future that would be returned by ExecutorService

runTask

<T> Future<T> runTask(Callable<T> task)

Runs provided task as soon as there is free thread in the pool.

Parameters:

task - task to run

Returns:

the same Future that would be returned by ExecutorService

scheduleTask

ScheduledFuture<?> scheduleTask(Runnable task,
 ScheduleConfig<Void> scheduleConfig)

Runs provided task using provided config

Parameters:

task - task to run

scheduleConfig - config for scheduling task

Returns:

controller for scheduled task

scheduleTask

<T> ScheduledFuture<T> scheduleTask(Callable<T> task,
 ScheduleConfig<T> scheduleConfig)

Runs provided task using provided config

Parameters:

task - task to run

scheduleConfig - config for scheduling task

Returns:

controller for scheduled task

asThreadFactory

ThreadFactory asThreadFactory()

Returns ThreadFactory that provide the same functionality as TaskManager

Returns:

ThreadFactory

asExecutorService

AdvancedScheduledExecutorService asExecutorService()

Returns ScheduledExecutorService that provide the same functionality as TaskManager

Returns:

ScheduledExecutorService