org.springframework.integration.twitter.inbound

Class DirectMessageReceivingMessageSource

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.twitter.inbound.DirectMessageReceivingMessageSource

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, ExpressionCapable, MessageSource, NamedComponent

public class DirectMessageReceivingMessageSource
extends IntegrationObjectSupport

This class handles support for receiving DMs (direct messages) using Twitter.

Since:

2.0

Author:

Josh Long, Oleg Zhurakousky, Mark Fisher, Gary Russell

Field Summary

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

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor and Description
DirectMessageReceivingMessageSource(org.springframework.social.twitter.api.Twitter twitter, java.lang.String metadataKey)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
long	getLastProcessedId()
protected int	getPageSize()
protected org.springframework.social.twitter.api.Twitter	getTwitter()
protected void	onInit() Subclasses may implement this for initialization logic.
protected java.util.List<org.springframework.social.twitter.api.DirectMessage>	pollForTweets(long sinceId) Subclasses must implement this to return tweets.
org.springframework.messaging.Message<?>	receive() Retrieve the next available message from this source.
void	setMetadataStore(MetadataStore metadataStore)
void	setPageSize(int pageSize) Set the limit for the number of results returned on each poll; default 20.
void	setPrefetchThreshold(int prefetchThreshold)

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectMessageReceivingMessageSource

public DirectMessageReceivingMessageSource(org.springframework.social.twitter.api.Twitter twitter,
                                           java.lang.String metadataKey)

Method Detail

getComponentType

public java.lang.String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class IntegrationObjectSupport

pollForTweets

protected java.util.List<org.springframework.social.twitter.api.DirectMessage> pollForTweets(long sinceId)

Subclasses must implement this to return tweets. The 'sinceId' value will be negative if no last id is known.

Parameters:

sinceId - The id of the last reported tweet.

Returns:

The list of tweets.

setMetadataStore

public void setMetadataStore(MetadataStore metadataStore)

setPrefetchThreshold

public void setPrefetchThreshold(int prefetchThreshold)

getTwitter

protected org.springframework.social.twitter.api.Twitter getTwitter()

getPageSize

protected int getPageSize()

setPageSize

public void setPageSize(int pageSize)

Set the limit for the number of results returned on each poll; default 20.

Parameters:

pageSize - The pageSize.

onInit

protected void onInit()
               throws java.lang.Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

Throws:

java.lang.Exception - Any exception.

receive

public org.springframework.messaging.Message<?> receive()

Description copied from interface: MessageSource

Retrieve the next available message from this source. Returns null if no message is available.

Specified by:

receive in interface MessageSource

Returns:

The message or null.

getLastProcessedId

@ManagedAttribute
public long getLastProcessedId()

Returns:

-1 if lastProcessedId is not set, yet.