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

Class DistributedTransport

java.lang.Object

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

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

All Implemented Interfaces:

SinkListener, Snapshotable

Direct Known Subclasses:

MultiClientDistributedSink, SingleClientDistributedSink

public abstract class DistributedTransport
extends Sink

This is the base class for Distributed transports. All distributed transport types must inherit from this class

Field Summary

Fields

Modifier and Type	Field and Description
protected SiddhiAppContext	siddhiAppContext
protected DistributionStrategy	strategy
protected org.wso2.siddhi.query.api.definition.StreamDefinition	streamDefinition

Constructor Summary

Constructors

Constructor and Description
DistributedTransport()

Method Summary

Modifier and Type	Method and Description
String[]	getSupportedDynamicOptions() Supported dynamic options by the transport
protected 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, List<OptionHolder> destinationOptionHolders, org.wso2.siddhi.query.api.annotation.Annotation sinkAnnotation, DistributionStrategy strategy, String[] supportedDynamicOptions) This is method contains the additional parameters which require to initialize distributed transport
abstract void	initTransport(OptionHolder sinkOptionHolder, List<OptionHolder> destinationOptionHolders, org.wso2.siddhi.query.api.annotation.Annotation sinkAnnotation, ConfigReader sinkConfigReader, SiddhiAppContext siddhiAppContext)
void	publish(Object payload, DynamicOptions transportOptions) Sending events via output transport
abstract void	publish(Object payload, DynamicOptions transportOptions, Integer destinationId)

Methods inherited from class org.wso2.siddhi.core.stream.output.sink.Sink

connect, connectWithRetry, destroy, disconnect, getElementId, getHandler, getMapper, getStreamDefinition, getSupportedInputEventClasses, getType, init, initOnlyTransport, isConnected, publish, setConnected, 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

Field Detail

strategy

protected DistributionStrategy strategy

streamDefinition

protected org.wso2.siddhi.query.api.definition.StreamDefinition streamDefinition

siddhiAppContext

protected SiddhiAppContext siddhiAppContext

Constructor Detail

DistributedTransport

public DistributedTransport()

Method Detail

init

protected void init(org.wso2.siddhi.query.api.definition.StreamDefinition outputStreamDefinition,
                    OptionHolder optionHolder,
                    ConfigReader sinkConfigReader,
                    SiddhiAppContext siddhiAppContext)

Will be called for initialing the Sink

Specified by:

init in class Sink

Parameters:

outputStreamDefinition - The stream definition this Output transport/sink is attached to

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

sinkConfigReader - this hold the Sink extensions configuration reader.

siddhiAppContext - Context of the siddhi app which this output sink belongs to

init

public 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,
                 List<OptionHolder> destinationOptionHolders,
                 org.wso2.siddhi.query.api.annotation.Annotation sinkAnnotation,
                 DistributionStrategy strategy,
                 String[] supportedDynamicOptions)

This is method contains the additional parameters which require to initialize distributed transport

Parameters:

streamDefinition - Definition of the stream this sink instance is publishing to

type - Type of the transport that (e.g., TCP, JMS)

transportOptionHolder - Option holder for carrying options for the transport

sinkConfigReader - This hold the Sink extensions configuration reader for the sink

sinkMapper - Hold the mapper that's used in this sink

mapType - Type of the mapper

mapOptionHolder - Options of the mapper

sinkHandler - Sink handler to do optional processing

payloadElementList - The template list of the payload messages

mapperConfigReader - This hold the Sink extensions configuration reader for the mapper

siddhiAppContext - The siddhi app context

destinationOptionHolders - List of option holders containing the options mentioned in @destination

sinkAnnotation - The annotation of the Sink

strategy - Publishing strategy to be used by the distributed transport

supportedDynamicOptions - List of supported dynamic options

publish

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

Description copied from class: Sink

Sending events via output transport

Specified by:

publish in class Sink

Parameters:

payload - payload of the event

transportOptions - one of the event constructing the payload

Throws:

ConnectionUnavailableException - throw when connections are unavailable.

getSupportedDynamicOptions

public String[] getSupportedDynamicOptions()

Supported dynamic options by the transport

Specified by:

getSupportedDynamicOptions in class Sink

Returns:

the list of supported dynamic option keys

publish

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

Throws:

ConnectionUnavailableException

initTransport

public abstract void initTransport(OptionHolder sinkOptionHolder,
                                   List<OptionHolder> destinationOptionHolders,
                                   org.wso2.siddhi.query.api.annotation.Annotation sinkAnnotation,
                                   ConfigReader sinkConfigReader,
                                   SiddhiAppContext siddhiAppContext)