Spring Social Twitter

org.springframework.social.twitter.api.impl
Class TwitterTemplate

java.lang.Object
  extended by org.springframework.social.oauth1.AbstractOAuth1ApiBinding
      extended by org.springframework.social.twitter.api.impl.TwitterTemplate
All Implemented Interfaces:
org.springframework.social.ApiBinding, Twitter

public class TwitterTemplate
extends org.springframework.social.oauth1.AbstractOAuth1ApiBinding
implements Twitter

This is the central class for interacting with Twitter.

Most (not all) Twitter operations require OAuth authentication. To perform such operations, TwitterTemplate must be constructed with the minimal amount of information required to sign requests to Twitter's API with an OAuth Authorization header.

There are some operations, such as searching, that do not require OAuth authentication. In those cases, you may use a TwitterTemplate that is created through the default constructor and without any OAuth details. Attempts to perform secured operations through such an instance, however, will result in NotAuthorizedException being thrown.

Author:
Craig Walls

Constructor Summary
TwitterTemplate()
          Create a new instance of TwitterTemplate.
TwitterTemplate(java.lang.String consumerKey, java.lang.String consumerSecret, java.lang.String accessToken, java.lang.String accessTokenSecret)
          Create a new instance of TwitterTemplate.
 
Method Summary
 BlockOperations blockOperations()
          Returns the portion of the Twitter API containing the block operations.
protected  void configureRestTemplate(org.springframework.web.client.RestTemplate restTemplate)
           
 DirectMessageOperations directMessageOperations()
          Returns the portion of the Twitter API containing the direct message operations.
 FriendOperations friendOperations()
          Returns the portion of the Twitter API containing the friends and followers operations.
 GeoOperations geoOperations()
          Returns the portion of the Twitter API containing the geo location operations.
protected  org.springframework.http.converter.json.MappingJacksonHttpMessageConverter getJsonMessageConverter()
           
 ListOperations listOperations()
          Returns the portion of the Twitter API containing the user list operations.
 org.springframework.web.client.RestOperations restOperations()
          Returns the underlying RestOperations object allowing for consumption of Twitter endpoints that may not be otherwise covered by the API binding.
 SearchOperations searchOperations()
          Returns the portion of the Twitter API containing the search operations.
 TimelineOperations timelineOperations()
          Returns the portion of the Twitter API containing the tweet and timeline operations.
 UserOperations userOperations()
          Returns the portion of the Twitter API containing the user operations.
 
Methods inherited from class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
getByteArrayMessageConverter, getFormMessageConverter, getMessageConverters, getRestTemplate, isAuthorized, setRequestFactory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.springframework.social.ApiBinding
isAuthorized
 

Constructor Detail

TwitterTemplate

public TwitterTemplate()
Create a new instance of TwitterTemplate. This constructor creates a new TwitterTemplate able to perform unauthenticated operations against Twitter's API. Some operations, such as search, do not require OAuth authentication. A TwitterTemplate created with this constructor will support those operations. Any operations requiring authentication will throw NotAuthorizedException .


TwitterTemplate

public TwitterTemplate(java.lang.String consumerKey,
                       java.lang.String consumerSecret,
                       java.lang.String accessToken,
                       java.lang.String accessTokenSecret)
Create a new instance of TwitterTemplate.

Parameters:
consumerKey - the application's API key
consumerSecret - the application's API secret
accessToken - an access token acquired through OAuth authentication with Twitter
accessTokenSecret - an access token secret acquired through OAuth authentication with Twitter
Method Detail

timelineOperations

public TimelineOperations timelineOperations()
Description copied from interface: Twitter
Returns the portion of the Twitter API containing the tweet and timeline operations.

Specified by:
timelineOperations in interface Twitter

friendOperations

public FriendOperations friendOperations()
Description copied from interface: Twitter
Returns the portion of the Twitter API containing the friends and followers operations.

Specified by:
friendOperations in interface Twitter

listOperations

public ListOperations listOperations()
Description copied from interface: Twitter
Returns the portion of the Twitter API containing the user list operations.

Specified by:
listOperations in interface Twitter

searchOperations

public SearchOperations searchOperations()
Description copied from interface: Twitter
Returns the portion of the Twitter API containing the search operations.

Specified by:
searchOperations in interface Twitter

directMessageOperations

public DirectMessageOperations directMessageOperations()
Description copied from interface: Twitter
Returns the portion of the Twitter API containing the direct message operations.

Specified by:
directMessageOperations in interface Twitter

userOperations

public UserOperations userOperations()
Description copied from interface: Twitter
Returns the portion of the Twitter API containing the user operations.

Specified by:
userOperations in interface Twitter

blockOperations

public BlockOperations blockOperations()
Description copied from interface: Twitter
Returns the portion of the Twitter API containing the block operations.

Specified by:
blockOperations in interface Twitter

geoOperations

public GeoOperations geoOperations()
Description copied from interface: Twitter
Returns the portion of the Twitter API containing the geo location operations.

Specified by:
geoOperations in interface Twitter

restOperations

public org.springframework.web.client.RestOperations restOperations()
Description copied from interface: Twitter
Returns the underlying RestOperations object allowing for consumption of Twitter endpoints that may not be otherwise covered by the API binding. The RestOperations object returned is configured to include an OAuth "Authorization" header on all requests.

Specified by:
restOperations in interface Twitter

getJsonMessageConverter

protected org.springframework.http.converter.json.MappingJacksonHttpMessageConverter getJsonMessageConverter()
Overrides:
getJsonMessageConverter in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding

configureRestTemplate

protected void configureRestTemplate(org.springframework.web.client.RestTemplate restTemplate)
Overrides:
configureRestTemplate in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding

Spring Social Twitter