com.lucidworks.apollo.pipeline

Class Pipeline<M>

java.lang.Object

com.lucidworks.apollo.pipeline.Pipeline<M>

All Implemented Interfaces:

Lifecycle

Direct Known Subclasses:

IndexPipeline

public class Pipeline<M>
extends java.lang.Object
implements Lifecycle

Main runtime support for a pipeline (the actual thing that runs) Controls wiring the stages together, starting, and stopping them. TODO suspending/resuming plugins for stages

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pipeline.State

Method Summary

Modifier and Type	Method and Description
void	addStateListener(java.lang.Runnable runnable, Pipeline.State... states)
java.util.Map<java.lang.String,java.util.Collection<RuntimeStage.ThrowableAndMessage<M>>>	getErrors() Collect errors from the stages
java.lang.String	getInstanceId()
MetricRegistry	getMetrics()
java.lang.String	getPipelineId()
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
long	getRunningTimeMs()
java.util.List<RuntimeStage<M>>	getStages()
<any>	getStartTime()
Pipeline.State	getState()
boolean	isInState(Pipeline.State... states)
boolean	isTerminalState()
boolean	maybeStop()
long	send(java.util.Iterator<M> messages, Context requestContext)
void	send(M message, Context requestContext)
void	send(M message, java.util.Map<java.lang.String,java.lang.String> requestProperties)
void	send(M message, java.util.Map<java.lang.String,java.lang.String> requestProperties, StageCallback<M> callback)
void	sendEndOfBatch(Context requestContext) for use when messages are being sent through the non iterators method when a downstream consumer needs to know that the last pipeline message has been sent
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Method Detail

getInstanceId

public java.lang.String getInstanceId()

getPipelineId

public java.lang.String getPipelineId()

getState

public Pipeline.State getState()

getMetrics

public MetricRegistry getMetrics()

getStartTime

public <any> getStartTime()

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

getStages

public java.util.List<RuntimeStage<M>> getStages()

getRunningTimeMs

public long getRunningTimeMs()

getErrors

public java.util.Map<java.lang.String,java.util.Collection<RuntimeStage.ThrowableAndMessage<M>>> getErrors()

Collect errors from the stages

Returns:

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

maybeStop

public boolean maybeStop()

send

public void send(M message,
                 java.util.Map<java.lang.String,java.lang.String> requestProperties)

send

public void send(M message,
                 java.util.Map<java.lang.String,java.lang.String> requestProperties,
                 StageCallback<M> callback)

send

public void send(M message,
                 Context requestContext)

send

public long send(java.util.Iterator<M> messages,
                 Context requestContext)

Parameters:

messages - - Iterator of pipeline messages

requestContext -

Returns:

total number of messages from Iterator sent to a pipeline

sendEndOfBatch

public void sendEndOfBatch(Context requestContext)

for use when messages are being sent through the non iterators method when a downstream consumer needs to know that the last pipeline message has been sent

Parameters:

requestContext -

addStateListener

public void addStateListener(java.lang.Runnable runnable,
                             Pipeline.State... states)

isInState

public boolean isInState(Pipeline.State... states)

isTerminalState

public boolean isTerminalState()