org.apache.flink.contrib.siddhi

Class SiddhiCEP

java.lang.Object

org.apache.flink.contrib.siddhi.SiddhiCEP

@PublicEvolving
public class SiddhiCEP
extends Object

Siddhi CEP Environment, provides utility methods to

• Initialize SiddhiCEP environment based on StreamExecutionEnvironment
• Register SiddhiStream with field-based StreamSchema and bind with physical source DataStream
• Define rich-featured Siddhi CEP execution plan with SQL-Like query for SiddhiStreamOperator
• Transform and connect source DataStream to SiddhiStreamOperator
• Register customizable siddhi plugins to extend built-in CEP functions

See Also:

SiddhiStream, StreamSchema, SiddhiStreamOperator

Method Summary

Modifier and Type	Method and Description
void	checkStreamDefined(String streamId) Check whether given streamId has been defined, if not, throw UndefinedStreamException
static <T> SiddhiStream.SingleSiddhiStream<T>	define(String streamId, org.apache.flink.streaming.api.datastream.DataStream<T> dataStream, String... fieldNames) Define siddhi stream with streamId, source DataStream and stream schema, and select as initial source stream to connect to siddhi operator.
<T> SiddhiStream.SingleSiddhiStream<T>	from(String streamId) Select stream by streamId as initial stream to connect to Siddhi Runtime.
<T> SiddhiStream.SingleSiddhiStream<T>	from(String streamId, org.apache.flink.streaming.api.datastream.DataStream<T> dataStream, String... fieldNames) Register stream with unique streaId, source dataStream and schema fields, and select the registered stream as initial stream to connect to Siddhi Runtime.
<T> org.apache.flink.streaming.api.datastream.DataStream<T>	getDataStream(String streamId) Get registered source DataStream with Siddhi streamId.
Map<String,org.apache.flink.streaming.api.datastream.DataStream<?>>	getDataStreams()
Map<String,SiddhiStreamSchema<?>>	getDataStreamSchemas()
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment	getExecutionEnvironment()
Map<String,Class<?>>	getExtensions()
static SiddhiCEP	getSiddhiEnvironment(org.apache.flink.streaming.api.environment.StreamExecutionEnvironment streamExecutionEnvironment) Create new SiddhiCEP instance.
boolean	isStreamDefined(String streamId)
void	registerExtension(String extensionName, Class<?> extensionClass) Register Siddhi CEP Extensions
<T> void	registerStream(String streamId, org.apache.flink.streaming.api.datastream.DataStream<T> dataStream, String... fieldNames) Define siddhi stream with streamId, source DataStream and stream schema.
<T> SiddhiStream.UnionSiddhiStream<T>	union(String firstStreamId, String... unionStreamIds) Select one stream and union other streams by streamId to connect to Siddhi Stream Operator.

Methods inherited from class java.lang.Object

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

Method Detail

getDataStreams

public Map<String,org.apache.flink.streaming.api.datastream.DataStream<?>> getDataStreams()

Returns:

Siddhi streamId and source DataStream mapping.

See Also:

DataStream

getDataStreamSchemas

public Map<String,SiddhiStreamSchema<?>> getDataStreamSchemas()

Returns:

Siddhi streamId and stream schema mapping.

See Also:

SiddhiStreamSchema

isStreamDefined

public boolean isStreamDefined(String streamId)

Parameters:

streamId - Siddhi streamId to check.

Returns:

whether the given streamId is defined in current SiddhiCEP environment.

getExtensions

public Map<String,Class<?>> getExtensions()

Returns:

Registered siddhi extensions.

checkStreamDefined

public void checkStreamDefined(String streamId)
                        throws UndefinedStreamException

Check whether given streamId has been defined, if not, throw UndefinedStreamException

Parameters:

streamId - Siddhi streamId to check.

Throws:

UndefinedStreamException - throws if given streamId is not defined

define

public static <T> SiddhiStream.SingleSiddhiStream<T> define(String streamId,
                                                            org.apache.flink.streaming.api.datastream.DataStream<T> dataStream,
                                                            String... fieldNames)

Define siddhi stream with streamId, source DataStream and stream schema, and select as initial source stream to connect to siddhi operator.

Parameters:

streamId - Unique siddhi streamId

dataStream - DataStream to bind to the siddhi stream.

fieldNames - Siddhi stream schema field names

See Also:

registerStream(String, DataStream, String...), from(String)

from

public <T> SiddhiStream.SingleSiddhiStream<T> from(String streamId,
                                                   org.apache.flink.streaming.api.datastream.DataStream<T> dataStream,
                                                   String... fieldNames)

Register stream with unique streaId, source dataStream and schema fields, and select the registered stream as initial stream to connect to Siddhi Runtime.

See Also:

registerStream(String, DataStream, String...), from(String)

from

public <T> SiddhiStream.SingleSiddhiStream<T> from(String streamId)

Select stream by streamId as initial stream to connect to Siddhi Runtime.

Type Parameters:

T - Stream Generic Type

Parameters:

streamId - Siddhi Stream Name

union

public <T> SiddhiStream.UnionSiddhiStream<T> union(String firstStreamId,
                                                   String... unionStreamIds)

Select one stream and union other streams by streamId to connect to Siddhi Stream Operator.

Parameters:

firstStreamId - First siddhi streamId, which should be predefined in SiddhiCEP context.

unionStreamIds - Other siddhi streamIds to union, which should be predefined in SiddhiCEP context.

Returns:

The UnionSiddhiStream Builder

registerStream

public <T> void registerStream(String streamId,
                               org.apache.flink.streaming.api.datastream.DataStream<T> dataStream,
                               String... fieldNames)

Define siddhi stream with streamId, source DataStream and stream schema.

Parameters:

streamId - Unique siddhi streamId

dataStream - DataStream to bind to the siddhi stream.

fieldNames - Siddhi stream schema field names

getExecutionEnvironment

public org.apache.flink.streaming.api.environment.StreamExecutionEnvironment getExecutionEnvironment()

Returns:

Current StreamExecutionEnvironment.

registerExtension

public void registerExtension(String extensionName,
                              Class<?> extensionClass)

Register Siddhi CEP Extensions

Parameters:

extensionName - Unique siddhi extension name

extensionClass - Siddhi Extension class

See Also:

https://docs.wso2.com/display/CEP310/Writing+Extensions+to+Siddhi

getDataStream

public <T> org.apache.flink.streaming.api.datastream.DataStream<T> getDataStream(String streamId)

Get registered source DataStream with Siddhi streamId.

Parameters:

streamId - Siddhi streamId

Returns:

The source DataStream registered with Siddhi streamId

getSiddhiEnvironment

public static SiddhiCEP getSiddhiEnvironment(org.apache.flink.streaming.api.environment.StreamExecutionEnvironment streamExecutionEnvironment)

Create new SiddhiCEP instance.

Parameters:

streamExecutionEnvironment - StreamExecutionEnvironment

Returns:

New SiddhiCEP instance.