com.microsoft.azure.javamsalruntime

Class MsalRuntimeInterop

java.lang.Object

com.microsoft.azure.javamsalruntime.MsalRuntimeInterop

public class MsalRuntimeInterop
extends Object

A set of APIs intended to map more-or-less directly MSALRuntime's APIs, particularly those related to signing in/signing out users, acquiring tokens, and getting account information All of MsalRuntimeInterop's APIs are non-static, therefore an MsalRuntimeInterop instance must be created before any calls to MSALRuntime are made This class has a static block that will be called when the first MSALRuntimeInterop instance is created, ensuring that any required initialization steps are performed before the first call to any MSALRuntime API

Field Summary

Fields

Modifier and Type	Field and Description
static com.microsoft.azure.javamsalruntime.ErrorHelper	ERROR_HELPER
static MsalRuntimeLibrary	MSALRUNTIME_LIBRARY

Constructor Summary

Constructors

Constructor and Description
MsalRuntimeInterop()

Method Summary

Modifier and Type	Method and Description
MsalRuntimeFuture	acquireTokenInteractively(long windowHandle, AuthParameters authParameters, String correlationId, Account account) Calls MSALRuntime's AcquireTokenInteractively API to retrieve tokens for a given account, by showing a UI to the user
MsalRuntimeFuture	acquireTokenSilently(AuthParameters authParameters, String correlationId, Account account) Calls MSALRuntime's AcquireTokenSilently API to retrieve tokens for a given account, without showing a UI to the user
static void	enableLogging(boolean enableLogging) Sets up the necessary callbacks and handles to integrate MSALRuntime logs into MSAL Java's logging framework, allowing detailed logs from MSALRuntime's native code to appear in javamsalruntime's logs By default, detailed logs from MSALRuntime will not be shown, though some MSALRuntime error messages may appear as part of a thrown exception
static void	enableLoggingPii(boolean enablePIILogging) Allows PII data to appear in MSALRuntime error messages and logs By default, PII logging is disabled
MsalRuntimeFuture	readAccountById(String accountId, String correlationId) Retrieves any cached account information for a given account ID
static void	shutdownMsalRuntime() Calls MSALRuntime's shutdown API
MsalRuntimeFuture	signIn(long windowHandle, AuthParameters authParameters, String correlationId, String loginHint) Calls MSALRuntime's SignIn API, which will attempt a silent sign in and fall back to interactive if needed
MsalRuntimeFuture	signInInteractively(long windowHandle, AuthParameters authParameters, String correlationId, String loginHint) Calls MSALRuntime's SignInInteractively API to attempt a sign in by showing a UI to the user
MsalRuntimeFuture	signInSilently(AuthParameters authParameters, String correlationId) Calls MSALRuntime's SignInSilently API to attempt a sign in without showing a UI to the user
MsalRuntimeFuture	signOutSilently(String clientId, String correlationId, Account account) Calls MSALRuntime's SignOut API, which will delete cached tokens for a given account and require this account to perform a new sign in
void	startupMsalRuntime() Calls MSALRuntime's startup API

Methods inherited from class java.lang.Object

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

Field Detail

MSALRUNTIME_LIBRARY

public static final MsalRuntimeLibrary MSALRUNTIME_LIBRARY

ERROR_HELPER

public static final com.microsoft.azure.javamsalruntime.ErrorHelper ERROR_HELPER

Constructor Detail

MsalRuntimeInterop

public MsalRuntimeInterop()

Method Detail

startupMsalRuntime

public void startupMsalRuntime()

Calls MSALRuntime's startup API

shutdownMsalRuntime

public static void shutdownMsalRuntime()

Calls MSALRuntime's shutdown API

Also completes any remaining futures, and performs any necessary cleanup steps to avoid memory leaks

readAccountById

public MsalRuntimeFuture readAccountById(String accountId,
                                         String correlationId)

Retrieves any cached account information for a given account ID

Parameters:

accountId - the ID of the account we will retrieve data for

correlationId - unique ID used to identify a certain request throughout various telemetry and logs

Returns:

an AsyncHandler instance, which can be treated as a CompletableFuture

