com.azure.identity.AuthorizationCodeCredentialBuilder Maven / Gradle / Ivy
Show all versions of azure-identity Show documentation
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.identity;
import com.azure.core.util.logging.ClientLogger;
import com.azure.identity.implementation.util.ValidationUtil;
import java.net.URI;
import java.net.URISyntaxException;
/**
* Fluent credential builder for instantiating a {@link AuthorizationCodeCredential}.
*
* Authorization Code authentication in Azure is a type of authentication mechanism that allows users to
* authenticate with Microsoft Entra ID
* and obtain an authorization code that can be used to request an access token to access
* Azure resources. It is a widely used authentication mechanism and is supported by a wide range of Azure services
* and applications. It provides a secure and scalable way to authenticate users and grant them access to Azure
* resources.
* The AuthorizationCodeCredential authenticates a user or an application and acquires a token with the configured
* authorization code and the redirectURL where authorization code was received.
*
* Sample: Construct AuthorizationCodeCredential
*
* The following code sample demonstrates the creation of a {@link com.azure.identity.AuthorizationCodeCredential},
* using the {@link com.azure.identity.AuthorizationCodeCredentialBuilder} to configure it.
* The {@code authorizationCode}, {@code redirectUrl} and {@code clientId} are required to be configured to create
* {@link AuthorizationCodeCredential}. Once this credential is created, it may be passed into the builder of many of
* the Azure SDK for Java client builders as the 'credential' parameter.
*
*
*
* TokenCredential authorizationCodeCredential = new AuthorizationCodeCredentialBuilder().authorizationCode(
* "{authorization-code-received-at-redirectURL}")
* .redirectUrl("{redirectUrl-where-authorization-code-is-received}")
* .clientId("{clientId-of-application-being-authenticated")
* .build();
*
*
*
* @see AuthorizationCodeCredential
*/
public class AuthorizationCodeCredentialBuilder extends AadCredentialBuilderBase {
private static final ClientLogger LOGGER = new ClientLogger(AuthorizationCodeCredentialBuilder.class);
private static final String CLASS_NAME = AuthorizationCodeCredentialBuilder.class.getSimpleName();
private String authCode;
private String redirectUrl;
private String clientSecret;
/**
* Constructs an instance of AuthorizationCodeCredentialBuilder.
*/
public AuthorizationCodeCredentialBuilder() {
super();
}
/**
* Sets the authorization code on the builder.
*
* @param authCode the authorization code acquired from user login
* @return the AuthorizationCodeCredentialBuilder itself
*/
public AuthorizationCodeCredentialBuilder authorizationCode(String authCode) {
this.authCode = authCode;
return this;
}
/**
* Sets redirect URL for the OAuth 2.0 login request, which must be
* registered as a valid redirect URL on the application. The authorization code
* will be sent to this URL, so it must be listening on this server and is able
* to complete the {@link AuthorizationCodeCredential} construction from there.
* This is also called Reply URLs in some contexts.
*
* @param redirectUrl the redirect URL to send the authorization code
* @return the AuthorizationCodeCredentialBuilder itself
*/
public AuthorizationCodeCredentialBuilder redirectUrl(String redirectUrl) {
this.redirectUrl = redirectUrl;
return this;
}
/**
* Sets the client secret for the authentication. This is required for Microsoft Entra web apps.
*
* Do not set this for Microsoft Entra native apps.
*
* @param clientSecret the secret value of the Microsoft Entra application.
* @return An updated instance of this builder.
*/
public AuthorizationCodeCredentialBuilder clientSecret(String clientSecret) {
this.clientSecret = clientSecret;
return this;
}
/**
* Creates a new {@link AuthorizationCodeCredential} with the current configurations.
*
* @return a {@link AuthorizationCodeCredential} with the current configurations.
*/
public AuthorizationCodeCredential build() {
ValidationUtil.validate(CLASS_NAME, LOGGER, "clientId", clientId, "authorizationCode", authCode, "redirectUrl",
redirectUrl);
try {
return new AuthorizationCodeCredential(clientId, clientSecret, tenantId, authCode, new URI(redirectUrl),
identityClientOptions);
} catch (URISyntaxException e) {
throw LOGGER.logExceptionAsError(new RuntimeException(e));
}
}
}