Package 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	Description
OAuth20Service(DefaultApi20 api, String apiKey, String apiSecret, String callback, String defaultScope, String responseType, OutputStream debugStream, String userAgent, HttpClientConfig httpClientConfig, HttpClient httpClient)

Method Summary

Modifier and Type	Method	Description
protected OAuthRequest	createAccessTokenClientCredentialsGrantRequest(String scope)
protected OAuthRequest	createAccessTokenDeviceAuthorizationGrantRequest(DeviceAuthorization deviceAuthorization)
protected OAuthRequest	createAccessTokenPasswordGrantRequest(String username, String password, String scope)
protected OAuthRequest	createAccessTokenRequest(AccessTokenRequestParams params)
AuthorizationUrlBuilder	createAuthorizationUrlBuilder()
protected OAuthRequest	createDeviceAuthorizationCodesRequest(String scope)
protected OAuthRequest	createRefreshTokenRequest(String refreshToken, String scope)
protected OAuthRequest	createRevokeTokenRequest(String tokenToRevoke, TokenTypeHint tokenTypeHint)
OAuth2Authorization	extractAuthorization(String redirectLocation)
OAuth2AccessToken	getAccessToken(AccessTokenRequestParams params)
Future<OAuth2AccessToken>	getAccessToken(AccessTokenRequestParams params, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)	Start the request to retrieve the access token.
OAuth2AccessToken	getAccessToken(String code)
Future<OAuth2AccessToken>	getAccessToken(String code, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)
Future<OAuth2AccessToken>	getAccessTokenAsync(AccessTokenRequestParams params)
Future<OAuth2AccessToken>	getAccessTokenAsync(String code)
OAuth2AccessToken	getAccessTokenClientCredentialsGrant()
Future<OAuth2AccessToken>	getAccessTokenClientCredentialsGrant(OAuthAsyncRequestCallback<OAuth2AccessToken> callback)	Start the request to retrieve the access token using client-credentials grant.
OAuth2AccessToken	getAccessTokenClientCredentialsGrant(String scope)
Future<OAuth2AccessToken>	getAccessTokenClientCredentialsGrant(String scope, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)
Future<OAuth2AccessToken>	getAccessTokenClientCredentialsGrantAsync()
Future<OAuth2AccessToken>	getAccessTokenClientCredentialsGrantAsync(String scope)
OAuth2AccessToken	getAccessTokenDeviceAuthorizationGrant(DeviceAuthorization deviceAuthorization)	Attempts to get a token from a server.
Future<OAuth2AccessToken>	getAccessTokenDeviceAuthorizationGrant(DeviceAuthorization deviceAuthorization, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)
Future<OAuth2AccessToken>	getAccessTokenDeviceAuthorizationGrantAsync(DeviceAuthorization deviceAuthorization)
OAuth2AccessToken	getAccessTokenPasswordGrant(String username, String password)
OAuth2AccessToken	getAccessTokenPasswordGrant(String username, String password, String scope)
Future<OAuth2AccessToken>	getAccessTokenPasswordGrantAsync(String username, String password)
Future<OAuth2AccessToken>	getAccessTokenPasswordGrantAsync(String username, String password, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)	Request Access Token Password Grant async version
Future<OAuth2AccessToken>	getAccessTokenPasswordGrantAsync(String username, String password, String scope)
Future<OAuth2AccessToken>	getAccessTokenPasswordGrantAsync(String username, String password, String scope, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)
DefaultApi20	getApi()
String	getAuthorizationUrl()	Returns the URL where you should redirect your users to authenticate your application.
String	getAuthorizationUrl(PKCE pkce)
String	getAuthorizationUrl(String state)
String	getAuthorizationUrl(Map<String,String> additionalParams)	Returns the URL where you should redirect your users to authenticate your application.
String	getDefaultScope()
DeviceAuthorization	getDeviceAuthorizationCodes()	Requests a set of verification codes from the authorization server with the default scope
Future<DeviceAuthorization>	getDeviceAuthorizationCodes(OAuthAsyncRequestCallback<DeviceAuthorization> callback)
DeviceAuthorization	getDeviceAuthorizationCodes(String scope)	Requests a set of verification codes from the authorization server
Future<DeviceAuthorization>	getDeviceAuthorizationCodes(String scope, OAuthAsyncRequestCallback<DeviceAuthorization> callback)
Future<DeviceAuthorization>	getDeviceAuthorizationCodesAsync()
Future<DeviceAuthorization>	getDeviceAuthorizationCodesAsync(String scope)
String	getResponseType()
String	getVersion()	Returns the OAuth version of the service.
protected void	logRequestWithParams(String requestDescription, OAuthRequest request)
OAuth2AccessToken	pollAccessTokenDeviceAuthorizationGrant(DeviceAuthorization deviceAuthorization)	Periodically tries to get a token from a server (waiting for the user to give consent).
OAuth2AccessToken	refreshAccessToken(String refreshToken)
Future<OAuth2AccessToken>	refreshAccessToken(String refreshToken, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)
OAuth2AccessToken	refreshAccessToken(String refreshToken, String scope)
Future<OAuth2AccessToken>	refreshAccessToken(String refreshToken, String scope, OAuthAsyncRequestCallback<OAuth2AccessToken> callback)
Future<OAuth2AccessToken>	refreshAccessTokenAsync(String refreshToken)
Future<OAuth2AccessToken>	refreshAccessTokenAsync(String refreshToken, String scope)
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, getApiKey, getApiSecret, getCallback, isDebug, log, log

