org.nuxeo.ecm.core.bulk.computation

Class BulkScrollerComputation

java.lang.Object

org.nuxeo.lib.stream.computation.AbstractComputation

org.nuxeo.ecm.core.bulk.computation.BulkScrollerComputation

All Implemented Interfaces:

Computation

public class BulkScrollerComputation
extends AbstractComputation

Materializes the document set for a command.

Inputs:

• i1: Reads a stream of BulkCommand sharded by action

Outputs:

• - "actionName": Writes BulkBucket into the action stream
• - "status": Writes BulkStatus into the action stream

Since:

10.2

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	documentIds
static int	MAX_SCROLL_SIZE
protected int	scrollBatchSize
protected int	scrollKeepAliveSeconds

Fields inherited from class org.nuxeo.lib.stream.computation.AbstractComputation

INPUT_1, INPUT_2, INPUT_3, metadata, OUTPUT_1, OUTPUT_2, OUTPUT_3, OUTPUT_4

Constructor Summary

Constructors

Constructor and Description
BulkScrollerComputation(String name, int nbOutputStreams, int scrollBatchSize, int scrollKeepAliveSeconds, boolean produceImmediate)

Method Summary

Modifier and Type	Method and Description
protected boolean	isAbortedCommand(String commandId)
protected void	processRecord(ComputationContext context, Record record)
void	processRecord(ComputationContext context, String inputStreamName, Record record) Process an incoming record on one of the computation's input streams.
protected void	produceBucket(ComputationContext context, String action, String commandId, int bucketSize, long bucketNumber) Produces a bucket as a record to appropriate bulk action stream.
protected void	updateStatusAfterScroll(ComputationContext context, String commandId, long documentCount)
protected void	updateStatusAfterScroll(ComputationContext context, String commandId, long documentCount, String errorMessage)
protected void	updateStatusAfterScroll(ComputationContext context, String commandId, String errorMessage)
protected void	updateStatusAsScrolling(ComputationContext context, String commandId)

Methods inherited from class org.nuxeo.lib.stream.computation.AbstractComputation

init, metadata, processFailure, processRetry, processTimer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.lib.stream.computation.Computation

destroy, signalStop

Field Detail

MAX_SCROLL_SIZE

public static final int MAX_SCROLL_SIZE

See Also:

Constant Field Values

scrollBatchSize

protected final int scrollBatchSize

scrollKeepAliveSeconds

protected final int scrollKeepAliveSeconds

documentIds

protected final List<String> documentIds

Constructor Detail

BulkScrollerComputation

public BulkScrollerComputation(String name,
                               int nbOutputStreams,
                               int scrollBatchSize,
                               int scrollKeepAliveSeconds,
                               boolean produceImmediate)

Parameters:

name - the computation name

nbOutputStreams - the number of registered bulk action streams

scrollBatchSize - the batch size to scroll

scrollKeepAliveSeconds - the scroll lifetime

produceImmediate - whether or not the record should be produced immedialitely while scrolling

Method Detail

processRecord

public void processRecord(ComputationContext context,
                          String inputStreamName,
                          Record record)

Description copied from interface: Computation

Process an incoming record on one of the computation's input streams.

Parameters:

context - The computation context object provided by the system.

inputStreamName - Name of the input stream that provides the record.

record - The record.

processRecord

protected void processRecord(ComputationContext context,
                             Record record)

isAbortedCommand

protected boolean isAbortedCommand(String commandId)

updateStatusAsScrolling

protected void updateStatusAsScrolling(ComputationContext context,
                                       String commandId)

updateStatusAfterScroll

protected void updateStatusAfterScroll(ComputationContext context,
                                       String commandId,
                                       String errorMessage)

updateStatusAfterScroll

protected void updateStatusAfterScroll(ComputationContext context,
                                       String commandId,
                                       long documentCount)

updateStatusAfterScroll

protected void updateStatusAfterScroll(ComputationContext context,
                                       String commandId,
                                       long documentCount,
                                       String errorMessage)

produceBucket

protected void produceBucket(ComputationContext context,
                             String action,
                             String commandId,
                             int bucketSize,
                             long bucketNumber)

Produces a bucket as a record to appropriate bulk action stream.