com.microsoft.aad.msal4jbrokers

Class Broker

java.lang.Object

com.microsoft.aad.msal4jbrokers.Broker

All Implemented Interfaces:

IBroker

public class Broker
extends Object
implements IBroker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Broker.Builder

Method Summary

Modifier and Type	Method and Description
CompletableFuture<IAuthenticationResult>	acquireToken(PublicClientApplication application, InteractiveRequestParameters parameters)
CompletableFuture<IAuthenticationResult>	acquireToken(PublicClientApplication application, SilentParameters parameters)
CompletableFuture<IAuthenticationResult>	acquireToken(PublicClientApplication application, UserNamePasswordParameters parameters) Deprecated.
void	enableBrokerLogging(boolean enableLogging) Toggles whether or not detailed MSALRuntime logs will appear in MSAL Java's normal logging framework.
void	enableBrokerPIILogging(boolean enablePII) If enabled, Personal Identifiable Information (PII) can appear in logs and error messages produced by MSALRuntime.
boolean	isBrokerAvailable() Calls MSALRuntime's startup API.
void	removeAccount(PublicClientApplication application, IAccount msalJavaAccount)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.aad.msal4j.IBroker

parseBrokerAuthResult

Method Detail

acquireToken

public CompletableFuture<IAuthenticationResult> acquireToken(PublicClientApplication application,
                                                             SilentParameters parameters)

Specified by:

acquireToken in interface IBroker

acquireToken

public CompletableFuture<IAuthenticationResult> acquireToken(PublicClientApplication application,
                                                             InteractiveRequestParameters parameters)

Specified by:

acquireToken in interface IBroker

acquireToken

@Deprecated
public CompletableFuture<IAuthenticationResult> acquireToken(PublicClientApplication application,
                                                                          UserNamePasswordParameters parameters)

Deprecated.

Specified by:

acquireToken in interface IBroker

removeAccount

public void removeAccount(PublicClientApplication application,
                          IAccount msalJavaAccount)

Specified by:

removeAccount in interface IBroker

isBrokerAvailable

public boolean isBrokerAvailable()

Calls MSALRuntime's startup API. If MSALRuntime started successfully, we can assume that the broker is available for use. If an exception is thrown when trying to start MSALRuntime, we assume that we cannot use the broker and will not make any more attempts to do so.

Specified by:

isBrokerAvailable in interface IBroker

Returns:

boolean representing whether or not MSALRuntime started successfully

enableBrokerLogging

public void enableBrokerLogging(boolean enableLogging)

Toggles whether or not detailed MSALRuntime logs will appear in MSAL Java's normal logging framework. If enabled, you will see logs directly from MSALRuntime, containing verbose information relating to telemetry, API calls,successful/failed requests, and more. These logs will appear alongside MSAL Java's logs (with a message indicating they came from MSALRuntime), and will follow the same log level as MSAL Java's logs (info/debug/error/etc.). If disabled (default), MSAL Java will still produce some logs related to MSALRuntime, particularly in error messages, but will be much less verbose.

Parameters:

enableLogging - true to enable MSALRuntime logs, false to disable it

enableBrokerPIILogging

public void enableBrokerPIILogging(boolean enablePII)

If enabled, Personal Identifiable Information (PII) can appear in logs and error messages produced by MSALRuntime. If disabled (default), PII will not be shown, and you will simply see "(PII)" or similar notes in places where PII data would have appeared.

Parameters:

enablePII - true to allow PII to appear in logs and error messages, false to disallow it