com.lucidworks.apollo.component

Class ScheduledRunnableComponent

java.lang.Object

com.lucidworks.apollo.component.ScheduledRunnableComponent

public class ScheduledRunnableComponent
extends java.lang.Object

A simple component to centralize the various scheduled tasks we have in the system. The primary benefit is to have one thread pool for occasional tasks, instead of various threads spread across various places.

Constructor Summary

Constructors

Constructor and Description
ScheduledRunnableComponent()

Method Summary

Modifier and Type	Method and Description
boolean	cancelTask(java.lang.String taskName, boolean mayInterruptIfRunning)
<any>	getTask(java.lang.String taskName)
java.util.concurrent.ScheduledFuture<?>	scheduleAtFixedRate(java.lang.String taskName, java.lang.Runnable runnable, long initialDelay, long period, java.util.concurrent.TimeUnit timeUnit) Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is executions will commence after initialDelay then initialDelay+period, then initialDelay + 2 * period, and so on.
<T> java.util.concurrent.ScheduledFuture<T>	scheduleOnce(java.lang.String taskName, java.util.concurrent.Callable<T> callable, long delay, java.util.concurrent.TimeUnit timeUnit) Creates and executes a ScheduledFuture that becomes enabled after the given delay.
java.util.concurrent.ScheduledFuture<?>	scheduleOnce(java.lang.String taskName, java.lang.Runnable runnable, long delay, java.util.concurrent.TimeUnit timeUnit) Creates and executes a one-shot action that becomes enabled after the given delay.
java.util.concurrent.ScheduledFuture<?>	scheduleUntilSuccessful(java.lang.String taskName, java.util.concurrent.Callable<java.lang.Boolean> callable, long initialDelay, long delay, java.util.concurrent.TimeUnit timeUnit)
java.util.concurrent.ScheduledFuture<?>	scheduleWithFixedDelay(java.lang.String taskName, java.lang.Runnable runnable, long initialDelay, long delay, java.util.concurrent.TimeUnit timeUnit) Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduledRunnableComponent

public ScheduledRunnableComponent()

Method Detail

scheduleWithFixedDelay

public java.util.concurrent.ScheduledFuture<?> scheduleWithFixedDelay(java.lang.String taskName,
                                                                      java.lang.Runnable runnable,
                                                                      long initialDelay,
                                                                      long delay,
                                                                      java.util.concurrent.TimeUnit timeUnit)

Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor. If taskName is already in use, the previous task will be cancelled and replaced!

Parameters:

taskName - a unique identifier for this task. This can be used to look up or cancel the task at a later time.

runnable - the task to execute

initialDelay - the time to delay first execution

delay - the delay between the termination of one execution and the commencement of the next

timeUnit - the time unit of the initialDelay and delay parameters

Returns:

a ScheduledFuture representing pending completion of the task, and whose get() method will throw an exception upon cancellation

Throws:

java.util.concurrent.RejectedExecutionException - if the task cannot be scheduled for execution

java.lang.NullPointerException - if command is null

java.lang.IllegalArgumentException - if delay less than or equal to zero

scheduleUntilSuccessful

public java.util.concurrent.ScheduledFuture<?> scheduleUntilSuccessful(java.lang.String taskName,
                                                                       java.util.concurrent.Callable<java.lang.Boolean> callable,
                                                                       long initialDelay,
                                                                       long delay,
                                                                       java.util.concurrent.TimeUnit timeUnit)

scheduleOnce

public java.util.concurrent.ScheduledFuture<?> scheduleOnce(java.lang.String taskName,
                                                            java.lang.Runnable runnable,
                                                            long delay,
                                                            java.util.concurrent.TimeUnit timeUnit)

Creates and executes a one-shot action that becomes enabled after the given delay. If taskName is already in use, the previous task will be cancelled and replaced!

Parameters:

taskName - a unique identifier for this task. This can be used to look up or cancel the task at a later time.

runnable - the task to execute

delay - the time from now to delay execution

timeUnit - the time unit of the delay parameter

Returns:

a ScheduledFuture representing pending completion of the task and whose get() method will return null upon completion

Throws:

java.util.concurrent.RejectedExecutionException - if the task cannot be scheduled for execution

java.lang.NullPointerException - if command is null

scheduleOnce

public <T> java.util.concurrent.ScheduledFuture<T> scheduleOnce(java.lang.String taskName,
                                                                java.util.concurrent.Callable<T> callable,
                                                                long delay,
                                                                java.util.concurrent.TimeUnit timeUnit)

Creates and executes a ScheduledFuture that becomes enabled after the given delay. If taskName is already in use, the previous task will be cancelled and replaced!

Parameters:

taskName - a unique identifier for this task. This can be used to look up or cancel the task at a later time.

callable - the function to execute

delay - the time from now to delay execution

timeUnit - the time unit of the delay parameter

Returns:

a ScheduledFuture representing pending completion of the task and whose get() method will return null upon completion

Throws:

java.util.concurrent.RejectedExecutionException - if the task cannot be scheduled for execution

java.lang.NullPointerException - if command is null

scheduleAtFixedRate

public java.util.concurrent.ScheduledFuture<?> scheduleAtFixedRate(java.lang.String taskName,
                                                                   java.lang.Runnable runnable,
                                                                   long initialDelay,
                                                                   long period,
                                                                   java.util.concurrent.TimeUnit timeUnit)

Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is executions will commence after initialDelay then initialDelay+period, then initialDelay + 2 * period, and so on. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor. If any execution of this task takes longer than its period, then subsequent executions may start late, but will not concurrently execute. If taskName is already in use, the previous task will be cancelled and replaced!

Parameters:

taskName - a unique identifier for this task. This can be used to look up or cancel the task at a later time.

runnable - the task to execute

initialDelay - the time to delay first execution

period - the period between successive executions

timeUnit - the time unit of the initialDelay and period parameters

Returns:

a ScheduledFuture representing pending completion of the task, and whose get() method will throw an exception upon cancellation

Throws:

java.util.concurrent.RejectedExecutionException - if the task cannot be scheduled for execution

java.lang.NullPointerException - if command is null

java.lang.IllegalArgumentException - if period less than or equal to zero

cancelTask

public boolean cancelTask(java.lang.String taskName,
                          boolean mayInterruptIfRunning)

Returns:

false if the task could not be cancelled, either because it has already completed normally or because it does not exist; true otherwise

getTask

public <any> getTask(java.lang.String taskName)