com.github.scribejava.core.builder.api

Class DefaultApi20

java.lang.Object

com.github.scribejava.core.builder.api.DefaultApi20

public abstract class DefaultApi20
extends Object

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
DefaultApi20()

Method Summary

Modifier and Type	Method and Description
OAuth20Service	createService(OAuthConfig config)
abstract String	getAccessTokenEndpoint() Returns the URL that receives the access token requests.
TokenExtractor<OAuth2AccessToken>	getAccessTokenExtractor() Returns the access token extractor.
Verb	getAccessTokenVerb() Returns the verb for the access token endpoint (defaults to GET)
abstract String	getAuthorizationUrl(OAuthConfig config) Returns the URL where you should redirect your users to authenticate your application.
String	getAuthorizationUrl(OAuthConfig config, Map<String,String> additionalParams) Returns the URL where you should redirect your users to authenticate your application.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultApi20

public DefaultApi20()

Method Detail

getAccessTokenExtractor

public TokenExtractor<OAuth2AccessToken> getAccessTokenExtractor()

Returns the access token extractor.

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(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

getAuthorizationUrl

public String getAuthorizationUrl(OAuthConfig config,
                                  Map<String,String> additionalParams)

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

Parameters:

config - OAuth 2.0 configuration param object

additionalParams - any additional GET params to add to the URL

Returns:

the URL where you should redirect your users

createService

public OAuth20Service createService(OAuthConfig config)