com.github.scribejava.core.oauth

Class OAuth20Service

java.lang.Object

com.github.scribejava.core.oauth.OAuthService

com.github.scribejava.core.oauth.OAuth20Service

All Implemented Interfaces:

Closeable, AutoCloseable

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 OAuthRequest	createAccessTokenClientCredentialsGrantRequest()
protected OAuthRequest	createAccessTokenPasswordGrantRequest(String username, String password)
protected OAuthRequest	createAccessTokenRequest(String code)
protected OAuthRequest	createAccessTokenRequest(String code, String pkceCodeVerifier)
protected OAuthRequest	createRefreshTokenRequest(String refreshToken)
protected OAuthRequest	createRevokeTokenRequest(String tokenToRevoke, TokenTypeHint tokenTypeHint)
OAuth2Authorization	extractAuthorization(String redirectLocation)
OAuth2AccessToken	getAccessToken(String code)
Future<OAuth2AccessToken>	getAccessToken(String code, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)
Future<OAuth2AccessToken>	getAccessToken(String code, OAuthAsyncRequestCallback<OAuth2AccessToken> callback, String pkceCodeVerifier) Start the request to retrieve the access token.
OAuth2AccessToken	getAccessToken(String code, String pkceCodeVerifier)
Future<OAuth2AccessToken>	getAccessTokenAsync(String code)
Future<OAuth2AccessToken>	getAccessTokenAsync(String code, String pkceCodeVerifier)
OAuth2AccessToken	getAccessTokenClientCredentialsGrant()
Future<OAuth2AccessToken>	getAccessTokenClientCredentialsGrant(OAuthAsyncRequestCallback<OAuth2AccessToken> callback) Start the request to retrieve the access token using client-credentials grant.
Future<OAuth2AccessToken>	getAccessTokenClientCredentialsGrantAsync()
OAuth2AccessToken	getAccessTokenPasswordGrant(String uname, String password)
Future<OAuth2AccessToken>	getAccessTokenPasswordGrantAsync(String uname, String password)
Future<OAuth2AccessToken>	getAccessTokenPasswordGrantAsync(String uname, String password, OAuthAsyncRequestCallback<OAuth2AccessToken> callback) Request Access Token Password Grant async version
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	getAuthorizationUrl(Map<String,String> additionalParams, PKCE pkce)
String	getAuthorizationUrl(PKCE pkce)
AuthorizationUrlWithPKCE	getAuthorizationUrlWithPKCE()
AuthorizationUrlWithPKCE	getAuthorizationUrlWithPKCE(Map<String,String> additionalParams)
String	getVersion() Returns the OAuth version of the service.
OAuth2AccessToken	refreshAccessToken(String refreshToken)
Future<OAuth2AccessToken>	refreshAccessToken(String refreshToken, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)
Future<OAuth2AccessToken>	refreshAccessTokenAsync(String refreshToken)
void	revokeToken(String tokenToRevoke)
Future<Void>	revokeToken(String tokenToRevoke, OAuthAsyncRequestCallback<Void> callback)
Future<Void>	revokeToken(String tokenToRevoke, OAuthAsyncRequestCallback<Void> callback, TokenTypeHint tokenTypeHint)
void	revokeToken(String tokenToRevoke, TokenTypeHint tokenTypeHint)
Future<Void>	revokeTokenAsync(String tokenToRevoke)
Future<Void>	revokeTokenAsync(String tokenToRevoke, TokenTypeHint tokenTypeHint)
protected Future<OAuth2AccessToken>	sendAccessTokenRequestAsync(OAuthRequest request)
protected Future<OAuth2AccessToken>	sendAccessTokenRequestAsync(OAuthRequest request, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)
protected OAuth2AccessToken	sendAccessTokenRequestSync(OAuthRequest request)
void	signRequest(OAuth2AccessToken accessToken, OAuthRequest request)
void	signRequest(String accessToken, OAuthRequest request)

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

close, execute, execute, execute, executeAsync, 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)
                                                throws IOException,
                                                       InterruptedException,
                                                       ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

sendAccessTokenRequestAsync

protected Future<OAuth2AccessToken> sendAccessTokenRequestAsync(OAuthRequest request)

sendAccessTokenRequestAsync

protected Future<OAuth2AccessToken> sendAccessTokenRequestAsync(OAuthRequest request,
                                                                OAuthAsyncRequestCallback<OAuth2AccessToken> callback)

getAccessTokenAsync

public final Future<OAuth2AccessToken> getAccessTokenAsync(String code)

