org.apache.flink.streaming.connectors.twitter

Class TwitterSource

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.source.RichSourceFunction<String>

org.apache.flink.streaming.connectors.twitter.TwitterSource

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.api.common.functions.StoppableFunction, org.apache.flink.streaming.api.functions.source.SourceFunction<String>

public class TwitterSource
extends org.apache.flink.streaming.api.functions.source.RichSourceFunction<String>
implements org.apache.flink.api.common.functions.StoppableFunction

Implementation of SourceFunction specialized to emit tweets from Twitter. This is not a parallel source because the Twitter API only allows two concurrent connections.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TwitterSource.EndpointInitializer Implementing this interface allows users of this source to set a custom endpoint.

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.source.SourceFunction

org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_BUFFER_SIZE
static String	CLIENT_HOSTS
static String	CLIENT_NAME
static String	CONSUMER_KEY
static String	CONSUMER_SECRET
static String	TOKEN
static String	TOKEN_SECRET

Constructor Summary

Constructors

Constructor and Description
TwitterSource(Properties properties) Create TwitterSource for streaming

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	close()
void	open(org.apache.flink.configuration.Configuration parameters)
void	run(org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<String> ctx)
void	setCustomEndpointInitializer(TwitterSource.EndpointInitializer initializer) Set a custom endpoint initializer.
void	stop()

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Field Detail

CONSUMER_KEY

public static final String CONSUMER_KEY

See Also:

Constant Field Values

CONSUMER_SECRET

public static final String CONSUMER_SECRET

See Also:

Constant Field Values

TOKEN

public static final String TOKEN

See Also:

Constant Field Values

TOKEN_SECRET

public static final String TOKEN_SECRET

See Also:

Constant Field Values

CLIENT_NAME

public static final String CLIENT_NAME

See Also:

Constant Field Values

CLIENT_HOSTS

public static final String CLIENT_HOSTS

See Also:

Constant Field Values

CLIENT_BUFFER_SIZE

public static final String CLIENT_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

TwitterSource

public TwitterSource(Properties properties)

Create TwitterSource for streaming

Parameters:

properties - For the source

Method Detail

setCustomEndpointInitializer

public void setCustomEndpointInitializer(TwitterSource.EndpointInitializer initializer)

Set a custom endpoint initializer.

open

public void open(org.apache.flink.configuration.Configuration parameters)
          throws Exception

Specified by:

open in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

open in class org.apache.flink.api.common.functions.AbstractRichFunction

Throws:

Exception

run

public void run(org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<String> ctx)
         throws Exception

Specified by:

run in interface org.apache.flink.streaming.api.functions.source.SourceFunction<String>

Throws:

Exception

close

public void close()

Specified by:

close in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

close in class org.apache.flink.api.common.functions.AbstractRichFunction

cancel

public void cancel()

Specified by:

cancel in interface org.apache.flink.streaming.api.functions.source.SourceFunction<String>

stop

public void stop()

Specified by:

stop in interface org.apache.flink.api.common.functions.StoppableFunction