Package de.sonallux.spotify.api.authorization.authorization_code

Class AuthorizationCodePKCEFlow

java.lang.Object

de.sonallux.spotify.api.authorization.TokenStoreApiAuthorizationProvider

de.sonallux.spotify.api.authorization.authorization_code.AuthorizationCodePKCEFlow

All Implemented Interfaces:

ApiAuthorizationProvider

public class AuthorizationCodePKCEFlow
extends TokenStoreApiAuthorizationProvider

Implements the Authorization Code Flow with Proof Key for Code Exchange (PKCE)

Field Summary

Fields inherited from class de.sonallux.spotify.api.authorization.TokenStoreApiAuthorizationProvider

tokenStore

Constructor Summary

Constructors

Constructor	Description
AuthorizationCodePKCEFlow(String clientId, String redirectUri)
AuthorizationCodePKCEFlow(String clientId, String redirectUri, TokenStore tokenStore)

Method Summary

Modifier and Type	Method	Description
AuthorizationUrlBuilder	createAuthorizationUrl(String codeChallenge)
void	exchangeAuthorizationCode(AuthorizationRedirectResponse<String> authResponse, String codeVerifier)
AuthorizationRedirectResponse<String>	parseAuthorizationRedirectResponse(String url)
boolean	refreshAccessToken()	Callback to initiate a token refresh after a 401 Unauthorized response from the Spotify Web API.

Methods inherited from class de.sonallux.spotify.api.authorization.TokenStoreApiAuthorizationProvider

getAuthorizationHeaderValue

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationCodePKCEFlow

public AuthorizationCodePKCEFlow(String clientId,
                                 String redirectUri,
                                 TokenStore tokenStore)

AuthorizationCodePKCEFlow

public AuthorizationCodePKCEFlow(String clientId,
                                 String redirectUri)

Method Detail

createAuthorizationUrl

public AuthorizationUrlBuilder createAuthorizationUrl(String codeChallenge)

exchangeAuthorizationCode

public void exchangeAuthorizationCode(AuthorizationRedirectResponse<String> authResponse,
                                      String codeVerifier)
                               throws SpotifyAuthorizationException

Throws:

SpotifyAuthorizationException

refreshAccessToken

public boolean refreshAccessToken()

Description copied from interface: ApiAuthorizationProvider

Callback to initiate a token refresh after a 401 Unauthorized response from the Spotify Web API. If this operation is not supported or failed, return false. A return value of true indicates that the failing request should be retried. The ApiAuthorizationProvider.getAuthorizationHeaderValue() method will be called again to get the new header with the new token

Specified by:

refreshAccessToken in interface ApiAuthorizationProvider

Overrides:

refreshAccessToken in class TokenStoreApiAuthorizationProvider

Returns:

true to indicate to successful token refresh, otherwise false

parseAuthorizationRedirectResponse

public AuthorizationRedirectResponse<String> parseAuthorizationRedirectResponse(String url)