Methods inherited from class java.lang.Object

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

Constructor Details

OAuth20Service

public OAuth20Service(DefaultApi20 api,
 String apiKey,
 String apiSecret,
 String callback,
 String defaultScope,
 String responseType,
 OutputStream debugStream,
 String userAgent,
 HttpClientConfig httpClientConfig,
 HttpClient httpClient)

Method Details

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 void signRequest(OAuth2AccessToken accessToken,
 OAuthRequest request)

getAuthorizationUrl

public 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(String state)

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

getAuthorizationUrl

public String getAuthorizationUrl(PKCE pkce)

createAuthorizationUrlBuilder

public AuthorizationUrlBuilder createAuthorizationUrlBuilder()

getApi

public DefaultApi20 getApi()

extractAuthorization

public OAuth2Authorization extractAuthorization(String redirectLocation)

getResponseType

public String getResponseType()

getDefaultScope

public String getDefaultScope()

logRequestWithParams

protected void logRequestWithParams(String requestDescription,
 OAuthRequest request)

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)

createAccessTokenRequest

protected OAuthRequest createAccessTokenRequest(AccessTokenRequestParams params)

getAccessTokenAsync

public Future<OAuth2AccessToken> getAccessTokenAsync(String code)

getAccessTokenAsync

public Future<OAuth2AccessToken> getAccessTokenAsync(AccessTokenRequestParams params)

getAccessToken

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

Throws:

IOException

InterruptedException

ExecutionException

getAccessToken

public OAuth2AccessToken getAccessToken(AccessTokenRequestParams params)
                                 throws IOException,
InterruptedException,
ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getAccessToken

