Package org.nuxeo.lib.stream.computation

Class AbstractComputation

java.lang.Object

org.nuxeo.lib.stream.computation.AbstractComputation

All Implemented Interfaces:

Computation

Direct Known Subclasses:

AbstractBatchComputation, AbstractBulkComputation, AbstractTransientBlobComputation, BulkIndexComputation, BulkScrollerComputation, BulkStatusComputation, IndexCompletionComputation, LatencyTrackerComputation, StreamAuditStorageWriter.AuditStorageLogWriterComputation, StreamIntrospectionComputation, StreamMetricsComputation, WorkComputation, WorkManagerRunWorkInFailure.WorkFailureComputation

public abstract class AbstractComputation
extends Object
implements Computation

An abstract Computation that manages the metadata init.

By convention the inputs streams are named internally: i1, i2 ...

and the output streams are named: o1, o2 ...

Since:

9.3

Field Summary

Fields

Modifier and Type	Field	Description
static String	INPUT_1
static String	INPUT_2
static String	INPUT_3
static String	INPUT_NULL
protected ComputationMetadata	metadata
static String	OUTPUT_1
static String	OUTPUT_2
static String	OUTPUT_3
static String	OUTPUT_4

Constructor Summary

Constructors

Constructor	Description
AbstractComputation(String name, int nbInputStreams, int nbOutputStreams)	Creates a computation with the requested number of input and output streams.

Method Summary

Modifier and Type	Method	Description
void	init(ComputationContext context)	Called when the framework has registered the computation successfully.
ComputationMetadata	metadata()	Identify the computation.
void	processFailure(ComputationContext context, Throwable failure)	Called when Computation.processRecord(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, org.nuxeo.lib.stream.computation.Record) or Computation.processTimer(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, long) fails and cannot be retried.
void	processRetry(ComputationContext context, Throwable failure)	Called after a failure in Computation.processRecord(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, org.nuxeo.lib.stream.computation.Record) or Computation.processTimer(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, long) before retrying.
void	processTimer(ComputationContext context, String key, long timestamp)	Process a timer callback previously set via ComputationContext.setTimer(String, long).

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, processRecord, signalStop

Field Detail

metadata

protected final ComputationMetadata metadata

INPUT_1

public static final String INPUT_1

See Also:

Constant Field Values

INPUT_2

public static final String INPUT_2

See Also:

Constant Field Values

INPUT_3

public static final String INPUT_3

See Also:

Constant Field Values

OUTPUT_1

public static final String OUTPUT_1

See Also:

Constant Field Values

OUTPUT_2

public static final String OUTPUT_2

See Also:

Constant Field Values

OUTPUT_3

public static final String OUTPUT_3

See Also:

Constant Field Values

OUTPUT_4

public static final String OUTPUT_4

See Also:

Constant Field Values

INPUT_NULL

public static final String INPUT_NULL

See Also:

Constant Field Values

Constructor Detail

AbstractComputation

public AbstractComputation(String name,
                           int nbInputStreams,
                           int nbOutputStreams)

Creates a computation with the requested number of input and output streams.

Since:

10.3

Method Detail

init

public void init(ComputationContext context)

Description copied from interface: Computation

Called when the framework has registered the computation successfully. Gives users a first opportunity to schedule timer callbacks and produce records. This method can be called multiple times.

Specified by:

init in interface Computation

Parameters:

context - The computation context object provided by the system.

processTimer

public void processTimer(ComputationContext context,
                         String key,
                         long timestamp)

Description copied from interface: Computation

Process a timer callback previously set via ComputationContext.setTimer(String, long).

Specified by:

processTimer in interface Computation

Parameters:

context - The computation context object provided by the system.

key - The name of the timer.

timestamp - The timestamp (in ms) for which the callback was scheduled.

metadata

public ComputationMetadata metadata()

Description copied from interface: Computation

Identify the computation.

Specified by:

metadata in interface Computation

Returns:

computation's metadata.

processRetry

public void processRetry(ComputationContext context,
                         Throwable failure)

Description copied from interface: Computation

Called after a failure in Computation.processRecord(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, org.nuxeo.lib.stream.computation.Record) or Computation.processTimer(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, long) before retrying.

Specified by:

processRetry in interface Computation

processFailure

public void processFailure(ComputationContext context,
                           Throwable failure)

Description copied from interface: Computation

Called when Computation.processRecord(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, org.nuxeo.lib.stream.computation.Record) or Computation.processTimer(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, long) fails and cannot be retried.

Specified by:

processFailure in interface Computation