IBroker 接口

public interface IBroker

定义身份验证代理所需的核心功能的接口。

身份验证代理提供了一种集中方式,用于处理设备或平台上多个应用程序的身份验证。 它们可以在应用程序之间提供单一登录(SSO)、一致的身份验证体验以及利用平台安全功能等优势。

所有方法都标记为默认值,以便 MSAL Java在没有实现的情况下引用它们,并且大多数方法只会引发异常(如果未由 IBroker 实现重写)。

方法摘要

修饰符和类型 方法和描述
default java.util.concurrent.CompletableFuture<IAuthenticationResult> acquireToken(PublicClientApplication application, InteractiveRequestParameters parameters)

通过提示用户输入凭据以交互方式获取令牌。

default java.util.concurrent.CompletableFuture<IAuthenticationResult> acquireToken(PublicClientApplication application, SilentParameters requestParameters)

在没有用户交互的情况下以无提示方式获取令牌。

default java.util.concurrent.CompletableFuture<IAuthenticationResult> acquireToken(PublicClientApplication application, UserNamePasswordParameters parameters)

使用用户名和密码身份验证以无提示方式获取令牌。

default boolean isBrokerAvailable()

检查代理是否可用,并准备好在此计算机上使用。

default IAuthenticationResult parseBrokerAuthResult(String authority, String idToken, String accessToken, String accountId, String clientInfo, long accessTokenExpirationTime, boolean isPopAuthorization)

MSAL Java的身份验证结果要求代理实现无法访问的多个包专用类,因此可以使用此帮助程序方法从 MSAL Java 包中创建身份验证结果

default void removeAccount(PublicClientApplication application, IAccount account)

从代理的令牌缓存中删除帐户。

方法详细信息

acquireToken

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

通过提示用户输入凭据以交互方式获取令牌。

此方法提供从用户请求凭据并处理交互式身份验证流的用户界面。

参数:

application - 请求令牌的公共客户端应用程序
parameters - 交互式令牌请求的参数

返回:

包含令牌和帐户信息的身份验证结果的 CompletableFuture

acquireToken

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

在没有用户交互的情况下以无提示方式获取令牌。

这可以通过从令牌缓存中返回令牌、使用缓存的刷新令牌获取新令牌或通过任何未提示用户输入凭据的身份验证流来实现。

参数:

application - 请求令牌的公共客户端应用程序
requestParameters - 无提示令牌请求的参数

返回:

包含令牌和帐户信息的身份验证结果的 CompletableFuture

acquireToken

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

使用用户名和密码身份验证以无提示方式获取令牌。

此方法允许资源所有者密码凭据 (ROPC) 流经代理。 请注意,不建议将此流用于生产应用程序,因为它需要直接处理用户凭据。

参数:

application - 请求令牌的公共客户端应用程序
parameters - 包含用户名、密码和其他请求详细信息的参数

返回:

包含令牌和帐户信息的身份验证结果的 CompletableFuture

isBrokerAvailable

public default boolean isBrokerAvailable()

检查代理是否可用,并准备好在此计算机上使用。

应用程序应先调用此方法,然后再尝试使用代理特定的功能来确定中转站是否已安装和访问。

返回:

如果代理可用于身份验证,则为 true;否则为 false

parseBrokerAuthResult

public default IAuthenticationResult parseBrokerAuthResult(String authority, String idToken, String accessToken, String accountId, String clientInfo, long accessTokenExpirationTime, boolean isPopAuthorization)

MSAL Java的 AuthenticationResult 要求代理实现无法访问的多个包专用类,因此可以使用此帮助程序方法从 MSAL Java 包中创建 AuthenticationResults

参数:

authority
idToken
accessToken
accountId
clientInfo
accessTokenExpirationTime
isPopAuthorization

removeAccount

public default void removeAccount(PublicClientApplication application, IAccount account)

从代理的令牌缓存中删除帐户。

此方法允许应用程序注销用户并从中转站缓存中删除其令牌。

参数:

application - 请求删除帐户的公共客户端应用程序
account - 要从令牌缓存中删除的帐户

引发:

MsalClientException - 如果没有中转站实现可用

适用于