flux
Interface TwitterAction

All Superinterfaces:

Action, Cloneable, flux.runtimedatamap.RuntimeDataMap, Serializable

public interface TwitterAction
extends Action

TwitterAction that supports OAuth protected resources inside a Flux job.

Author:

arul@fluxcorp.com

Nested Class Summary

static class

TwitterAction.TwitterActionResult The response from the Twitter resource.

Method Summary

void	setConsumerKey(String apiKey) Sets Twitter Application consumer key.
void	setConsumerSecret(String apiSecret) Sets Twitter Application consumer secret.
void	setCount(int count) Sets the number of records to retrieve.
void	setOAuthEnabled(boolean oAuthEnabled) Sets OAuth for protected resources.
void	setPage(int page) Sets the page of results to retrieve.
void	setParameters(Properties parameters) Sets the body parameters.
void	setPassword(String password) Sets the password of the consumer.
void	setRequestMethod(RestActionType actionType) Sets the HTTP action used to access resources.
void	setResourceUrl(String url) Sets the resource URL.
void	setSearchQuery(String searchQuery) Sets the search query.
void	setUsername(String username) Sets the username of the consumer.

Methods inherited from interface flux.Action

addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

setRequestMethod

void setRequestMethod(RestActionType actionType)

Sets the HTTP action used to access resources. Default is GET.

Parameters:

actionType - HTTP Verb used to access resources.

setConsumerKey

void setConsumerKey(String apiKey)

Sets Twitter Application consumer key.

Parameters:

apiKey - OAuth consumer key.

setCount

void setCount(int count)

Sets the number of records to retrieve.

Parameters:

count - the number of records to retrieve.

setConsumerSecret

void setConsumerSecret(String apiSecret)

Sets Twitter Application consumer secret.

Parameters:

apiSecret - OAuth consumer secret.

setOAuthEnabled

void setOAuthEnabled(boolean oAuthEnabled)

Sets OAuth for protected resources. Defaults to false.

Parameters:

oAuthEnabled - OAuth for protected resources.

setPage

void setPage(int page)

Sets the page of results to retrieve.

Parameters:

page - the page of results to retrieve.

setParameters

void setParameters(Properties parameters)

Sets the body parameters.

Parameters:

parameters - Body parameters.

setPassword

void setPassword(String password)

Sets the password of the consumer.

Parameters:

password - Password of the consumer.

setResourceUrl

void setResourceUrl(String url)

Sets the resource URL. For example, http://api.twitter.com/1/statuses/mentions.json or http://api.twitter.com/1/direct_messages/new.xml

Parameters:

url - resource URL.

setSearchQuery

void setSearchQuery(String searchQuery)

Sets the search query.

Parameters:

searchQuery - Search query.

setUsername

void setUsername(String username)

Sets the username of the consumer.

Parameters:

username - Username of the consumer.