public abstract class Sink extends Object implements SinkListener
Modifier and Type | Class and Description |
---|---|
static class |
Sink.OnErrorAction
Different Type of On Error Actions
|
Modifier and Type | Field and Description |
---|---|
protected AtomicBoolean |
isTryingToConnect |
Constructor and Description |
---|
Sink() |
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
|
SinkHandler |
getHandler() |
SinkMapper |
getMapper() |
io.siddhi.query.api.definition.StreamDefinition |
getStreamDefinition() |
abstract String[] |
getSupportedDynamicOptions()
Supported dynamic options by the transport
|
abstract Class[] |
getSupportedInputEventClasses() |
String |
getType() |
protected abstract void |
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,
SiddhiAppContext siddhiAppContext) |
void |
initOnlyTransport(io.siddhi.query.api.definition.StreamDefinition streamDefinition,
OptionHolder transportOptionHolder,
ConfigReader sinkConfigReader,
String type,
DistributedTransport.ConnectionCallback connectionCallback,
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() |
protected AtomicBoolean isTryingToConnect
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, SiddhiAppContext siddhiAppContext)
public abstract Class[] getSupportedInputEventClasses()
public final void initOnlyTransport(io.siddhi.query.api.definition.StreamDefinition streamDefinition, OptionHolder transportOptionHolder, ConfigReader sinkConfigReader, String type, DistributedTransport.ConnectionCallback connectionCallback, SiddhiAppContext siddhiAppContext)
public abstract String[] getSupportedDynamicOptions()
protected abstract void init(io.siddhi.query.api.definition.StreamDefinition outputStreamDefinition, OptionHolder optionHolder, ConfigReader sinkConfigReader, SiddhiAppContext siddhiAppContext)
Sink
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.public final void publish(Object payload)
SinkListener
publish
in interface SinkListener
payload
- payload of the eventpublic abstract void publish(Object payload, DynamicOptions transportOptions) throws ConnectionUnavailableException
payload
- payload of the eventtransportOptions
- one of the event constructing the payloadConnectionUnavailableException
- throw when connections are unavailable.public abstract void connect() throws ConnectionUnavailableException
ConnectionUnavailableException
- if it cannot connect to the backendpublic abstract void disconnect()
public abstract void destroy()
public final String getType()
public final SinkMapper getMapper()
public final SinkHandler getHandler()
public void connectWithRetry()
public void shutdown()
public io.siddhi.query.api.definition.StreamDefinition getStreamDefinition()
public boolean isConnected()
public void setConnected(boolean connected)
Copyright © 2019. All rights reserved.