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	createAccessTokenPasswordGrantRequest(String username, String password, T request)
protected <T extends AbstractRequest> T	createAccessTokenRequest(String code, T request)
protected <T extends AbstractRequest> T	createRefreshTokenRequest(String refreshToken, T request)
OAuth2Authorization	extractAuthorization(String redirectLocation)
OAuth2AccessToken	getAccessToken(String code)
Future<OAuth2AccessToken>	getAccessTokenAsync(String code, OAuthAsyncRequestCallback<OAuth2AccessToken> callback) Start the request to retrieve the access token.
Future<OAuth2AccessToken>	getAccessTokenAsync(String code, OAuthAsyncRequestCallback<OAuth2AccessToken> callback, com.ning.http.client.ProxyServer proxyServer)
OAuth2AccessToken	getAccessTokenPasswordGrant(String uname, String password) Request Access Token Password Grant sync version
Future<OAuth2AccessToken>	getAccessTokenPasswordGrantAsync(String uname, String password, OAuthAsyncRequestCallback<OAuth2AccessToken> callback) Request Access Token Password Grant async version
Future<OAuth2AccessToken>	getAccessTokenPasswordGrantAsync(String uname, String password, 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)
protected Future<OAuth2AccessToken>	sendAccessTokenRequestAsync(OAuthRequestAsync request, OAuthAsyncRequestCallback<OAuth2AccessToken> callback, com.ning.http.client.ProxyServer proxyServer)
protected OAuth2AccessToken	sendAccessTokenRequestSync(OAuthRequest request)
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

sendAccessTokenRequestSync

protected OAuth2AccessToken sendAccessTokenRequestSync(OAuthRequest request)

sendAccessTokenRequestAsync

protected Future<OAuth2AccessToken> sendAccessTokenRequestAsync(OAuthRequestAsync request,
                                                                OAuthAsyncRequestCallback<OAuth2AccessToken> callback,
                                                                com.ning.http.client.ProxyServer proxyServer)

getAccessToken

public final OAuth2AccessToken getAccessToken(String code)

getAccessTokenAsync

public final Future<OAuth2AccessToken> getAccessTokenAsync(String code,
                                                           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:

code - code

callback - optional callback

Returns:

Future

getAccessTokenAsync

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

createAccessTokenRequest

protected <T extends AbstractRequest> T createAccessTokenRequest(String code,
                                                                 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)

getAccessTokenPasswordGrant

public final OAuth2AccessToken getAccessTokenPasswordGrant(String uname,
                                                           String password)

Request Access Token Password Grant sync version

Parameters:

uname - User name

password - User password

Returns:

OAuth2AccessToken

getAccessTokenPasswordGrantAsync

public final Future<OAuth2AccessToken> getAccessTokenPasswordGrantAsync(String uname,
                                                                        String password,
                                                                        OAuthAsyncRequestCallback<OAuth2AccessToken> callback)

Request Access Token Password Grant async version

Parameters:

uname - User name

password - User password

callback - Optional callback

Returns:

Future

getAccessTokenPasswordGrantAsync

public final Future<OAuth2AccessToken> getAccessTokenPasswordGrantAsync(String uname,
                                                                        String password,
                                                                        OAuthAsyncRequestCallback<OAuth2AccessToken> callback,
                                                                        com.ning.http.client.ProxyServer proxyServer)

createAccessTokenPasswordGrantRequest

protected <T extends AbstractRequest> T createAccessTokenPasswordGrantRequest(String username,
                                                                              String password,
                                                                              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()

extractAuthorization

public OAuth2Authorization extractAuthorization(String redirectLocation)