Class DefaultPipelineController

java.lang.Object

io.aleph0.yap.core.pipeline.DefaultPipelineController

All Implemented Interfaces:

PipelineController

public class DefaultPipelineController
extends Object
implements PipelineController

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultPipelineController.Builder
static enum	DefaultPipelineController.PipelineState	The internal state of a pipeline.

Constructor Summary

Constructors

Constructor	Description
DefaultPipelineController(Map<String,Set<String>> graph, Duration heartbeatInterval)	Create a new pipeline controller.

Method Summary

Modifier and Type	Method	Description
static DefaultPipelineController.Builder	builder()
Duration	getHeartbeatInterval()	The maximum amount of time to wait for a lifecycle event, after which PipelineController.onHeartbeat() will be called.
List<PipelineAction>	onCancelRequested()	Called when the pipeline has been requested to be cancelled.
List<PipelineAction>	onHeartbeat()	Called when no lifecycle events have occurred within the heartbeat interval.
void	onPipelineCancelled()	Called when the pipeline has been cancelled.
void	onPipelineCompleted()	Called when the pipeline has been completed.
void	onPipelineFailed(ExecutionException error)	Called when the pipeline has failed.
List<PipelineAction>	onPipelineStarted()	Called when the pipeline has been started.
List<PipelineAction>	onTaskCancelled(String id)	Called when a task has been cancelled.
List<PipelineAction>	onTaskCompleted(String id)	Called when a task has been completed.
List<PipelineAction>	onTaskFailed(String id, Throwable error)	Called when a task has failed.
List<PipelineAction>	onTaskStarted(String id)	Called when a task has been started.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultPipelineController

public DefaultPipelineController(Map<String,Set<String>> graph,
 Duration heartbeatInterval)

Create a new pipeline controller.

Parameters:

graph - The pipeline graph, where keys are task IDs and values are the IDs of tasks that subscribe to the task, i.e., treat it as a source of data.

Method Details

builder

public static DefaultPipelineController.Builder builder()

onPipelineStarted

public List<PipelineAction> onPipelineStarted()

Description copied from interface: PipelineController

Called when the pipeline has been started. Called as the first event only.

Specified by:

onPipelineStarted in interface PipelineController

Returns:

the next actions to perform

onTaskStarted

public List<PipelineAction> onTaskStarted(String id)

Description copied from interface: PipelineController

Called when a task has been started. Called for each task as the first event.

Specified by:

onTaskStarted in interface PipelineController

Parameters:

id - the id of the task

Returns:

the next actions to perform

onTaskCompleted

public List<PipelineAction> onTaskCompleted(String id)

Description copied from interface: PipelineController

Called when a task has been completed. No more events will be sent for this task.

Specified by:

onTaskCompleted in interface PipelineController

Parameters:

id - the id of the task

Returns:

the next actions to perform

onTaskCancelled

public List<PipelineAction> onTaskCancelled(String id)

Description copied from interface: PipelineController

Called when a task has been cancelled. No more events will be sent for this task.

Specified by:

onTaskCancelled in interface PipelineController

Parameters:

id - the id of the task

Returns:

the next actions to perform

onTaskFailed

public List<PipelineAction> onTaskFailed(String id,
 Throwable error)

Description copied from interface: PipelineController

Called when a task has failed. No more events will be sent for this task.

Specified by:

onTaskFailed in interface PipelineController

Parameters:

id - the id of the task

error - the error that caused the task to fail

Returns:

the next actions to perform

onHeartbeat

public List<PipelineAction> onHeartbeat()

Description copied from interface: PipelineController

Called when no lifecycle events have occurred within the heartbeat interval. This ensures that the controller has periodic access to execute actions even if no lifecycle events are occurring, for example to time out tasks or to perform maintenance tasks.

Specified by:

onHeartbeat in interface PipelineController

Returns:

the next action to perform

onCancelRequested

public List<PipelineAction> onCancelRequested()

Description copied from interface: PipelineController

Called when the pipeline has been requested to be cancelled. This is a request, not a command, and the pipeline may choose to ignore it.

Specified by:

onCancelRequested in interface PipelineController

Returns:

the next actions to perform

onPipelineCompleted

public void onPipelineCompleted()

Description copied from interface: PipelineController

Called when the pipeline has been completed. This is the last event that will be called.

Specified by:

onPipelineCompleted in interface PipelineController

onPipelineFailed

public void onPipelineFailed(ExecutionException error)

Description copied from interface: PipelineController

Called when the pipeline has failed. This is the last event that will be called.

Specified by:

onPipelineFailed in interface PipelineController

onPipelineCancelled

public void onPipelineCancelled()

Description copied from interface: PipelineController

Called when the pipeline has been cancelled. This is the last event that will be called.

Specified by:

onPipelineCancelled in interface PipelineController

getHeartbeatInterval

public Duration getHeartbeatInterval()

Description copied from interface: PipelineController

The maximum amount of time to wait for a lifecycle event, after which PipelineController.onHeartbeat() will be called.

Specified by:

getHeartbeatInterval in interface PipelineController