org.agorava.spi

Class ProviderConfigOauth20Final

java.lang.Object

org.agorava.spi.ProviderConfig

org.agorava.spi.ProviderConfigOauth

org.agorava.spi.ProviderConfigOauth20

org.agorava.spi.ProviderConfigOauth20Final

public abstract class ProviderConfigOauth20Final
extends ProviderConfigOauth20

Default Provider configuration implementing the OAuth protocol, version 2.0 final

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 final 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:

Antoine Sabot-Durand

Nested Class Summary

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

ProviderConfigOauth.SignaturePlace

Constructor Summary

Constructors

Constructor and Description
ProviderConfigOauth20Final()

Method Summary

Methods

Modifier and Type	Method and Description
TokenExtractor	getAccessTokenExtractor() Returns the access token extractor.
Verb	getAccessTokenVerb() Returns the verb for the access token endpoint (defaults to GET)
OAuth.OAuthVersion	getOAuthVersion()

Methods inherited from class org.agorava.spi.ProviderConfigOauth20

getAccessTokenEndpoint, getAuthorizationUrl

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

ProviderConfigOauth20Final

public ProviderConfigOauth20Final()

Method Detail

getAccessTokenVerb

public Verb getAccessTokenVerb()

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

Overrides:

getAccessTokenVerb in class ProviderConfigOauth20

Returns:

access token endpoint verb

getAccessTokenExtractor

public TokenExtractor getAccessTokenExtractor()

Returns the access token extractor.

Overrides:

getAccessTokenExtractor in class ProviderConfigOauth20

Returns:

access token extractor

getOAuthVersion

public OAuth.OAuthVersion getOAuthVersion()

Overrides:

getOAuthVersion in class ProviderConfigOauth20

Returns:

the OAuth version supported by the tier