getAccessTokenAsync

public final Future<OAuth2AccessToken> getAccessTokenAsync(String code,
                                                           String pkceCodeVerifier)

getAccessToken

public final OAuth2AccessToken getAccessToken(String code)
                                       throws IOException,
                                              InterruptedException,
                                              ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getAccessToken

public final OAuth2AccessToken getAccessToken(String code,
                                              String pkceCodeVerifier)
                                       throws IOException,
                                              InterruptedException,
                                              ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getAccessToken

public final Future<OAuth2AccessToken> getAccessToken(String code,
                                                      OAuthAsyncRequestCallback<OAuth2AccessToken> callback,
                                                      String pkceCodeVerifier)

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

pkceCodeVerifier - pkce Code Verifier

Returns:

Future

getAccessToken

public final Future<OAuth2AccessToken> getAccessToken(String code,
                                                      OAuthAsyncRequestCallback<OAuth2AccessToken> callback)

createAccessTokenRequest

protected OAuthRequest createAccessTokenRequest(String code)

createAccessTokenRequest

protected OAuthRequest createAccessTokenRequest(String code,
                                                String pkceCodeVerifier)

refreshAccessTokenAsync

public final Future<OAuth2AccessToken> refreshAccessTokenAsync(String refreshToken)

refreshAccessToken

public final OAuth2AccessToken refreshAccessToken(String refreshToken)
                                           throws IOException,
                                                  InterruptedException,
                                                  ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

refreshAccessToken

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

createRefreshTokenRequest

protected OAuthRequest createRefreshTokenRequest(String refreshToken)

getAccessTokenPasswordGrant

public final OAuth2AccessToken getAccessTokenPasswordGrant(String uname,
                                                           String password)
                                                    throws IOException,
                                                           InterruptedException,
                                                           ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getAccessTokenPasswordGrantAsync

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

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

createAccessTokenPasswordGrantRequest

protected OAuthRequest createAccessTokenPasswordGrantRequest(String username,
                                                             String password)

getAccessTokenClientCredentialsGrantAsync

public final Future<OAuth2AccessToken> getAccessTokenClientCredentialsGrantAsync()

getAccessTokenClientCredentialsGrant

public final OAuth2AccessToken getAccessTokenClientCredentialsGrant()
                                                             throws IOException,
                                                                    InterruptedException,
                                                                    ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getAccessTokenClientCredentialsGrant

public final Future<OAuth2AccessToken> getAccessTokenClientCredentialsGrant(OAuthAsyncRequestCallback<OAuth2AccessToken> callback)

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

Parameters:

callback - optional callback

Returns:

Future

createAccessTokenClientCredentialsGrantRequest

protected OAuthRequest createAccessTokenClientCredentialsGrantRequest()

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(String accessToken,
                        OAuthRequest request)

signRequest

public final void signRequest(OAuth2AccessToken accessToken,
                              OAuthRequest request)

getAuthorizationUrlWithPKCE

public final AuthorizationUrlWithPKCE getAuthorizationUrlWithPKCE()

getAuthorizationUrlWithPKCE

public final AuthorizationUrlWithPKCE getAuthorizationUrlWithPKCE(Map<String,String> additionalParams)

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

getAuthorizationUrl

public final String getAuthorizationUrl(PKCE pkce)

getAuthorizationUrl

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

getApi

public DefaultApi20 getApi()

createRevokeTokenRequest

protected OAuthRequest createRevokeTokenRequest(String tokenToRevoke,
                                                TokenTypeHint tokenTypeHint)

revokeTokenAsync

public final Future<Void> revokeTokenAsync(String tokenToRevoke)

revokeTokenAsync

public final Future<Void> revokeTokenAsync(String tokenToRevoke,
                                           TokenTypeHint tokenTypeHint)

revokeToken

public final void revokeToken(String tokenToRevoke)
                       throws IOException,
                              InterruptedException,
                              ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

revokeToken

public final void revokeToken(String tokenToRevoke,
                              TokenTypeHint tokenTypeHint)
                       throws IOException,
                              InterruptedException,
                              ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

revokeToken

public final Future<Void> revokeToken(String tokenToRevoke,
                                      OAuthAsyncRequestCallback<Void> callback)

revokeToken

public final Future<Void> revokeToken(String tokenToRevoke,
                                      OAuthAsyncRequestCallback<Void> callback,
                                      TokenTypeHint tokenTypeHint)

extractAuthorization

public OAuth2Authorization extractAuthorization(String redirectLocation)