io.siddhi.extension.io.email.source

Class EmailSource

java.lang.Object

io.siddhi.core.stream.input.source.Source

io.siddhi.extension.io.email.source.EmailSource

public class EmailSource
extends io.siddhi.core.stream.input.source.Source

The class implementing Email source.

Nested Class Summary

Nested classes/interfaces inherited from class io.siddhi.core.stream.input.source.Source

io.siddhi.core.stream.input.source.Source.ConnectionCallback

Constructor Summary

Constructors

Constructor and Description
EmailSource()

Method Summary

Modifier and Type	Method and Description
void	connect(io.siddhi.core.stream.input.source.Source.ConnectionCallback connectionCallback, io.siddhi.core.util.snapshot.state.State state) Intialy Called to connect to the end point for start retriving the messages asynchronisly .
void	destroy() Called at the end to clean all the resources consumed by the Source
void	disconnect() This method can be called when it is needed to disconnect from the end point.
protected io.siddhi.core.stream.ServiceDeploymentInfo	exposeServiceDeploymentInfo()
Class[]	getOutputEventClasses() Returns the list of classes which this source can output.
io.siddhi.core.util.snapshot.state.StateFactory	init(io.siddhi.core.stream.input.source.SourceEventListener sourceEventListener, io.siddhi.core.util.transport.OptionHolder optionHolder, String[] requiredProperties, io.siddhi.core.util.config.ConfigReader configReader, io.siddhi.core.config.SiddhiAppContext siddhiAppContext) The initialization method for Source, which will be called before other methods and validate the all configuration and getting the intial values.
void	pause() Called to pause event consumption
void	resume() Called to resume event consumption

Methods inherited from class io.siddhi.core.stream.input.source.Source

connectWithRetry, getMapper, getServiceDeploymentInfo, getStreamDefinition, getType, init, isStateful, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailSource

public EmailSource()

Method Detail

init

public io.siddhi.core.util.snapshot.state.StateFactory init(io.siddhi.core.stream.input.source.SourceEventListener sourceEventListener,
                                                            io.siddhi.core.util.transport.OptionHolder optionHolder,
                                                            String[] requiredProperties,
                                                            io.siddhi.core.util.config.ConfigReader configReader,
                                                            io.siddhi.core.config.SiddhiAppContext siddhiAppContext)

The initialization method for Source, 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.input.source.Source

Parameters:

sourceEventListener - After receiving events, the source should trigger onEvent() of this listener. Listener will then pass on the events to the appropriate mappers for processing .

optionHolder - Option holder containing static configuration related to the Source

configReader - to read the Source related system configuration.

siddhiAppContext - the context of the SiddhiApp used to get siddhi related utilty functions.

connect

public void connect(io.siddhi.core.stream.input.source.Source.ConnectionCallback connectionCallback,
                    io.siddhi.core.util.snapshot.state.State state)
             throws io.siddhi.core.exception.ConnectionUnavailableException

Intialy Called to connect to the end point for start retriving the messages asynchronisly .

Specified by:

connect in class io.siddhi.core.stream.input.source.Source

Parameters:

connectionCallback - Callback to pass the ConnectionUnavailableException in case of connection failure after initial successful connection(can be used when events are receving asynchronasily)

Throws:

io.siddhi.core.exception.ConnectionUnavailableException - if it cannot connect to the source backend immediately.

exposeServiceDeploymentInfo

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

Specified by:

exposeServiceDeploymentInfo in class io.siddhi.core.stream.input.source.Source

disconnect

public void disconnect()

This method can be called when it is needed to disconnect from the end point.

Specified by:

disconnect in class io.siddhi.core.stream.input.source.Source

destroy

public void destroy()

Called at the end to clean all the resources consumed by the Source

Specified by:

destroy in class io.siddhi.core.stream.input.source.Source

pause

public void pause()

Called to pause event consumption

Specified by:

pause in class io.siddhi.core.stream.input.source.Source

resume

public void resume()

Called to resume event consumption

Specified by:

resume in class io.siddhi.core.stream.input.source.Source

getOutputEventClasses

public Class[] getOutputEventClasses()

Returns the list of classes which this source can output.

Specified by:

getOutputEventClasses in class io.siddhi.core.stream.input.source.Source

Returns:

Array of classes that will be output by the source. Null or empty array if it can produce any type of class.