io.continual.services.processor.engine.library.util

Class SimpleStreamProcessingContext

java.lang.Object

io.continual.services.processor.engine.library.util.SimpleStreamProcessingContext

All Implemented Interfaces:

StreamProcessingContext

public class SimpleStreamProcessingContext
extends Object
implements StreamProcessingContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleStreamProcessingContext.Builder

Nested classes/interfaces inherited from interface io.continual.services.processor.engine.model.StreamProcessingContext

StreamProcessingContext.NoSuitableObjectException

Method Summary

Modifier and Type	Method and Description
StreamProcessingContext	addNamedObject(String name, Object o) Add a named object of any type.
static SimpleStreamProcessingContext.Builder	builder()
boolean	checkFlag(String flagName) Get the value of a given flag.
boolean	clearFlag(String flagName) Clear a flag
String	evalExpression(String expression) Evaluate a ${} expression in the context of this stream processor
void	fail(String warningText) Report that the stream processing has failed.
boolean	failed() Returns true if fail() has been called
MetricsCatalog	getMetrics() Get the metrics catalog into which this processing context reports.
Object	getNamedObject(String name) Get a raw object reference for the instance with the given name
<T> T	getNamedObject(String name, Class<T> clazz) Get a typed object with the given name.
Identity	getOperator() Get the identity of the operator running this process.
<T> T	getReqdNamedObject(String name, Class<T> clazz) Get a typed object with the given name and throw an exception if it's not available.
Source	getSource() Get this stream's source
StreamProcessingContext	removeNamedObject(String name) Remove a named object from this context, if it exists
void	requeue(MessageAndRouting mr) Requeue a message
boolean	setFlag(String flagName) Set a boolean flag
void	warn(String warningText) report a warning about processing the stream

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SimpleStreamProcessingContext.Builder builder()

getSource

public Source getSource()

Description copied from interface: StreamProcessingContext

Get this stream's source

Specified by:

getSource in interface StreamProcessingContext

Returns:

a source instance

warn

public void warn(String warningText)

Description copied from interface: StreamProcessingContext

report a warning about processing the stream

Specified by:

warn in interface StreamProcessingContext

fail

public void fail(String warningText)

Description copied from interface: StreamProcessingContext

Report that the stream processing has failed.

Specified by:

fail in interface StreamProcessingContext

failed

public boolean failed()

Description copied from interface: StreamProcessingContext

Returns true if fail() has been called

Specified by:

failed in interface StreamProcessingContext

Returns:

addNamedObject

public StreamProcessingContext addNamedObject(String name,
                                              Object o)

Description copied from interface: StreamProcessingContext

Add a named object of any type.

Specified by:

addNamedObject in interface StreamProcessingContext

Returns:

this context

getNamedObject

public Object getNamedObject(String name)

Description copied from interface: StreamProcessingContext

Get a raw object reference for the instance with the given name

Specified by:

getNamedObject in interface StreamProcessingContext

Returns:

an object, or null of none is known to this context

getNamedObject

public <T> T getNamedObject(String name,
                            Class<T> clazz)
                     throws ClassCastException

Description copied from interface: StreamProcessingContext

Get a typed object with the given name.

Specified by:

getNamedObject in interface StreamProcessingContext

Returns:

the named object cast to T, null of none exists.

Throws:

ClassCastException

getReqdNamedObject

public <T> T getReqdNamedObject(String name,
                                Class<T> clazz)
                         throws StreamProcessingContext.NoSuitableObjectException

Description copied from interface: StreamProcessingContext

Get a typed object with the given name and throw an exception if it's not available.

Specified by:

getReqdNamedObject in interface StreamProcessingContext

Returns:

the named object cast to T

Throws:

StreamProcessingContext.NoSuitableObjectException

removeNamedObject

public StreamProcessingContext removeNamedObject(String name)

Description copied from interface: StreamProcessingContext

Remove a named object from this context, if it exists

Specified by:

removeNamedObject in interface StreamProcessingContext

Returns:

this context

setFlag

public boolean setFlag(String flagName)

Description copied from interface: StreamProcessingContext

Set a boolean flag

Specified by:

setFlag in interface StreamProcessingContext

Returns:

value before this call

checkFlag

public boolean checkFlag(String flagName)

Description copied from interface: StreamProcessingContext

Get the value of a given flag.

Specified by:

checkFlag in interface StreamProcessingContext

Returns:

true if set, false if clear or unknown

clearFlag

public boolean clearFlag(String flagName)

Description copied from interface: StreamProcessingContext

Clear a flag

Specified by:

clearFlag in interface StreamProcessingContext

Returns:

the value before this call

requeue

public void requeue(MessageAndRouting mr)

Description copied from interface: StreamProcessingContext

Requeue a message

Specified by:

requeue in interface StreamProcessingContext

evalExpression

public String evalExpression(String expression)

Description copied from interface: StreamProcessingContext

Evaluate a ${} expression in the context of this stream processor

Specified by:

evalExpression in interface StreamProcessingContext

Returns:

a value, which may be an empty string

getMetrics

public MetricsCatalog getMetrics()

Description copied from interface: StreamProcessingContext

Get the metrics catalog into which this processing context reports. Processors may create/use metrics objects at the top-level, which is scoped properly during the call.

Specified by:

getMetrics in interface StreamProcessingContext

Returns:

a metrics catalog

getOperator

public Identity getOperator()

Description copied from interface: StreamProcessingContext

Get the identity of the operator running this process.

Specified by:

getOperator in interface StreamProcessingContext

Returns:

an identity, or null