org.wso2.extension.siddhi.io.twitter.source

Class TwitterSource

java.lang.Object

org.wso2.siddhi.core.stream.input.source.Source

org.wso2.extension.siddhi.io.twitter.source.TwitterSource

All Implemented Interfaces:

org.wso2.siddhi.core.util.snapshot.Snapshotable

public class TwitterSource
extends org.wso2.siddhi.core.stream.input.source.Source

Twitter Source Implementation

Nested Class Summary

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

org.wso2.siddhi.core.stream.input.source.Source.ConnectionCallback

Constructor Summary

Constructors

Constructor and Description
TwitterSource()

Method Summary

Modifier and Type	Method and Description
void	connect(org.wso2.siddhi.core.stream.input.source.Source.ConnectionCallback connectionCallback) Initially Called to connect to the end point for start retrieving the messages asynchronously .
Map<String,Object>	currentState() Used to collect the serializable state of the processing element, that need to be persisted for the reconstructing the element to the same state on a different point of time
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.
Class[]	getOutputEventClasses() Returns the list of classes which this source can output.
void	init(org.wso2.siddhi.core.stream.input.source.SourceEventListener sourceEventListener, org.wso2.siddhi.core.util.transport.OptionHolder optionHolder, String[] requestedTransportPropertyNames, org.wso2.siddhi.core.util.config.ConfigReader configReader, org.wso2.siddhi.core.config.SiddhiAppContext siddhiAppContext) The initialization method for Source, will be called before other methods.
void	pause() Called to pause event consumption
void	restoreState(Map<String,Object> map) Used to restore serialized state of the processing element, for reconstructing the element to the same state as if was on a previous point of time.
void	resume() Called to resume event consumption

Methods inherited from class org.wso2.siddhi.core.stream.input.source.Source

connectWithRetry, getElementId, getMapper, getStreamDefinition, getType, init, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

TwitterSource

public TwitterSource()

Method Detail

init

public void init(org.wso2.siddhi.core.stream.input.source.SourceEventListener sourceEventListener,
                 org.wso2.siddhi.core.util.transport.OptionHolder optionHolder,
                 String[] requestedTransportPropertyNames,
                 org.wso2.siddhi.core.util.config.ConfigReader configReader,
                 org.wso2.siddhi.core.config.SiddhiAppContext siddhiAppContext)

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

Specified by:

init in class org.wso2.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 - ConfigReader is used to read the Source related system configuration.

siddhiAppContext - the context of the SiddhiApp used to get Siddhi related utility functions.

getOutputEventClasses

public Class[] getOutputEventClasses()

Returns the list of classes which this source can output.

Specified by:

getOutputEventClasses in class org.wso2.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.

connect

public void connect(org.wso2.siddhi.core.stream.input.source.Source.ConnectionCallback connectionCallback)
             throws org.wso2.siddhi.core.exception.ConnectionUnavailableException

Initially Called to connect to the end point for start retrieving the messages asynchronously .

Specified by:

connect in class org.wso2.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 receiving asynchronously)

Throws:

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

disconnect

public void disconnect()

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

Specified by:

disconnect in class org.wso2.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 org.wso2.siddhi.core.stream.input.source.Source

pause

public void pause()

Called to pause event consumption

Specified by:

pause in class org.wso2.siddhi.core.stream.input.source.Source

resume

public void resume()

Called to resume event consumption

Specified by:

resume in class org.wso2.siddhi.core.stream.input.source.Source

currentState

public Map<String,Object> currentState()

Used to collect the serializable state of the processing element, that need to be persisted for the reconstructing the element to the same state on a different point of time

Returns:

stateful objects of the processing element as a map

restoreState

public void restoreState(Map<String,Object> map)

Used to restore serialized state of the processing element, for reconstructing the element to the same state as if was on a previous point of time.

Parameters:

map - the stateful objects of the processing element as a map. This map will have the same keys that is created upon calling currentState() method.