org.wso2.siddhi.core.stream.output.sink

Class Sink

java.lang.Object

org.wso2.siddhi.core.stream.output.sink.Sink

All Implemented Interfaces:

SinkListener, Snapshotable

Direct Known Subclasses:

DistributedTransport, InMemorySink, LogSink

public abstract class Sink
extends Object
implements SinkListener, Snapshotable

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)

Constructor Summary

Constructors

Constructor and Description
Sink()

Method Summary

Modifier and Type	Method and 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
String	getElementId()
SinkHandler	getHandler()
SinkMapper	getMapper()
org.wso2.siddhi.query.api.definition.StreamDefinition	getStreamDefinition()
abstract String[]	getSupportedDynamicOptions() Supported dynamic options by the transport
abstract Class[]	getSupportedInputEventClasses()
String	getType()
protected abstract void	init(org.wso2.siddhi.query.api.definition.StreamDefinition outputStreamDefinition, OptionHolder optionHolder, ConfigReader sinkConfigReader, SiddhiAppContext siddhiAppContext) Will be called for initialing the Sink
void	init(org.wso2.siddhi.query.api.definition.StreamDefinition streamDefinition, String type, OptionHolder transportOptionHolder, ConfigReader sinkConfigReader, SinkMapper sinkMapper, String mapType, OptionHolder mapOptionHolder, SinkHandler sinkHandler, List<org.wso2.siddhi.query.api.annotation.Element> payloadElementList, ConfigReader mapperConfigReader, SiddhiAppContext siddhiAppContext)
void	initOnlyTransport(org.wso2.siddhi.query.api.definition.StreamDefinition streamDefinition, OptionHolder transportOptionHolder, ConfigReader sinkConfigReader, SiddhiAppContext siddhiAppContext)
boolean	isConnected()
void	publish(Object payload) Sending events via output transport
abstract void	publish(Object payload, DynamicOptions transportOptions) Sending events via output transport
void	setConnected(boolean connected)
void	shutdown()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wso2.siddhi.core.util.snapshot.Snapshotable

currentState, restoreState

Constructor Detail

Sink

public Sink()

Method Detail

init

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

getSupportedInputEventClasses

public abstract Class[] getSupportedInputEventClasses()

initOnlyTransport

public final void initOnlyTransport(org.wso2.siddhi.query.api.definition.StreamDefinition streamDefinition,
                                    OptionHolder transportOptionHolder,
                                    ConfigReader sinkConfigReader,
                                    SiddhiAppContext siddhiAppContext)

getSupportedDynamicOptions

public abstract String[] getSupportedDynamicOptions()

Supported dynamic options by the transport

Returns:

the list of supported dynamic option keys

init

protected abstract void init(org.wso2.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

publish

public abstract void publish(Object payload,
                             DynamicOptions transportOptions)
                      throws ConnectionUnavailableException

Sending events via output transport

Parameters:

payload - payload of the event

transportOptions - one of the event constructing the payload

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()

isConnected

public boolean isConnected()

shutdown

public void shutdown()

getElementId

public final String getElementId()

Specified by:

getElementId in interface Snapshotable

getStreamDefinition

public org.wso2.siddhi.query.api.definition.StreamDefinition getStreamDefinition()

setConnected

public void setConnected(boolean connected)