// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.microsoft.aad.msal4j;
import java.util.Map;
import java.util.Set;
import static com.microsoft.aad.msal4j.ParameterValidationUtils.validateNotBlank;
import static com.microsoft.aad.msal4j.ParameterValidationUtils.validateNotNull;
/**
* Object containing parameters for Integrated Windows Authentication. Can be used as parameter to
* {@link PublicClientApplication#acquireToken(IntegratedWindowsAuthenticationParameters)}`
*
* For more details, see https://aka.ms/msal4j-iwa
*/
public class IntegratedWindowsAuthenticationParameters implements IAcquireTokenParameters {
private Set scopes;
private String username;
private ClaimsRequest claims;
private Map extraHttpHeaders;
private Map extraQueryParameters;
private String tenant;
private IntegratedWindowsAuthenticationParameters(Set scopes, String username, ClaimsRequest claims, Map extraHttpHeaders, Map extraQueryParameters, String tenant) {
this.scopes = scopes;
this.username = username;
this.claims = claims;
this.extraHttpHeaders = extraHttpHeaders;
this.extraQueryParameters = extraQueryParameters;
this.tenant = tenant;
}
private static IntegratedWindowsAuthenticationParametersBuilder builder() {
return new IntegratedWindowsAuthenticationParametersBuilder();
}
/**
* Builder for {@link IntegratedWindowsAuthenticationParameters}
*
* @param scopes scopes application is requesting access to
* @param username identifier of user account for which to acquire token for. Usually in UPN format,
* e.g. john.doe@contoso.com.
* @return builder that can be used to construct IntegratedWindowsAuthenticationParameters
*/
public static IntegratedWindowsAuthenticationParametersBuilder builder(Set scopes, String username) {
validateNotNull("scopes", scopes);
validateNotBlank("username", username);
return builder()
.scopes(scopes)
.username(username);
}
public Set scopes() {
return this.scopes;
}
public String username() {
return this.username;
}
public ClaimsRequest claims() {
return this.claims;
}
public Map extraHttpHeaders() {
return this.extraHttpHeaders;
}
public Map extraQueryParameters() {
return this.extraQueryParameters;
}
public String tenant() {
return this.tenant;
}
public static class IntegratedWindowsAuthenticationParametersBuilder {
private Set scopes;
private String username;
private ClaimsRequest claims;
private Map extraHttpHeaders;
private Map extraQueryParameters;
private String tenant;
IntegratedWindowsAuthenticationParametersBuilder() {
}
/**
* Scopes that the application is requesting access to
*/
public IntegratedWindowsAuthenticationParametersBuilder scopes(Set scopes) {
validateNotNull("scopes", scopes);
this.scopes = scopes;
return this;
}
/**
* Identifier of user account for which to acquire tokens for
*/
public IntegratedWindowsAuthenticationParametersBuilder username(String username) {
validateNotNull("username", username);
this.username = username;
return this;
}
/**
* Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
*/
public IntegratedWindowsAuthenticationParametersBuilder claims(ClaimsRequest claims) {
this.claims = claims;
return this;
}
/**
* Adds additional headers to the token request
*/
public IntegratedWindowsAuthenticationParametersBuilder extraHttpHeaders(Map extraHttpHeaders) {
this.extraHttpHeaders = extraHttpHeaders;
return this;
}
/**
* Adds additional parameters to the token request
*/
public IntegratedWindowsAuthenticationParametersBuilder extraQueryParameters(Map extraQueryParameters) {
this.extraQueryParameters = extraQueryParameters;
return this;
}
/**
* Overrides the tenant value in the authority URL for this request
*/
public IntegratedWindowsAuthenticationParametersBuilder tenant(String tenant) {
this.tenant = tenant;
return this;
}
public IntegratedWindowsAuthenticationParameters build() {
return new IntegratedWindowsAuthenticationParameters(this.scopes, this.username, this.claims, this.extraHttpHeaders, this.extraQueryParameters, this.tenant);
}
public String toString() {
return "IntegratedWindowsAuthenticationParameters.IntegratedWindowsAuthenticationParametersBuilder(scopes=" + this.scopes + ", username=" + this.username + ", claims=" + this.claims + ", extraHttpHeaders=" + this.extraHttpHeaders + ", extraQueryParameters=" + this.extraQueryParameters + ", tenant=" + this.tenant + ")";
}
}
}