org.springframework.social.oauth2

Interface OAuth2ServiceProvider<A>

Type Parameters:

A - The service provider's API type

All Superinterfaces:

ServiceProvider<A>

All Known Implementing Classes:

AbstractOAuth2ServiceProvider, GenericOAuth2ServiceProvider

public interface OAuth2ServiceProvider<A>
extends ServiceProvider<A>

A ServiceProvider that uses the OAuth 2.0 protocol.

Method Summary

Methods

Modifier and Type	Method and Description
A	getApi(String accessToken) Returns an API interface allowing the client application to access protected resources on behalf of a user.
OAuth2Operations	getOAuthOperations() Get the service interface for carrying out the "OAuth dance" with this provider.

Method Detail

getOAuthOperations

OAuth2Operations getOAuthOperations()

Get the service interface for carrying out the "OAuth dance" with this provider. The result of the OAuth dance is an access token that can be used to obtain a API binding.

Returns:

an OAuth2Operations for carrying out the "OAuth dance" with this provider.

getApi

A getApi(String accessToken)

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

Parameters:

accessToken - the API access token

Returns:

a binding to the service provider's API