com.yahoo.bard.webservice.application

Class LoadTask<V>

java.lang.Object

com.yahoo.bard.webservice.application.LoadTask<V>

Type Parameters:

V - The type of the result returned by the task associated with this loader.

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

DataSourceMetadataLoadTask, DimensionValueLoadTask, RegisteredLookupMetadataLoadTask

public abstract class LoadTask<V>
extends Object
implements Runnable

Defines a task that is scheduled to run at a given time, potentially periodically.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	LoadTask.TaskFailureCallback A basic nested class dealing with failures that can be re-used by classes extending LoadTask.
protected class	LoadTask.TaskHttpErrorCallback A basic nested class dealing with http errors that can be re-used by classes extending LoadTask.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	delay
protected ScheduledFuture<?>	future
protected boolean	isPeriodic
protected String	loaderName
protected long	period

Constructor Summary

Constructors

Constructor and Description
LoadTask(String loaderName, long delay) Creates a one-off loader.
LoadTask(String loaderName, long delay, long period) Creates a periodic loader.

Method Summary

Modifier and Type	Method and Description
long	getDefinedDelay() Get the defined delay of this loader in milliseconds.
long	getDefinedPeriod() Get the defined period of this loader in milliseconds.
protected HttpErrorCallback	getErrorCallback() Get a default callback for an http error.
protected FailureCallback	getFailureCallback() Get a default callback to use when a failure occurs.
Optional<ScheduledFuture<?>>	getFuture() Get the future associated with the execution of this loader.
String	getName() Return the name of this loader.
boolean	isPeriodic() Return whether this loader is periodic or one-off.
abstract void	run()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

loaderName

protected final String loaderName

delay

protected final long delay

period

protected final long period

isPeriodic

protected final boolean isPeriodic

future

protected ScheduledFuture<?> future

Constructor Detail

LoadTask

public LoadTask(String loaderName,
                long delay)

Creates a one-off loader.

Parameters:

loaderName - The name of the loader.

delay - The initial delay of this loader in milliseconds.

LoadTask

public LoadTask(String loaderName,
                long delay,
                long period)

Creates a periodic loader.

Parameters:

loaderName - The name of the loader.

delay - The initial delay of this loader in milliseconds.

period - The period of this loader in milliseconds. Zero period corresponds to a one-off loader.

Method Detail

run

public abstract void run()

Specified by:

run in interface Runnable

getName

public String getName()

Return the name of this loader.

Returns:

A String representing the name of the loader.

toString

public String toString()

Overrides:

toString in class Object

isPeriodic

public boolean isPeriodic()

Return whether this loader is periodic or one-off.

Returns:

Returns true if this loader is periodic.

getDefinedDelay

public long getDefinedDelay()

Get the defined delay of this loader in milliseconds.

Returns:

The delay in milliseconds.

getDefinedPeriod

public long getDefinedPeriod()

Get the defined period of this loader in milliseconds.

Returns:

The period in milliseconds. It returns zero if this is a one-off loader.

getFuture

public Optional<ScheduledFuture<?>> getFuture()

Get the future associated with the execution of this loader. If the loader has not been scheduled yet via the TaskScheduler this method will return an empty Optional.

Returns:

An optional containing the future of this loader after it is scheduled.

getErrorCallback

protected HttpErrorCallback getErrorCallback()

Get a default callback for an http error.

Returns:

A newly created http error callback object.

getFailureCallback

protected FailureCallback getFailureCallback()

Get a default callback to use when a failure occurs.

Returns:

A newly created failure callback object.