org.springframework.integration.x.twitter

Class TwitterStreamChannelAdapter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.MessageProducerSupport

org.springframework.integration.x.twitter.AbstractTwitterInboundChannelAdapter

org.springframework.integration.x.twitter.TwitterStreamChannelAdapter

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.integration.core.MessageProducer, org.springframework.integration.history.TrackableComponent, org.springframework.integration.support.context.NamedComponent

public class TwitterStreamChannelAdapter
extends AbstractTwitterInboundChannelAdapter

Message producer which reads form Twitter's public stream endpoints. Unless filtering parameters are set, it will read from the statuses/sample.json endpoint, but if any of the track, follow or locations parameters are set, it will switch to using statuses/filter.json. The available parameters map directly to those defined for the public streams API.

Author:

Mark Fisher, Luke Taylor, David Turanski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TwitterStreamChannelAdapter.FilterLevel

Nested classes/interfaces inherited from class org.springframework.integration.x.twitter.AbstractTwitterInboundChannelAdapter

AbstractTwitterInboundChannelAdapter.StreamReadingTask

Field Summary

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleCondition, lifecycleLock

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
TwitterStreamChannelAdapter(org.springframework.social.twitter.api.impl.TwitterTemplate twitter)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.net.URI	buildUri()
protected void	doSendLine(java.lang.String line)
java.lang.String	getComponentType()
void	setDelimited(boolean delimited) Whether "delimited=length" shoud be added to the query.
void	setFilterLevel(TwitterStreamChannelAdapter.FilterLevel filterLevel) One of "none", "low" or "medium"
void	setFollow(java.lang.String follow) Restrict the stream to a user or users.
void	setLocations(java.lang.String locations) Bound the returned tweets by location(s).
void	setStallWarnings(boolean stallWarnings) Whether "stall_warnings=true" should be added to the query.
void	setTrack(java.lang.String track) Filter tweets by words or phrases.

Methods inherited from class org.springframework.integration.x.twitter.AbstractTwitterInboundChannelAdapter

doStart, doStop, getLanguage, onInit, setConnectTimeout, setLanguage, setReadTimeout, wait

Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport

sendMessage, setErrorChannel, setOutputChannel, setSendTimeout, setShouldTrack

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

doStop, getPhase, isAutoStartup, isRunning, setAutoStartup, setPhase, setTaskScheduler, start, stop, stop

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getComponentName

Constructor Detail

TwitterStreamChannelAdapter

public TwitterStreamChannelAdapter(org.springframework.social.twitter.api.impl.TwitterTemplate twitter)

Method Detail

setDelimited

public void setDelimited(boolean delimited)

Whether "delimited=length" shoud be added to the query.

setStallWarnings

public void setStallWarnings(boolean stallWarnings)

Whether "stall_warnings=true" should be added to the query.

setFilterLevel

public void setFilterLevel(TwitterStreamChannelAdapter.FilterLevel filterLevel)

One of "none", "low" or "medium"

setTrack

public void setTrack(java.lang.String track)

Filter tweets by words or phrases.

setFollow

public void setFollow(java.lang.String follow)

Restrict the stream to a user or users.

setLocations

public void setLocations(java.lang.String locations)

Bound the returned tweets by location(s).

getComponentType

public java.lang.String getComponentType()

Specified by:

getComponentType in interface org.springframework.integration.support.context.NamedComponent

Overrides:

getComponentType in class org.springframework.integration.context.IntegrationObjectSupport

buildUri

protected java.net.URI buildUri()

Specified by:

buildUri in class AbstractTwitterInboundChannelAdapter

doSendLine

protected void doSendLine(java.lang.String line)

Specified by:

doSendLine in class AbstractTwitterInboundChannelAdapter