org.agorava.spi

Class ProviderConfigOauth10a

java.lang.Object

org.agorava.spi.ProviderConfig

org.agorava.spi.ProviderConfigOauth

org.agorava.spi.ProviderConfigOauth10a

public abstract class ProviderConfigOauth10a
extends ProviderConfigOauth

Default Provider configuration implementing the OAuth protocol, version 1.0a

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

If your Api adheres to the 1.0a 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:

Pablo Fernandez, Antoine Sabot-Durand

Nested Class Summary

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

ProviderConfigOauth.SignaturePlace

Constructor Summary

Constructors

Constructor and Description
ProviderConfigOauth10a()

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 POST)
abstract String	getAuthorizationUrl(Token requestToken) Returns the URL where you should redirect your users to authenticate your application.
StringExtractor	getBaseStringExtractor() Returns the base string extractor.
StringExtractor	getHeaderExtractor() Returns the header extractor.
OAuth.OAuthVersion	getOAuthVersion()
abstract String	getRequestTokenEndpoint() Returns the URL that receives the request token requests.
TokenExtractor	getRequestTokenExtractor() Returns the request token extractor.
Verb	getRequestTokenVerb() Returns the verb for the request token endpoint (defaults to POST)
SignatureService	getSignatureService() Returns the signature service.
TimestampService	getTimestampService() Returns the timestamp service.

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

ProviderConfigOauth10a

public ProviderConfigOauth10a()

Method Detail

getAccessTokenExtractor

public TokenExtractor getAccessTokenExtractor()

Returns the access token extractor.

Specified by:

getAccessTokenExtractor in class ProviderConfigOauth

Returns:

access token extractor

getBaseStringExtractor

public StringExtractor getBaseStringExtractor()

Returns the base string extractor.

Returns:

base string extractor

getHeaderExtractor

public StringExtractor getHeaderExtractor()

Returns the header extractor.

Returns:

header extractor

getRequestTokenExtractor

public TokenExtractor getRequestTokenExtractor()

Returns the request token extractor.

Returns:

request token extractor

getSignatureService

public SignatureService getSignatureService()

Returns the signature service.

Returns:

signature service

getTimestampService

public TimestampService getTimestampService()

Returns the timestamp service.

Returns:

timestamp service

getAccessTokenVerb

public Verb getAccessTokenVerb()

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

Returns:

access token endpoint verb

getRequestTokenVerb

public Verb getRequestTokenVerb()

Returns the verb for the request token endpoint (defaults to POST)

Returns:

request token endpoint verb

getRequestTokenEndpoint

public abstract String getRequestTokenEndpoint()

Returns the URL that receives the request token requests.

Returns:

request token URL

getAccessTokenEndpoint

public abstract String getAccessTokenEndpoint()

Returns the URL that receives the access token requests.

Returns:

access token URL

getAuthorizationUrl

public abstract String getAuthorizationUrl(Token requestToken)

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

Parameters:

requestToken - the request token you need to authorize

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