org.springframework.social.oauth2

Class GenericOAuth2ServiceProvider

java.lang.Object

org.springframework.social.oauth2.AbstractOAuth2ServiceProvider<org.springframework.web.client.RestOperations>

org.springframework.social.oauth2.GenericOAuth2ServiceProvider

All Implemented Interfaces:

OAuth2ServiceProvider<org.springframework.web.client.RestOperations>, ServiceProvider<org.springframework.web.client.RestOperations>

public class GenericOAuth2ServiceProvider
extends AbstractOAuth2ServiceProvider<org.springframework.web.client.RestOperations>

Generic implementation of OAuth2ServiceProvider 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 service provider 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
GenericOAuth2ServiceProvider(java.lang.String appId, java.lang.String appSecret, java.lang.String authorizeUrl, java.lang.String authenticateUrl, java.lang.String accessTokenUrl, boolean useParametersForClientCredentials, TokenStrategy tokenStrategy) Creates an instance of GenericOAuth1ServiceProvider for a provider that offers a separate authentication URL.

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.web.client.RestOperations	getApi(java.lang.String accessToken) Returns an API interface allowing the client application to access protected resources on behalf of a user.

Methods inherited from class org.springframework.social.oauth2.AbstractOAuth2ServiceProvider

getOAuthOperations

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericOAuth2ServiceProvider

public GenericOAuth2ServiceProvider(java.lang.String appId,
                            java.lang.String appSecret,
                            java.lang.String authorizeUrl,
                            java.lang.String authenticateUrl,
                            java.lang.String accessTokenUrl,
                            boolean useParametersForClientCredentials,
                            TokenStrategy tokenStrategy)

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

Parameters:

appId - The application's ID/key for the API.

appSecret - The application's secret for the API.

authorizeUrl - The API's OAuth 2 authorization URL.

authenticateUrl - The API's OAuth 2 authentication URL. If null, then the authorization URL will be used by default.

accessTokenUrl - The API's OAuth 2 access token URL.

useParametersForClientCredentials - If true, client credentials will be sent as parameters. If false, the client with be authenticated via HTTP Basic

tokenStrategy - The token strategy indicating how the access token should be carried on API requests.

Method Detail

getApi

public org.springframework.web.client.RestOperations getApi(java.lang.String accessToken)

Description copied from interface: OAuth2ServiceProvider

Returns an API interface allowing the client application to access protected resources on behalf of a user.

Specified by:

getApi in interface OAuth2ServiceProvider<org.springframework.web.client.RestOperations>

Specified by:

getApi in class AbstractOAuth2ServiceProvider<org.springframework.web.client.RestOperations>

Parameters:

accessToken - the API access token

Returns:

a binding to the service provider's API