org.agorava.spi

Class ProviderConfigOauth20

java.lang.Object

org.agorava.spi.ProviderConfig

org.agorava.spi.ProviderConfigOauth

org.agorava.spi.ProviderConfigOauth20

Direct Known Subclasses:

ProviderConfigOauth20Final

public abstract class ProviderConfigOauth20
extends ProviderConfigOauth

Default Provider configuration implementing the OAuth protocol, version 2.0 (draft 11)

This class is meant to be extended by concrete implementations of the API, providing the endpoints and endpoint-http-verbs.

If your Api adheres to the 2.0 (draft 11) protocol correctly, you just need to extend this class and define the getters for your endpoints.

If your Api does something a bit different, you can override the different extractors or services, in order to fine-tune the process.

Author:

Diego Silveira, Antoine Sabot-Durand

Nested Class Summary

Nested classes/interfaces inherited from class org.agorava.spi.ProviderConfigOauth

ProviderConfigOauth.SignaturePlace

Constructor Summary

Constructors

Constructor and Description
ProviderConfigOauth20()

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getAccessTokenEndpoint() Returns the URL that receives the access token requests.
TokenExtractor	getAccessTokenExtractor() Returns the access token extractor.
Verb	getAccessTokenVerb() Returns the verb for the access token endpoint (defaults to GET)
abstract String	getAuthorizationUrl(OAuthAppSettings config) Returns the URL where you should redirect your users to authenticate your application.
OAuth.OAuthVersion	getOAuthVersion()

Methods inherited from class org.agorava.spi.ProviderConfigOauth

getSignaturePlace

Methods inherited from class org.agorava.spi.ProviderConfig

getProviderAnnotation, getProviderName

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderConfigOauth20

public ProviderConfigOauth20()

Method Detail

getAccessTokenExtractor

public TokenExtractor getAccessTokenExtractor()

Returns the access token extractor.

Specified by:

getAccessTokenExtractor in class ProviderConfigOauth

Returns:

access token extractor

getAccessTokenVerb

public Verb getAccessTokenVerb()

Returns the verb for the access token endpoint (defaults to GET)

Returns:

access token endpoint verb

getAccessTokenEndpoint

public abstract String getAccessTokenEndpoint()

Returns the URL that receives the access token requests.

Returns:

access token URL

getAuthorizationUrl

public abstract String getAuthorizationUrl(OAuthAppSettings config)

Returns the URL where you should redirect your users to authenticate your application.

Parameters:

config - OAuth 2.0 configuration param object

Returns:

the URL where you should redirect your users

getOAuthVersion

public OAuth.OAuthVersion getOAuthVersion()

Specified by:

getOAuthVersion in class ProviderConfigOauth

Returns:

the OAuth version supported by the tier