Package org.keycloak.protocol.oidc.refresh

Interface RefreshTokenProvider

All Superinterfaces:
Provider
All Known Implementing Classes:
AbstractRefreshTokenProvider, DefaultRefreshTokenProvider
public interface RefreshTokenProvider extends Provider
Provider responsible for verification of refresh tokens and issuing of new refresh tokens

  • Method Details

    • supports

      boolean supports(RefreshTokenContext ctx)
      Parameters:
      ctx - Context, which contains old refresh token and some other data
      Returns:
      True if this provider supports verification of the refresh token from the context

    • refreshAccessToken

      TokenManager.AccessTokenResponseBuilder refreshAccessToken(RefreshTokenContext ctx) throws OAuthErrorException
      Invoked during refresh-token request. Implements verifications related to old refresh token and creates token-response if all the verifications are successful
      Parameters:
      ctx - Context, which contains old refresh token and some other data
      Returns:
      successful token-response with new tokens and data, which would be returned in the successful token response
      Throws:
      OAuthErrorException - In case that validation failed or some other issue happened during token refresh

    • close

      default void close()
      Specified by:
      close in interface Provider