org.springframework.social.oauth1

Class GenericOAuth1ConnectionFactory

java.lang.Object

org.springframework.social.connect.ConnectionFactory<A>

org.springframework.social.connect.support.OAuth1ConnectionFactory<org.springframework.web.client.RestOperations>

org.springframework.social.oauth1.GenericOAuth1ConnectionFactory

public class GenericOAuth1ConnectionFactory
extends OAuth1ConnectionFactory<org.springframework.web.client.RestOperations>

Generic implementation of an OAuth1ConnectionFactory that carries no intrinsic knowledge of the API it will be creating connections against. Instead, it must be configured with API provider-specific details. This enables developers to use Spring Social to create connections against any API for which there isn't a ready-to-use connection support and API binding without creating one-off connection factory and service provider implementations. The API binding provided by this connection factory is simply a RestOperations, but the underlying RestTemplate is configured to automatically add Authorization headers to all requests.

Author:

Craig Walls

Constructor Summary

Constructors

Constructor and Description
GenericOAuth1ConnectionFactory(java.lang.String providerId, java.lang.String consumerKey, java.lang.String consumerSecret, java.lang.String requestTokenUrl, java.lang.String authorizeUrl, java.lang.String accessTokenUrl, OAuth1Version oauth1Version, ApiAdapter<org.springframework.web.client.RestOperations> apiAdapter) Creates an instance of GenericOAuth1ConnectionFactory.
GenericOAuth1ConnectionFactory(java.lang.String providerId, java.lang.String consumerKey, java.lang.String consumerSecret, java.lang.String requestTokenUrl, java.lang.String authorizeUrl, java.lang.String authenticateUrl, java.lang.String accessTokenUrl, OAuth1Version oauth1Version, ApiAdapter<org.springframework.web.client.RestOperations> apiAdapter) Creates an instance of GenericOAuth1ConnectionFactory for a provider that offers a separate authentication URL.

Method Summary

Methods inherited from class org.springframework.social.connect.support.OAuth1ConnectionFactory

createConnection, createConnection, extractProviderUserId, getOAuthOperations

Methods inherited from class org.springframework.social.connect.ConnectionFactory

getApiAdapter, getProviderId, getServiceProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericOAuth1ConnectionFactory

public GenericOAuth1ConnectionFactory(java.lang.String providerId,
                              java.lang.String consumerKey,
                              java.lang.String consumerSecret,
                              java.lang.String requestTokenUrl,
                              java.lang.String authorizeUrl,
                              java.lang.String accessTokenUrl,
                              OAuth1Version oauth1Version,
                              ApiAdapter<org.springframework.web.client.RestOperations> apiAdapter)

Creates an instance of GenericOAuth1ConnectionFactory.

Parameters:

providerId - Some String that acts as the unique ID for the API provider.

consumerKey - The application's consumer key for the API.

consumerSecret - The application's consumer secret for the API.

requestTokenUrl - The API's OAuth 1.0/1.0a request token URL.

authorizeUrl - The API's OAuth 1.0/1.0a authorization URL.

accessTokenUrl - The API's OAuth 1.0/1.0a access token URL.

oauth1Version - The version of OAuth 1 (OAuth 1.0 or OAuth 1.0a) supported by the provider.

apiAdapter - A custom implementation of ApiAdapter used to fetch data when creating the connection.

GenericOAuth1ConnectionFactory

public GenericOAuth1ConnectionFactory(java.lang.String providerId,
                              java.lang.String consumerKey,
                              java.lang.String consumerSecret,
                              java.lang.String requestTokenUrl,
                              java.lang.String authorizeUrl,
                              java.lang.String authenticateUrl,
                              java.lang.String accessTokenUrl,
                              OAuth1Version oauth1Version,
                              ApiAdapter<org.springframework.web.client.RestOperations> apiAdapter)

Creates an instance of GenericOAuth1ConnectionFactory for a provider that offers a separate authentication URL.

Parameters:

providerId - Some String that acts as the unique ID for the API provider.

consumerKey - The application's consumer key for the API.

consumerSecret - The application's consumer secret for the API.

requestTokenUrl - The API's OAuth 1.0/1.0a request token URL.

authorizeUrl - The API's OAuth 1.0/1.0a authorization URL.

authenticateUrl - The API's OAuth 1.0/1.0a authentication URL. If null, will default to the authorizeUrl.

accessTokenUrl - The API's OAuth 1.0/1.0a access token URL.

oauth1Version - The version of OAuth 1 (OAuth 1.0 or OAuth 1.0a) supported by the provider.

apiAdapter - A custom implementation of ApiAdapter used to fetch data when creating the connection.