com.sap.cloud.security.xsuaa.tokenflows.RefreshTokenFlow Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of token-client Show documentation
There is a newer version: 3.5.6
/**
 * SPDX-FileCopyrightText: 2018-2023 SAP SE or an SAP affiliate company and Cloud Security Client Java contributors
 * 
 * SPDX-License-Identifier: Apache-2.0
 */
package com.sap.cloud.security.xsuaa.tokenflows;

import com.sap.cloud.security.config.ClientIdentity;
import com.sap.cloud.security.xsuaa.client.OAuth2ServiceEndpointsProvider;
import com.sap.cloud.security.xsuaa.client.OAuth2ServiceException;
import com.sap.cloud.security.xsuaa.client.OAuth2TokenResponse;
import com.sap.cloud.security.xsuaa.client.OAuth2TokenService;

import static com.sap.cloud.security.xsuaa.Assertions.assertNotNull;

/**
 * A refresh token flow builder. 
 Applications can use this flow exchange a given refresh token for a (refreshed)
 * JWT token.
 */
public class RefreshTokenFlow {
	private final ClientIdentity clientIdentity;
	private final OAuth2ServiceEndpointsProvider endpointsProvider;
	private String refreshToken;
	private final OAuth2TokenService tokenService;
	private boolean disableCache = false;
	private String subdomain;

	/**
	 * Creates a new instance.
	 *
	 * @param tokenService
	 * 		- the {@link OAuth2TokenService} used to execute the final request.
	 * @param endpointsProvider
	 * 		- the endpoints provider
	 * @param clientIdentity
	 * 		- the OAuth client identity
	 */
	RefreshTokenFlow(OAuth2TokenService tokenService, OAuth2ServiceEndpointsProvider endpointsProvider,
			ClientIdentity clientIdentity) {
		assertNotNull(tokenService, "OAuth2TokenService must not be null.");
		assertNotNull(endpointsProvider, "OAuth2ServiceEndpointsProvider must not be null.");
		assertNotNull(clientIdentity, "ClientIdentity must not be null.");

		this.tokenService = tokenService;
		this.clientIdentity = clientIdentity;
		this.endpointsProvider = endpointsProvider;
	}

	/**
	 * Sets the subdomain (tenant) the token is requested for.

	 *
	 * @param subdomain
	 * 		- the subdomain.
	 * @return this builder.
	 */
	public RefreshTokenFlow subdomain(String subdomain) {
		this.subdomain = subdomain;
		return this;
	}

	/**
	 * Sets the mandatory refresh token to be exchanged for a (refreshed) JWT.
	 *
	 * @param refreshToken
	 * 		- the refresh token to be exchanged for a JWT.
	 * @return this builder object.
	 */
	public RefreshTokenFlow refreshToken(String refreshToken) {
		assertNotNull(refreshToken, "RefreshToken must not be null.");
		this.refreshToken = refreshToken;
		return this;
	}

	/**
	 * Can be used to disable the cache for the flow.
	 *
	 * @param disableCache
	 * 		- disables cache when set to {@code true}.
	 * @return this builder.
	 */
	public RefreshTokenFlow disableCache(boolean disableCache) {
		this.disableCache = disableCache;
		return this;
	}

	/**
	 * Executes the refresh token flow against XSUAA.
	 *
	 * @return the refreshed OAuth access token returned by XSUAA or an exception in case the token could not be
	 * 		refreshed.
	 * @throws IllegalStateException
	 * 		- in case not all mandatory fields of the token flow request have been set.
	 * @throws IllegalArgumentException
	 * 		- in case the refresh token flow request is not valid.
	 * @throws TokenFlowException
	 * 		- in case of an error during the flow, or when the token cannot be refreshed.
	 */
	public OAuth2TokenResponse execute() throws IllegalStateException, IllegalArgumentException, TokenFlowException {
		if (refreshToken == null) {
			throw new IllegalStateException(
					"Refresh token not set. Make sure to have called the refreshToken() method on RefreshTokenFlow builder.");
		}

		try {
			return tokenService.retrieveAccessTokenViaRefreshToken(
					endpointsProvider.getTokenEndpoint(),
					clientIdentity, refreshToken,
					subdomain, disableCache);
		} catch (OAuth2ServiceException e) {
			throw new TokenFlowException(
					String.format("Error refreshing token with grant_type 'refresh_token': %s", e.getMessage()), e);
		}
	}
}