Package io.siddhi.core.stream.output.sink

Class Sink<S extends State>

java.lang.Object

io.siddhi.core.stream.output.sink.Sink<S>

Type Parameters:

S - current state of the Sink

All Implemented Interfaces:

SinkListener

Direct Known Subclasses:

DistributedTransport, InMemorySink, LogSink

public abstract class Sink<S extends State>
extends Object
implements SinkListener

This is a Sink type. these let users to publish events according to some type. this type can either be local, jms or ws (or any custom extension)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Sink.OnErrorAction	Different Type of On Error Actions

Field Summary

Fields

Modifier and Type	Field	Description
protected AtomicBoolean	isTryingToConnect

Constructor Summary

Constructors

Constructor	Description
Sink()

Method Summary

Modifier and Type	Method	Description
abstract void	connect()	Called to connect to the backend before events are published
void	connectWithRetry()
abstract void	destroy()	Called at the end to clean all the resources consumed
abstract void	disconnect()	Called after all publishing is done, or when ConnectionUnavailableException is thrown
protected abstract ServiceDeploymentInfo	exposeServiceDeploymentInfo()	Give information to the deployment about the service exposed by the sink.
SinkHandler	getHandler()
SinkMapper	getMapper()
List<ServiceDeploymentInfo>	getServiceDeploymentInfoList()
io.siddhi.query.api.definition.StreamDefinition	getStreamDefinition()
abstract String[]	getSupportedDynamicOptions()	Supported dynamic options by the transport
abstract Class[]	getSupportedInputEventClasses()
String	getType()
protected abstract StateFactory<S>	init(io.siddhi.query.api.definition.StreamDefinition outputStreamDefinition, OptionHolder optionHolder, ConfigReader sinkConfigReader, SiddhiAppContext siddhiAppContext)	Will be called for initialing the Sink
void	init(io.siddhi.query.api.definition.StreamDefinition streamDefinition, String type, OptionHolder transportOptionHolder, ConfigReader sinkConfigReader, SinkMapper sinkMapper, String mapType, OptionHolder mapOptionHolder, SinkHandler sinkHandler, List<io.siddhi.query.api.annotation.Element> payloadElementList, ConfigReader mapperConfigReader, Map<String,String> deploymentProperties, StreamJunction streamJunction, SiddhiAppContext siddhiAppContext)
void	initOnlyTransport(io.siddhi.query.api.definition.StreamDefinition streamDefinition, OptionHolder transportOptionHolder, ConfigReader sinkConfigReader, String type, DistributedTransport.ConnectionCallback connectionCallback, Map<String,String> deploymentProperties, SiddhiAppContext siddhiAppContext)
boolean	isConnected()
boolean	isStateful()
void	onError(Object payload, DynamicOptions dynamicOptions, Exception e)
void	publish(Object payload)	Sending events via output transport
abstract void	publish(Object payload, DynamicOptions dynamicOptions, S state)	Sending events via output transport
protected void	retryPublish(Object payload)
void	setConnected(boolean connected)
void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

isTryingToConnect

protected AtomicBoolean isTryingToConnect

Constructor Detail

Sink

public Sink()

Method Detail

init

public final void init(io.siddhi.query.api.definition.StreamDefinition streamDefinition,
                       String type,
                       OptionHolder transportOptionHolder,
                       ConfigReader sinkConfigReader,
                       SinkMapper sinkMapper,
                       String mapType,
                       OptionHolder mapOptionHolder,
                       SinkHandler sinkHandler,
                       List<io.siddhi.query.api.annotation.Element> payloadElementList,
                       ConfigReader mapperConfigReader,
                       Map<String,String> deploymentProperties,
                       StreamJunction streamJunction,
                       SiddhiAppContext siddhiAppContext)

getSupportedInputEventClasses

public abstract Class[] getSupportedInputEventClasses()

initOnlyTransport

public final void initOnlyTransport(io.siddhi.query.api.definition.StreamDefinition streamDefinition,
                                    OptionHolder transportOptionHolder,
                                    ConfigReader sinkConfigReader,
                                    String type,
                                    DistributedTransport.ConnectionCallback connectionCallback,
                                    Map<String,String> deploymentProperties,
                                    SiddhiAppContext siddhiAppContext)

exposeServiceDeploymentInfo

protected abstract ServiceDeploymentInfo exposeServiceDeploymentInfo()

Give information to the deployment about the service exposed by the sink.

Returns:

ServiceDeploymentInfo Service related information to the deployment

getSupportedDynamicOptions

public abstract String[] getSupportedDynamicOptions()

Supported dynamic options by the transport

Returns:

the list of supported dynamic option keys

init

protected abstract StateFactory<S> init(io.siddhi.query.api.definition.StreamDefinition outputStreamDefinition,
                                        OptionHolder optionHolder,
                                        ConfigReader sinkConfigReader,
                                        SiddhiAppContext siddhiAppContext)

Will be called for initialing the Sink

Parameters:

outputStreamDefinition - containing stream definition bind to the Sink

optionHolder - Option holder containing static and dynamic options related to the Sink

sinkConfigReader - this hold the Sink extensions configuration reader.

siddhiAppContext - SiddhiAppContext of the parent siddhi app.

publish

public final void publish(Object payload)

Description copied from interface: SinkListener

Sending events via output transport

Specified by:

publish in interface SinkListener

Parameters:

payload - payload of the event

retryPublish

protected void retryPublish(Object payload)
                     throws ConnectionUnavailableException

Throws:

ConnectionUnavailableException

publish

public abstract void publish(Object payload,
                             DynamicOptions dynamicOptions,
                             S state)
                      throws ConnectionUnavailableException

Sending events via output transport

Parameters:

payload - payload of the event

dynamicOptions - of the event constructing the payload

state - current state of the sink

Throws:

ConnectionUnavailableException - throw when connections are unavailable.

connect

public abstract void connect()
                      throws ConnectionUnavailableException

Called to connect to the backend before events are published

Throws:

ConnectionUnavailableException - if it cannot connect to the backend

disconnect

public abstract void disconnect()

Called after all publishing is done, or when ConnectionUnavailableException is thrown

destroy

public abstract void destroy()

Called at the end to clean all the resources consumed

getType

public final String getType()

getMapper

public final SinkMapper getMapper()

getHandler

public final SinkHandler getHandler()

connectWithRetry

public void connectWithRetry()

shutdown

public void shutdown()

getStreamDefinition

public io.siddhi.query.api.definition.StreamDefinition getStreamDefinition()

isConnected

public boolean isConnected()

setConnected

public void setConnected(boolean connected)

onError

public void onError(Object payload,
                    DynamicOptions dynamicOptions,
                    Exception e)

getServiceDeploymentInfoList

public List<ServiceDeploymentInfo> getServiceDeploymentInfoList()

isStateful

public boolean isStateful()