Package org.opensearch.common.util.concurrent

Class AbstractRunnable

java.lang.Object

org.opensearch.common.util.concurrent.AbstractRunnable

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

AbstractLifecycleRunnable, ActionRunnable, Scheduler.ReschedulingRunnable, TaskAwareRunnable

public abstract class AbstractRunnable
extends Object
implements Runnable

An extension to runnable.

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
AbstractRunnable()

Method Summary

Modifier and Type	Method	Description
protected abstract void	doRun()	This method has the same semantics as Runnable.run()
boolean	isForceExecution()	Should the runnable force its execution in case it gets rejected?
void	onAfter()	This method is called in a finally block after successful execution or on a rejection.
abstract void	onFailure(Exception e)	This method is invoked for all exception thrown by doRun()
void	onRejection(Exception e)	This should be executed if the thread-pool executing this action rejected the execution.
final void	run()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractRunnable

public AbstractRunnable()

Method Details

isForceExecution

public boolean isForceExecution()

Should the runnable force its execution in case it gets rejected?

run

public final void run()

Specified by:

run in interface Runnable

onAfter

public void onAfter()

This method is called in a finally block after successful execution or on a rejection.

onFailure

public abstract void onFailure(Exception e)

This method is invoked for all exception thrown by doRun()

onRejection

public void onRejection(Exception e)

This should be executed if the thread-pool executing this action rejected the execution. The default implementation forwards to onFailure(Exception)

doRun

protected abstract void doRun()
                       throws Exception

This method has the same semantics as Runnable.run()

Throws:

InterruptedException - if the run method throws an InterruptedException

Exception