org.springframework.integration.twitter.outbound

Class TwitterSearchOutboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.twitter.outbound.TwitterSearchOutboundGateway

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, Orderable, MessageProducer, IntegrationEvaluationContextAware, TrackableComponent, NamedComponent, MessageHandler

public class TwitterSearchOutboundGateway
extends AbstractReplyProducingMessageHandler
implements IntegrationEvaluationContextAware

The AbstractReplyProducingMessageHandler implementation to perform request/reply Twitter search with SearchParameters as the result of searchArgsExpression expression evaluation.

Since:

4.0

Author:

Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Field Summary

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

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

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
TwitterSearchOutboundGateway(Twitter twitter)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
protected Twitter	getTwitter()
protected java.lang.Object	handleRequestMessage(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
void	setIntegrationEvaluationContext(EvaluationContext evaluationContext)
void	setSearchArgsExpression(Expression searchArgsExpression) An expression that is used to build the search; must resolve to a SearchParameters object, or a String, in which case the default page size of 20 is applied, or a list of up to 4 arguments, such as "{payload, headers.pageSize, headers.sinceId, headers.maxId}".

Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

doInit, doInvokeAdvisedRequestHandler, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

getOutputChannel, produceOutput, sendOutputs, setChannelResolver, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

getOrder, handleMessage, setOrder, setShouldTrack

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, setTaskScheduler, 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

TwitterSearchOutboundGateway

public TwitterSearchOutboundGateway(Twitter twitter)

Method Detail

setIntegrationEvaluationContext

public void setIntegrationEvaluationContext(EvaluationContext evaluationContext)

Specified by:

setIntegrationEvaluationContext in interface IntegrationEvaluationContextAware

setSearchArgsExpression

public void setSearchArgsExpression(Expression searchArgsExpression)

An expression that is used to build the search; must resolve to a SearchParameters object, or a String, in which case the default page size of 20 is applied, or a list of up to 4 arguments, such as "{payload, headers.pageSize, headers.sinceId, headers.maxId}". The first (required) argument must resolve to a String (query), the optional arguments must resolve to an Number and represent the page size, sinceId, and maxId respectively. Refer to the 'Spring Social Twitter' documentation for more details.

When using a SearchParameters directly, it is not necessary to include the package: "new SearchParameters("#foo").count(20)").

Default: "payload".

Parameters:

searchArgsExpression - The expression.

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 AbstractMessageHandler

getTwitter

protected Twitter getTwitter()

handleRequestMessage

protected java.lang.Object handleRequestMessage(Message<?> requestMessage)

Description copied from class: AbstractReplyProducingMessageHandler

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.