com.microsoft.aad.msal4j

Class AbstractClientApplicationBase

java.lang.Object

com.microsoft.aad.msal4j.AbstractApplicationBase

com.microsoft.aad.msal4j.AbstractClientApplicationBase

Direct Known Subclasses:

ConfidentialClientApplication, PublicClientApplication

public abstract class AbstractClientApplicationBase
extends AbstractApplicationBase

Abstract class containing common methods and properties to both PublicClientApplication and ConfidentialClientApplication.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractClientApplicationBase.Builder<T extends AbstractClientApplicationBase.Builder<T>>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	azureRegion
static String	DEFAULT_AUTHORITY

Fields inherited from class com.microsoft.aad.msal4j.AbstractApplicationBase

authenticationAuthority, log, tokenCache

Method Summary

Modifier and Type	Method and Description
com.microsoft.aad.msal4j.AadInstanceDiscoveryResponse	aadAadInstanceDiscoveryResponse()
CompletableFuture<IAuthenticationResult>	acquireToken(AuthorizationCodeParameters parameters) Acquires security token from the authority using an authorization code previously received.
CompletableFuture<IAuthenticationResult>	acquireToken(RefreshTokenParameters parameters) Acquires a security token from the authority using a refresh token previously received.
CompletableFuture<IAuthenticationResult>	acquireTokenSilently(SilentParameters parameters) Returns tokens from cache if present and not expired or acquires new tokens from the authority by using the refresh token present in cache.
String	applicationName()
String	applicationVersion()
String	authority() Gets the authority URL for this application.
boolean	autoDetectRegion()
String	azureRegion()
String	clientCapabilities()
String	clientId() Gets the client ID (application ID) for this application.
String	correlationId() Gets the correlation ID used for tracing requests through the authentication system.
CompletableFuture<Set<IAccount>>	getAccounts() Returns accounts in the cache
URL	getAuthorizationRequestUrl(AuthorizationRequestUrlParameters parameters) Computes the URL of the authorization request letting the user sign-in and consent to the application.
IHttpClient	httpClient() Gets the HTTP client used by the application for all HTTP requests.
boolean	instanceDiscovery()
boolean	logPii() Gets whether personally identifiable information (PII) is included in log messages.
Proxy	proxy() Gets the proxy configuration used by the application for network communication.
CompletableFuture<Void>	removeAccount(IAccount account) Removes IAccount from the cache
SSLSocketFactory	sslSocketFactory() Gets the SSL socket factory used by the application for secure network communication.
TokenCache	tokenCache()
boolean	validateAuthority() Gets whether the authority URL should be validated against a list of known authorities.

Methods inherited from class com.microsoft.aad.msal4j.AbstractApplicationBase

connectTimeoutForDefaultHttpClient, correlationId, httpClient, logPii, proxy, readTimeoutForDefaultHttpClient, sslSocketFactory

Methods inherited from class java.lang.Object

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

Field Detail

azureRegion

protected String azureRegion

DEFAULT_AUTHORITY

public static final String DEFAULT_AUTHORITY

See Also:

Constant Field Values

Method Detail

tokenCache

public TokenCache tokenCache()

acquireToken

public CompletableFuture<IAuthenticationResult> acquireToken(AuthorizationCodeParameters parameters)

Acquires security token from the authority using an authorization code previously received.

This is typically used as the second step in an authorization code flow, after the user has authenticated and provided consent at the authorization endpoint, resulting in an authorization code.

Parameters:

parameters - AuthorizationCodeParameters containing the authorization code and other information required to exchange the code for tokens

Returns:

A CompletableFuture object representing the IAuthenticationResult of the call, which contains the requested tokens and account information

acquireToken

public CompletableFuture<IAuthenticationResult> acquireToken(RefreshTokenParameters parameters)

Acquires a security token from the authority using a refresh token previously received. Can be used in migration to MSAL from ADAL, and in various integration scenarios where you have a refresh token available.

