com.microsoft.aad.msal4j

Interface IClientApplicationBase

All Known Subinterfaces:

IConfidentialClientApplication, IPublicClientApplication

All Known Implementing Classes:

ConfidentialClientApplication, PublicClientApplication

public interface IClientApplicationBase

Interface representing an application for which tokens can be acquired.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_AUTHORITY

Method Summary

Modifier and Type	Method and Description
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	authority()
String	clientId()
String	correlationId()
CompletableFuture<Set<IAccount>>	getAccounts() Returns accounts in the cache
boolean	logPii()
Proxy	proxy()
CompletableFuture	removeAccount(IAccount account) Removes IAccount from the cache
SSLSocketFactory	sslSocketFactory()
Consumer<List<HashMap<String,String>>>	telemetryConsumer()
ITokenCache	tokenCache()
boolean	validateAuthority()

Field Detail

DEFAULT_AUTHORITY

static final String DEFAULT_AUTHORITY

See Also:

Constant Field Values

Method Detail

clientId

String clientId()

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

String authority()

Returns:

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

validateAuthority

boolean validateAuthority()

Returns:

a boolean value which determines whether the authority needs to be verified against a list of known authorities.

correlationId

String correlationId()

Returns:

Correlation Id which is used for diagnostics purposes, is attached to token service requests Default value is random UUID

logPii

boolean logPii()

Returns:

a boolean value which determines whether Pii (personally identifiable information) will be logged in

proxy

Proxy proxy()

Returns:

proxy used by the application for all network communication.

sslSocketFactory

SSLSocketFactory sslSocketFactory()

Returns:

SSLSocketFactory used by the application for all network communication.

tokenCache

ITokenCache tokenCache()

Returns:

Cache holding access tokens, refresh tokens, id tokens. It is maintained and used silently if needed when calling acquireTokenSilently(SilentParameters)

telemetryConsumer

Consumer<List<HashMap<String,String>>> telemetryConsumer()

Returns:

Telemetry consumer that will receive telemetry events emitted by the library.

acquireToken

CompletableFuture<IAuthenticationResult> acquireToken(AuthorizationCodeParameters parameters)

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

Parameters:

parameters - AuthorizationCodeParameters

Returns:

A CompletableFuture object representing the IAuthenticationResult of the call.

acquireToken

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

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

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

CompletableFuture 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.