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

Class DistributedTransport

java.lang.Object

io.siddhi.core.stream.output.sink.Sink

io.siddhi.core.stream.output.sink.distributed.DistributedTransport

All Implemented Interfaces:

SinkListener

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DistributedTransport.ConnectionCallback	Connection callback to notify DistributionStrategy about new connection initiations and failures

Nested classes/interfaces inherited from class io.siddhi.core.stream.output.sink.Sink

Sink.OnErrorAction

Field Summary

Fields

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

Fields inherited from class io.siddhi.core.stream.output.sink.Sink

isTryingToConnect

Constructor Summary

Constructors

Constructor	Description
DistributedTransport()

Method Summary

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

Methods inherited from class io.siddhi.core.stream.output.sink.Sink

connect, connectWithRetry, destroy, disconnect, exposeServiceDeploymentInfo, getHandler, getMapper, getServiceDeploymentInfoList, getStreamDefinition, getSupportedInputEventClasses, getType, init, initOnlyTransport, isStateful, onError, publish, retryPublish, setConnected, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

strategy

protected DistributionStrategy strategy

streamDefinition

protected io.siddhi.query.api.definition.StreamDefinition streamDefinition

siddhiAppContext

protected SiddhiAppContext siddhiAppContext

Constructor Detail

DistributedTransport

public DistributedTransport()

Method Detail

init

protected StateFactory<State> init(io.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(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,
                 StreamJunction streamJunction,
                 SiddhiAppContext siddhiAppContext,
                 List<OptionHolder> destinationOptionHolders,
                 io.siddhi.query.api.annotation.Annotation sinkAnnotation,
                 DistributionStrategy strategy,
                 String[] supportedDynamicOptions,
                 Map<String,String> deploymentProperties,
                 List<Map<String,String>> destinationDeploymentProperties)

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

streamJunction -

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

deploymentProperties - Service deployment properties for distributed transport sink

destinationDeploymentProperties - Service deployment properties

publish

public void publish(Object payload,
                    DynamicOptions transportOptions,
                    State state)
             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 - of the event constructing the payload

state - current state of the sink

Throws:

ConnectionUnavailableException - throw when connections are unavailable.

isConnected

public boolean isConnected()

Overrides:

isConnected in class Sink

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,
                             State state)
                      throws ConnectionUnavailableException

Throws:

ConnectionUnavailableException

initTransport

public abstract void initTransport(OptionHolder sinkOptionHolder,
                                   List<OptionHolder> destinationOptionHolders,
                                   Map<String,String> deploymentProperties,
                                   List<Map<String,String>> destinationDeploymentProperties,
                                   io.siddhi.query.api.annotation.Annotation sinkAnnotation,
                                   ConfigReader sinkConfigReader,
                                   DistributionStrategy strategy,
                                   String type,
                                   SiddhiAppContext siddhiAppContext)