com.levigo.jadice.server.core

Class SubPipeline

java.lang.Object

com.levigo.jadice.server.core.SubPipeline

public class SubPipeline
extends Object

In oder to start a dynamic sub pipeline on server side during a running job this builder class can start some more nodes and workers on behalf of another node. The Nodes of this sub pipline must already be connected to each other via Node.appendSuccessor(Node) and Node.prependPredecessor(Node), but the first and last Node—which might be both the one and only Node—must be announced via the methods startWith(StreamBundle, Node) and endWith(Node, StreamBundle).

Since:

jadice server 5.3.1.0

See Also:

JobListener.subPipelineCreated(com.levigo.jadice.server.Job, Node, java.util.Set)

Method Summary

Methods

Modifier and Type	Method and Description
SubPipeline	endWith(Node lastChild, StreamBundle output) The sub pipeline shall end at the given Node and shall provide its processed data through the given StreamBundle.
static SubPipeline	forParent(NodeWorker<?> parent) Start the creation of a sub pipeline
SubPipeline	inheritLimits() Call the method if all Nodes of the sub pipeline shall inherit the Limits of the parent Node.
void	start() Creates and starts the sub pipeline.
SubPipeline	startWith(StreamBundle input, Node firstChild) The sub pipeline shall start at the given Node and will be feed with data through the given StreamBundle.

Methods inherited from class java.lang.Object

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

Method Detail

forParent

public static SubPipeline forParent(NodeWorker<?> parent)

Start the creation of a sub pipeline

Parameters:

parent - the sub pipeline will be created on behalf of this Node

Returns:

a new sub pipeline builder (fluent style API)

startWith

public SubPipeline startWith(StreamBundle input,
                    Node firstChild)

The sub pipeline shall start at the given Node and will be feed with data through the given StreamBundle. Calling this method if mandatory.

Parameters:

input - The StreamBundle that feeds the sub pipeline with data which already must be complete.

firstChild - The first Node of the sub pipeline

Returns:

the SubPipeline builder itself (fluent style API)

endWith

public SubPipeline endWith(Node lastChild,
                  StreamBundle output)

The sub pipeline shall end at the given Node and shall provide its processed data through the given StreamBundle. Calling this method if mandatory.

Parameters:

lastChild - the last Node of the sub pipeline

output - The resulting Streams of the sub pipeline shall be provided here

Returns:

the SubPipeline builder itself (fluent style API)

inheritLimits

public SubPipeline inheritLimits()

Call the method if all Nodes of the sub pipeline shall inherit the Limits of the parent Node. Calling this method if optional.

Returns:

the SubPipeline builder itself (fluent style API)

start

public void start()
           throws ConfigurationException

Creates and starts the sub pipeline. This builder must not be re-used after the start of the sub pipeline has happened.

Throws:

ConfigurationException - if preconditions were not met.