io.siddhi.extension.io.grpc.sink

Class AbstractGrpcSink

java.lang.Object

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

io.siddhi.extension.io.grpc.sink.AbstractGrpcSink

All Implemented Interfaces:

io.siddhi.core.stream.output.sink.SinkListener

Direct Known Subclasses:

GrpcCallSink, GrpcSink

public abstract class AbstractGrpcSink
extends io.siddhi.core.stream.output.sink.Sink

AbstractGrpcSink is a super class extended by GrpcCallSink, and GrpcSink. This provides most of the initialization implementations.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected io.grpc.ManagedChannel	channel
protected long	channelTerminationWaitingTimeInMillis
protected Map<String,String>	headersMap
protected io.siddhi.core.util.transport.Option	headersOption
protected io.grpc.ManagedChannelBuilder	managedChannelBuilder
protected io.siddhi.core.util.transport.Option	metadataOption
protected ServiceConfigs	serviceConfigs
protected String	siddhiAppName
protected io.siddhi.query.api.definition.StreamDefinition	streamDefinition
protected String	streamID

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

isTryingToConnect

Constructor Summary

Constructors

Constructor and Description
AbstractGrpcSink()

Method Summary

Modifier and Type	Method and Description
Event.Builder	addHeadersToEventBuilder(io.siddhi.core.util.transport.DynamicOptions dynamicOptions, Event.Builder eventBuilder)
io.grpc.stub.AbstractStub	attachMetaDataToStub(io.siddhi.core.util.transport.DynamicOptions dynamicOptions, io.grpc.stub.AbstractStub stub)
void	destroy() The method can be called when removing an event receiver.
protected io.siddhi.core.stream.ServiceDeploymentInfo	exposeServiceDeploymentInfo()
String[]	getSupportedDynamicOptions() Returns a list of supported dynamic options (that means for each event value of the option can change) by the transport.
Class[]	getSupportedInputEventClasses() Returns the list of classes which this sink can consume.
protected io.siddhi.core.util.snapshot.state.StateFactory	init(io.siddhi.query.api.definition.StreamDefinition streamDefinition, io.siddhi.core.util.transport.OptionHolder optionHolder, io.siddhi.core.util.config.ConfigReader configReader, io.siddhi.core.config.SiddhiAppContext siddhiAppContext) The initialization method for Sink, will be called before other methods.
abstract void	initSink(io.siddhi.core.util.transport.OptionHolder optionHolder)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

siddhiAppName

protected String siddhiAppName

channel

protected io.grpc.ManagedChannel channel

streamID

protected String streamID

headersOption

protected io.siddhi.core.util.transport.Option headersOption

metadataOption

protected io.siddhi.core.util.transport.Option metadataOption

managedChannelBuilder

protected io.grpc.ManagedChannelBuilder managedChannelBuilder

channelTerminationWaitingTimeInMillis

protected long channelTerminationWaitingTimeInMillis

serviceConfigs

protected ServiceConfigs serviceConfigs

streamDefinition

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

headersMap

protected Map<String,String> headersMap

Constructor Detail

AbstractGrpcSink

public AbstractGrpcSink()

Method Detail

getSupportedInputEventClasses

public Class[] getSupportedInputEventClasses()

Returns the list of classes which this sink can consume.

Specified by:

getSupportedInputEventClasses in class io.siddhi.core.stream.output.sink.Sink

exposeServiceDeploymentInfo

protected io.siddhi.core.stream.ServiceDeploymentInfo exposeServiceDeploymentInfo()

Specified by:

exposeServiceDeploymentInfo in class io.siddhi.core.stream.output.sink.Sink

getSupportedDynamicOptions

public String[] getSupportedDynamicOptions()

Returns a list of supported dynamic options (that means for each event value of the option can change) by the transport.

Specified by:

getSupportedDynamicOptions in class io.siddhi.core.stream.output.sink.Sink

Returns:

the list of supported dynamic option keys.

init

protected io.siddhi.core.util.snapshot.state.StateFactory init(io.siddhi.query.api.definition.StreamDefinition streamDefinition,
                                                               io.siddhi.core.util.transport.OptionHolder optionHolder,
                                                               io.siddhi.core.util.config.ConfigReader configReader,
                                                               io.siddhi.core.config.SiddhiAppContext siddhiAppContext)

The initialization method for Sink, will be called before other methods. It used to validate all configurations and to get initial values.

Specified by:

init in class io.siddhi.core.stream.output.sink.Sink

Parameters:

streamDefinition - containing stream definition bind to the Sink

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

configReader - to read the sink related system configuration.

siddhiAppContext - the context of the SiddhiApp used to

initSink

public abstract void initSink(io.siddhi.core.util.transport.OptionHolder optionHolder)

destroy

public void destroy()

The method can be called when removing an event receiver. The cleanups that have to be done after removing the receiver could be done here.

Specified by:

destroy in class io.siddhi.core.stream.output.sink.Sink

addHeadersToEventBuilder

public Event.Builder addHeadersToEventBuilder(io.siddhi.core.util.transport.DynamicOptions dynamicOptions,
                                              Event.Builder eventBuilder)

attachMetaDataToStub

public io.grpc.stub.AbstractStub attachMetaDataToStub(io.siddhi.core.util.transport.DynamicOptions dynamicOptions,
                                                      io.grpc.stub.AbstractStub stub)