jsimple.oauth.builder.api

Class DefaultOAuthApi20

java.lang.Object

jsimple.oauth.builder.api.DefaultOAuthApi20

All Implemented Interfaces:

OAuthApi

Direct Known Subclasses:

FacebookOAuthApi, LiveOAuthApi

public abstract class DefaultOAuthApi20
extends java.lang.Object
implements OAuthApi

Default implementation of 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. Please read the javadocs of the interfaces to get an idea of what to do.

Constructor Summary

Constructors

Constructor and Description
DefaultOAuthApi20()

Method Summary

Modifier and Type	Method and Description
OAuthService	createService(OAuthConfig config) Creates an OAuthService
abstract java.lang.String	getAccessTokenEndpoint() Returns the URL that receives the access token requests.
AccessTokenExtractor	getAccessTokenExtractor() Returns the access token extractor.
java.lang.String	getAccessTokenVerb() Returns the verb for the access token endpoint (defaults to GET)
abstract java.lang.String	getAuthorizationUrl(OAuthConfig config) Returns the URL where you should redirect your users to authenticate your application.
java.lang.String	getRefreshTokenParameterName() I (Bret Johnson) merged in refresh token support from the scribe fork here: https://github.com/fernandezpablo85/scribe-java/pull/253

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOAuthApi20

public DefaultOAuthApi20()

Method Detail

getAccessTokenExtractor

public AccessTokenExtractor getAccessTokenExtractor()

Returns the access token extractor.

Returns:

access token extractor

getAccessTokenVerb

public java.lang.String getAccessTokenVerb()

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

Returns:

access token endpoint verb

getAccessTokenEndpoint

public abstract java.lang.String getAccessTokenEndpoint()

Returns the URL that receives the access token requests.

Returns:

access token URL

getAuthorizationUrl

public abstract java.lang.String getAuthorizationUrl(OAuthConfig 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

createService

public OAuthService createService(OAuthConfig config)

Creates an OAuthService

Specified by:

createService in interface OAuthApi

Parameters:

config - config info (apiKey, apiSecret, callback, scope)

Returns:

fully configured OAuthService

getRefreshTokenParameterName

public java.lang.String getRefreshTokenParameterName()

I (Bret Johnson) merged in refresh token support from the scribe fork here: https://github.com/fernandezpablo85/scribe-java/pull/253

Returns:

the parameter needed to refresh an access token