signIn

public MsalRuntimeFuture signIn(long windowHandle,
                                AuthParameters authParameters,
                                String correlationId,
                                String loginHint)

Calls MSALRuntime's SignIn API, which will attempt a silent sign in and fall back to interactive if needed

This API essentially combines the behavior signInSilently and signInInteractively

Parameters:

windowHandle - the parent window handle that will be used to coordinate UI elements shown to the user

authParameters - a number of parameters to be used in this request

correlationId - unique ID used to identify a certain request throughout various telemetry and logs

loginHint - a login hint (such as a username) that may be shown to the user

Returns:

an AsyncHandler instance, which can be treated as a CompletableFuture

signInSilently

public MsalRuntimeFuture signInSilently(AuthParameters authParameters,
                                        String correlationId)

Calls MSALRuntime's SignInSilently API to attempt a sign in without showing a UI to the user

Parameters:

authParameters - a number of parameters to be used in this request

correlationId - unique ID used to identify a certain request throughout various telemetry and logs

Returns:

an AsyncHandler instance, which can be treated as a CompletableFuture

signInInteractively

public MsalRuntimeFuture signInInteractively(long windowHandle,
                                             AuthParameters authParameters,
                                             String correlationId,
                                             String loginHint)

Calls MSALRuntime's SignInInteractively API to attempt a sign in by showing a UI to the user

Parameters:

windowHandle - the parent window handle that will be used to coordinate UI elements shown to the user

authParameters - a number of parameters to be used in this request

correlationId - unique ID used to identify a certain request throughout various telemetry and logs

loginHint - a login hint (such as a username) that may be shown to the user

Returns:

an AsyncHandler instance, which can be treated as a CompletableFuture

acquireTokenSilently

public MsalRuntimeFuture acquireTokenSilently(AuthParameters authParameters,
                                              String correlationId,
                                              Account account)

Calls MSALRuntime's AcquireTokenSilently API to retrieve tokens for a given account, without showing a UI to the user

Parameters:

authParameters - a number of parameters to be used in this request

correlationId - unique ID used to identify a certain request throughout various telemetry and logs

account - a ReadAccountResult instance, which must already be populated with a ReadAccountResultHandle

Returns:

an AsyncHandler instance, which can be treated as a CompletableFuture

acquireTokenInteractively

public MsalRuntimeFuture acquireTokenInteractively(long windowHandle,
                                                   AuthParameters authParameters,
                                                   String correlationId,
                                                   Account account)

Calls MSALRuntime's AcquireTokenInteractively API to retrieve tokens for a given account, by showing a UI to the user

Parameters:

windowHandle - the parent window handle that will be used to coordinate UI elements shown to the user

authParameters - a number of parameters to be used in this request

account - a ReadAccountResult instance, which must already be populated with a ReadAccountResultHandle

correlationId - unique ID used to identify a certain request throughout various telemetry and logs

Returns:

an AsyncHandler instance, which can be treated as a CompletableFuture

signOutSilently

public MsalRuntimeFuture signOutSilently(String clientId,
                                         String correlationId,
                                         Account account)

Calls MSALRuntime's SignOut API, which will delete cached tokens for a given account and require this account to perform a new sign in

Parameters:

clientId - client ID used in the call that created the account information

correlationId - unique ID used to identify a certain request throughout various telemetry and logs

account - an Account object, which must be populated with a valid handle

Returns:

an AsyncHandler instance, which can be treated as a CompletableFuture

enableLogging

public static void enableLogging(boolean enableLogging)

Sets up the necessary callbacks and handles to integrate MSALRuntime logs into MSAL Java's logging framework, allowing detailed logs from MSALRuntime's native code to appear in javamsalruntime's logs By default, detailed logs from MSALRuntime will not be shown, though some MSALRuntime error messages may appear as part of a thrown exception

Parameters:

enableLogging - true enables MSALRuntime logging, false disables it

enableLoggingPii

public static void enableLoggingPii(boolean enablePIILogging)

Allows PII data to appear in MSALRuntime error messages and logs By default, PII logging is disabled

Parameters:

enablePIILogging - true enables PII logging, false disables it