io.siddhi.extension.io.email.sink

Class EmailSink

java.lang.Object

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

io.siddhi.extension.io.email.sink.EmailSink

All Implemented Interfaces:

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

public class EmailSink
extends io.siddhi.core.stream.output.sink.Sink

This the class implementing email sink.

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 inherited from class io.siddhi.core.stream.output.sink.Sink

isTryingToConnect

Constructor Summary

Constructors

Constructor and Description
EmailSink()

Method Summary

Modifier and Type	Method and Description
void	connect() This method will be called before the processing method.
void	destroy() The method can be called when removing an event receiver.
void	disconnect() Called after all publishing is done, or when ConnectionUnavailableException is thrown Implementation of this method should contain the steps needed to disconnect from the sink.
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, which will be called before other methods and validate the all configuration and getting the intial values.
void	publish(Object payload, io.siddhi.core.util.transport.DynamicOptions dynamicOptions, io.siddhi.core.util.snapshot.state.State state) This method will be called when events need to be published via this sink

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailSink

public EmailSink()

Method Detail

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, which will be called before other methods and validate the all configuration and getting the intial 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 get siddhi related utilty functions.

connect

public void connect()
             throws io.siddhi.core.exception.ConnectionUnavailableException

This method will be called before the processing method. Intention to establish connection to publish event.

Specified by:

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

Throws:

io.siddhi.core.exception.ConnectionUnavailableException - if end point is unavailable the ConnectionUnavailableException thrown such that the system will take care retrying for connection

publish

public void publish(Object payload,
                    io.siddhi.core.util.transport.DynamicOptions dynamicOptions,
                    io.siddhi.core.util.snapshot.state.State state)
             throws io.siddhi.core.exception.ConnectionUnavailableException

This method will be called when events need to be published via this sink

Specified by:

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

Parameters:

payload - payload of the event based on the supported event class exported by the extensions

dynamicOptions - holds the dynamic options of this sink and Use this object to obtain dynamic options.

Throws:

io.siddhi.core.exception.ConnectionUnavailableException - if end point is unavailable the ConnectionUnavailableException thrown such that the system will take care retrying for connection

disconnect

public void disconnect()

Called after all publishing is done, or when ConnectionUnavailableException is thrown Implementation of this method should contain the steps needed to disconnect from the sink.

Specified by:

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

destroy

public void destroy()

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

Specified by:

destroy 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

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

Returns:

array of supported classes , if extension can support of any types of classes then return empty array .

exposeServiceDeploymentInfo

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

Specified by:

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