Parameters:

parameters - RefreshTokenParameters

Returns:

A CompletableFuture object representing the IAuthenticationResult of the call.

acquireTokenSilently

public CompletableFuture<IAuthenticationResult> acquireTokenSilently(SilentParameters parameters)
                                                              throws MalformedURLException

Returns tokens from cache if present and not expired or acquires new tokens from the authority by using the refresh token present in cache.

Parameters:

parameters - instance of SilentParameters

Returns:

A CompletableFuture object representing the IAuthenticationResult of the call.

Throws:

MalformedURLException - if authorityUrl from parameters is malformed URL

getAccounts

public CompletableFuture<Set<IAccount>> getAccounts()

Returns accounts in the cache

Returns:

set of unique accounts from cache which can be used for silent acquire token call

removeAccount

public CompletableFuture<Void> removeAccount(IAccount account)

Removes IAccount from the cache

Parameters:

account - instance of Account to be removed from cache

Returns:

CompletableFuture object representing account removal task.

getAuthorizationRequestUrl

public URL getAuthorizationRequestUrl(AuthorizationRequestUrlParameters parameters)

Computes the URL of the authorization request letting the user sign-in and consent to the application. The URL target the /authorize endpoint of the authority configured in the application object.

Once the user successfully authenticates, the response should contain an authorization code, which can then be passed in to acquireToken(AuthorizationCodeParameters) to be exchanged for a token.

Parameters:

parameters - AuthorizationRequestUrlParameters containing the details needed to create the authorization URL, such as scopes, response type, and redirect URI

Returns:

URL of the authorization endpoint where the user can sign-in and consent to the application

clientId

public String clientId()

Gets the client ID (application ID) for this application.

Returns:

Client ID (Application ID) of the application as registered in the application registration portal (portal.azure.com) and as passed in the constructor of the application

authority

public String authority()

Gets the authority URL for this application.

Returns:

URL of the authority, or security token service (STS) from which MSAL will acquire security tokens. Default value is IApplicationBase.DEFAULT_AUTHORITY

validateAuthority

public boolean validateAuthority()

Gets whether the authority URL should be validated against a list of known authorities.

Returns:

A boolean value which determines whether the authority needs to be verified against a list of known authorities. When true, MSAL will validate the authority against a list of well-known authorities. Set to false only for development/testing with custom authority URLs.

applicationName

public String applicationName()

applicationVersion

public String applicationVersion()

aadAadInstanceDiscoveryResponse

public com.microsoft.aad.msal4j.AadInstanceDiscoveryResponse aadAadInstanceDiscoveryResponse()

clientCapabilities

public String clientCapabilities()

autoDetectRegion

public boolean autoDetectRegion()

azureRegion

public String azureRegion()

instanceDiscovery

public boolean instanceDiscovery()

logPii

public boolean logPii()

Gets whether personally identifiable information (PII) is included in log messages.

Returns:

A boolean value which determines whether PII (personally identifiable information) will be included in log messages. When true, PII will be logged; when false, PII will be masked or omitted from logs.

correlationId

public String correlationId()

Gets the correlation ID used for tracing requests through the authentication system.

Returns:

Correlation ID which is used for diagnostics purposes and is attached to token service requests. The default value is a random UUID.

httpClient

public IHttpClient httpClient()

Gets the HTTP client used by the application for all HTTP requests.

Returns:

Instance of IHttpClient used by the application for network communication with the Microsoft identity platform.

proxy

public Proxy proxy()

Gets the proxy configuration used by the application for network communication.

Returns:

Proxy used by the application for all network communication. Returns null if no proxy is configured.

sslSocketFactory

public SSLSocketFactory sslSocketFactory()

Gets the SSL socket factory used by the application for secure network communication.

Returns:

SSLSocketFactory used by the application for all secure network communication. Returns null if no custom SSL socket factory is configured.