com.microsoft.aad.msal4j

Interface IBroker

public interface IBroker

Used to define the basic set of methods that all Brokers must implement All methods are so they can be referenced by MSAL Java without an implementation, and by default simply throw an exception saying that a broker implementation is missing

Method Summary

Modifier and Type	Method and Description
default IAuthenticationResult	acquireToken(PublicClientApplication application, InteractiveRequestParameters requestParameters) Acquire a token interactively, by prompting users to enter their credentials in some way
default IAuthenticationResult	acquireToken(PublicClientApplication application, SilentParameters requestParameters) Acquire a token silently, i.e.
default IAuthenticationResult	acquireToken(PublicClientApplication application, UserNamePasswordParameters requestParameters) Acquire a token silently, i.e.
default boolean	isAvailable() checks if a IBroker implementation exists
default CompletableFuture	removeAccount(IAccount account)

Method Detail

isAvailable

default boolean isAvailable()

checks if a IBroker implementation exists

acquireToken

default IAuthenticationResult acquireToken(PublicClientApplication application,
                                           SilentParameters requestParameters)

Acquire a token silently, i.e. without direct user interaction This may be accomplished by returning tokens from a token cache, using cached refresh tokens to get new tokens, or via any authentication flow where a user is not prompted to enter credentials

Parameters:

requestParameters - MsalRequest object which contains everything needed for the broker implementation to make a request

Returns:

IBroker implementations will return an AuthenticationResult object

acquireToken

default IAuthenticationResult acquireToken(PublicClientApplication application,
                                           InteractiveRequestParameters requestParameters)

Acquire a token interactively, by prompting users to enter their credentials in some way

Parameters:

requestParameters - MsalRequest object which contains everything needed for the broker implementation to make a request

Returns:

IBroker implementations will return an AuthenticationResult object

acquireToken

default IAuthenticationResult acquireToken(PublicClientApplication application,
                                           UserNamePasswordParameters requestParameters)

Acquire a token silently, i.e. without direct user interaction, using username/password authentication

Parameters:

requestParameters - MsalRequest object which contains everything needed for the broker implementation to make a request

Returns:

IBroker implementations will return an AuthenticationResult object

removeAccount

default CompletableFuture removeAccount(IAccount account)