TwitterTemplate (Spring Social 1.0.5.RELEASE API)

java.lang.Object
- org.springframework.social.oauth1.AbstractOAuth1ApiBinding
- - 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

Constructors
Constructor and Description
`TwitterTemplate()` Deprecated. Because all resources now require authorization, this constructor isn't very useful. It will be removed in Spring Social Twitter 1.1.0.
`TwitterTemplate(String clientToken)` Create a new instance of TwitterTemplate.
`TwitterTemplate(String consumerKey, String consumerSecret, String accessToken, String accessTokenSecret)` Create a new instance of TwitterTemplate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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()`
`org.springframework.web.client.RestTemplate`	`getRestTemplate()`
`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, 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
```
@Deprecated
public TwitterTemplate()
```
    Deprecated. Because all resources now require authorization, this constructor isn't very useful. It will be removed in Spring Social Twitter 1.1.0.
    
    Create a new instance of TwitterTemplate. This constructor creates a new TwitterTemplate able to perform unauthenticated operations against Twitter's API. Any operations requiring authentication will throw NotAuthorizedException . As of v1.1 of Twitter's API, all resources require authorization. Therefore, any instance of TwitterTemplate created with this constructor will be effectively useless.
  - TwitterTemplate
```
public TwitterTemplate(String consumerKey,
                       String consumerSecret,
                       String accessToken,
                       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
  - TwitterTemplate
```
public TwitterTemplate(String clientToken)
```
    Create a new instance of TwitterTemplate. This instance of TwitterTemplate is limited to only performing operations requiring client authorization. For instance, you can use it to search Twitter, but you cannot use it to post a status update. The access token you use here must be obtained via OAuth 2 Client Credentials Grant. See OAuth2Operations.authenticateClient().
    
    Parameters:
    
    clientToken - an access token obtained through OAuth 2 client credentials grant 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
  - getRestTemplate
```
public org.springframework.web.client.RestTemplate getRestTemplate()
```
    Overrides:
    
    getRestTemplate in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
  - 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

Class TwitterTemplate

Constructor Summary

Method Summary

Methods inherited from class org.springframework.social.oauth1.AbstractOAuth1ApiBinding

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.social.ApiBinding

Constructor Detail

TwitterTemplate

TwitterTemplate

TwitterTemplate

Method Detail

timelineOperations

friendOperations

listOperations

searchOperations

directMessageOperations

userOperations

blockOperations

geoOperations

restOperations

getRestTemplate

getJsonMessageConverter

configureRestTemplate