com.github.scribejava.core.oauth

Class OAuth20Service

java.lang.Object

com.github.scribejava.core.oauth.OAuthService

com.github.scribejava.core.oauth.OAuth20Service

public class OAuth20Service
extends OAuthService

Constructor Summary

Constructors

Constructor and Description
OAuth20Service(DefaultApi20 api, OAuthConfig config) Default constructor

Method Summary

Modifier and Type	Method and Description
protected <T extends AbstractRequest> T	createAccessTokenRequest(Verifier verifier, T request)
protected <T extends AbstractRequest> T	createRefreshTokenRequest(String refreshToken, T request)
OAuth2AccessToken	getAccessToken(Verifier verifier)
Future<OAuth2AccessToken>	getAccessTokenAsync(Verifier verifier, OAuthAsyncRequestCallback<OAuth2AccessToken> callback) Start the request to retrieve the access token.
Future<OAuth2AccessToken>	getAccessTokenAsync(Verifier verifier, OAuthAsyncRequestCallback<OAuth2AccessToken> callback, com.ning.http.client.ProxyServer proxyServer)
DefaultApi20	getApi()
String	getAuthorizationUrl() Returns the URL where you should redirect your users to authenticate your application.
String	getAuthorizationUrl(Map<String,String> additionalParams) Returns the URL where you should redirect your users to authenticate your application.
String	getVersion() Returns the OAuth version of the service.
OAuth2AccessToken	refreshAccessToken(String refreshToken)
Future<OAuth2AccessToken>	refreshAccessTokenAsync(String refreshToken, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)
Future<OAuth2AccessToken>	refreshAccessTokenAsync(String refreshToken, OAuthAsyncRequestCallback<OAuth2AccessToken> callback, com.ning.http.client.ProxyServer proxyServer)
void	signRequest(OAuth2AccessToken accessToken, AbstractRequest request)

Methods inherited from class com.github.scribejava.core.oauth.OAuthService

closeAsyncClient, getAsyncHttpClient, getConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth20Service

public OAuth20Service(DefaultApi20 api,
                      OAuthConfig config)

Default constructor

Parameters:

api - OAuth2.0 api information

config - OAuth 2.0 configuration param object

Method Detail

getAccessToken

public final OAuth2AccessToken getAccessToken(Verifier verifier)

getAccessTokenAsync

public final Future<OAuth2AccessToken> getAccessTokenAsync(Verifier verifier,
                                                           OAuthAsyncRequestCallback<OAuth2AccessToken> callback)

Start the request to retrieve the access token. The optionally provided callback will be called with the Token when it is available.

Parameters:

verifier - verifier code

callback - optional callback

Returns:

Future

getAccessTokenAsync

public final Future<OAuth2AccessToken> getAccessTokenAsync(Verifier verifier,
                                                           OAuthAsyncRequestCallback<OAuth2AccessToken> callback,
                                                           com.ning.http.client.ProxyServer proxyServer)

createAccessTokenRequest

protected <T extends AbstractRequest> T createAccessTokenRequest(Verifier verifier,
                                                                 T request)

refreshAccessToken

public final OAuth2AccessToken refreshAccessToken(String refreshToken)

refreshAccessTokenAsync

public final Future<OAuth2AccessToken> refreshAccessTokenAsync(String refreshToken,
                                                               OAuthAsyncRequestCallback<OAuth2AccessToken> callback)

refreshAccessTokenAsync

public final Future<OAuth2AccessToken> refreshAccessTokenAsync(String refreshToken,
                                                               OAuthAsyncRequestCallback<OAuth2AccessToken> callback,
                                                               com.ning.http.client.ProxyServer proxyServer)

createRefreshTokenRequest

protected <T extends AbstractRequest> T createRefreshTokenRequest(String refreshToken,
                                                                  T request)

getVersion

public String getVersion()

Returns the OAuth version of the service.

Specified by:

getVersion in class OAuthService

Returns:

OAuth version as string

signRequest

public void signRequest(OAuth2AccessToken accessToken,
                        AbstractRequest request)

getAuthorizationUrl

public final String getAuthorizationUrl()

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

Returns:

the URL where you should redirect your users

getAuthorizationUrl

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

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

Parameters:

additionalParams - any additional GET params to add to the URL

Returns:

the URL where you should redirect your users

getApi

public DefaultApi20 getApi()