public Future<OAuth2AccessToken> getAccessToken(AccessTokenRequestParams params,
 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:

params - params

callback - optional callback

Returns:

Future

getAccessToken

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

createRefreshTokenRequest

protected OAuthRequest createRefreshTokenRequest(String refreshToken,
 String scope)

refreshAccessTokenAsync

public Future<OAuth2AccessToken> refreshAccessTokenAsync(String refreshToken)

refreshAccessTokenAsync

public Future<OAuth2AccessToken> refreshAccessTokenAsync(String refreshToken,
 String scope)

refreshAccessToken

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

Throws:

IOException

InterruptedException

ExecutionException

refreshAccessToken

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

Throws:

IOException

InterruptedException

ExecutionException

refreshAccessToken

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

refreshAccessToken

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

createAccessTokenPasswordGrantRequest

protected OAuthRequest createAccessTokenPasswordGrantRequest(String username,
 String password,
 String scope)

getAccessTokenPasswordGrant

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

Throws:

IOException

InterruptedException

ExecutionException

getAccessTokenPasswordGrant

public OAuth2AccessToken getAccessTokenPasswordGrant(String username,
 String password,
 String scope)
                                              throws IOException,
InterruptedException,
ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getAccessTokenPasswordGrantAsync

public Future<OAuth2AccessToken> getAccessTokenPasswordGrantAsync(String username,
 String password)

getAccessTokenPasswordGrantAsync

public Future<OAuth2AccessToken> getAccessTokenPasswordGrantAsync(String username,
 String password,
 String scope)

getAccessTokenPasswordGrantAsync

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

Request Access Token Password Grant async version

Parameters:

username - User name

password - User password

callback - Optional callback

Returns:

Future

getAccessTokenPasswordGrantAsync

public Future<OAuth2AccessToken> getAccessTokenPasswordGrantAsync(String username,
 String password,
 String scope,
 OAuthAsyncRequestCallback<OAuth2AccessToken> callback)

createAccessTokenClientCredentialsGrantRequest

protected OAuthRequest createAccessTokenClientCredentialsGrantRequest(String scope)

getAccessTokenClientCredentialsGrantAsync

public Future<OAuth2AccessToken> getAccessTokenClientCredentialsGrantAsync()

getAccessTokenClientCredentialsGrantAsync

public Future<OAuth2AccessToken> getAccessTokenClientCredentialsGrantAsync(String scope)

getAccessTokenClientCredentialsGrant

public OAuth2AccessToken getAccessTokenClientCredentialsGrant()
                                                       throws IOException,
InterruptedException,
ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getAccessTokenClientCredentialsGrant

public OAuth2AccessToken getAccessTokenClientCredentialsGrant(String scope)
                                                       throws IOException,
InterruptedException,
ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getAccessTokenClientCredentialsGrant

public 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

getAccessTokenClientCredentialsGrant

public Future<OAuth2AccessToken> getAccessTokenClientCredentialsGrant(String scope,
 OAuthAsyncRequestCallback<OAuth2AccessToken> callback)

createRevokeTokenRequest

protected OAuthRequest createRevokeTokenRequest(String tokenToRevoke,
 TokenTypeHint tokenTypeHint)

revokeTokenAsync

public Future<Void> revokeTokenAsync(String tokenToRevoke)

revokeTokenAsync

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

revokeToken

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

Throws:

IOException

InterruptedException

ExecutionException

revokeToken

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

Throws:

IOException

InterruptedException

ExecutionException

revokeToken

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

revokeToken

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

createDeviceAuthorizationCodesRequest

protected OAuthRequest createDeviceAuthorizationCodesRequest(String scope)

getDeviceAuthorizationCodes

public DeviceAuthorization getDeviceAuthorizationCodes()
                                                throws InterruptedException,
ExecutionException,
IOException

Requests a set of verification codes from the authorization server with the default scope

Returns:

DeviceAuthorization

Throws:

InterruptedException - InterruptedException

ExecutionException - ExecutionException

IOException - IOException

See Also:

• RFC 8628

getDeviceAuthorizationCodes

public DeviceAuthorization getDeviceAuthorizationCodes(String scope)
                                                throws InterruptedException,
ExecutionException,
IOException

Requests a set of verification codes from the authorization server

Parameters:

scope - scope

Returns:

DeviceAuthorization

Throws:

InterruptedException - InterruptedException

ExecutionException - ExecutionException

IOException - IOException

See Also:

• RFC 8628

getDeviceAuthorizationCodes

public Future<DeviceAuthorization> getDeviceAuthorizationCodes(OAuthAsyncRequestCallback<DeviceAuthorization> callback)

getDeviceAuthorizationCodes

public Future<DeviceAuthorization> getDeviceAuthorizationCodes(String scope,
 OAuthAsyncRequestCallback<DeviceAuthorization> callback)

getDeviceAuthorizationCodesAsync

public Future<DeviceAuthorization> getDeviceAuthorizationCodesAsync()

getDeviceAuthorizationCodesAsync

public Future<DeviceAuthorization> getDeviceAuthorizationCodesAsync(String scope)

createAccessTokenDeviceAuthorizationGrantRequest

protected OAuthRequest createAccessTokenDeviceAuthorizationGrantRequest(DeviceAuthorization deviceAuthorization)

getAccessTokenDeviceAuthorizationGrant

public OAuth2AccessToken getAccessTokenDeviceAuthorizationGrant(DeviceAuthorization deviceAuthorization)
                                                         throws InterruptedException,
ExecutionException,
IOException

Attempts to get a token from a server. Function pollAccessTokenDeviceAuthorizationGrant(com.github.scribejava.core.model.DeviceAuthorization) is usually used instead of this.

Parameters:

deviceAuthorization - deviceAuthorization

Returns:

token

Throws:

InterruptedException - InterruptedException

ExecutionException - ExecutionException

IOException - IOException

OAuth2AccessTokenErrorResponse - If OAuth2AccessTokenErrorResponse.getError() is OAuth2Error.AUTHORIZATION_PENDING or OAuth2Error.SLOW_DOWN, another attempt should be made after a while.

See Also:

• getDeviceAuthorizationCodes()

getAccessTokenDeviceAuthorizationGrant

public Future<OAuth2AccessToken> getAccessTokenDeviceAuthorizationGrant(DeviceAuthorization deviceAuthorization,
 OAuthAsyncRequestCallback<OAuth2AccessToken> callback)

getAccessTokenDeviceAuthorizationGrantAsync

public Future<OAuth2AccessToken> getAccessTokenDeviceAuthorizationGrantAsync(DeviceAuthorization deviceAuthorization)

pollAccessTokenDeviceAuthorizationGrant

public OAuth2AccessToken pollAccessTokenDeviceAuthorizationGrant(DeviceAuthorization deviceAuthorization)
                                                          throws InterruptedException,
ExecutionException,
IOException

Periodically tries to get a token from a server (waiting for the user to give consent). Sync only version. No Async variants yet, one should implement async scenarios themselves.

Parameters:

deviceAuthorization - deviceAuthorization

Returns:

token

Throws:

InterruptedException - InterruptedException

ExecutionException - ExecutionException

IOException - IOException

OAuth2AccessTokenErrorResponse - Indicates OAuth error.

See Also:

• getDeviceAuthorizationCodes()