TokenProvider クラス

パッケージ:

com.microsoft.azure.servicebus.security

Maven 成果物:

com.microsoft.azure:azure-servicebus:3.6.7

• java.lang.Object
• • com.microsoft.azure.servicebus.security.TokenProvider

public abstract class TokenProvider

この抽象クラスは、トークン プロバイダーのコントラクトを定義します。 すべてのトークン プロバイダーは、このクラスから継承する必要があります。 トークン プロバイダーのインスタンスは、特定の対象ユーザーのセキュリティ トークンを取得するために使用されます。

コンストラクターの概要

コンストラクター	説明
TokenProvider()

メソッドの概要

修飾子と型	メソッドと説明
static TokenProvider	createAzureActiveDirectoryTokenProvider(AzureActiveDirectoryTokenProvider.AuthenticationCallback callback, String authority, Object callbackState) ユーザー定義の認証コールバックを使用してトークンを作成する Azure Active Directory トークン プロバイダーを作成します。
static TokenProvider	createManagedIdentityTokenProvider() マネージド ID トークン プロバイダーを作成します。
static TokenProvider	createSharedAccessSignatureTokenProvider(String sasKeyName, String sasKey) 指定されたキー名とキー値を使用して Shared Access Signature トークン プロバイダーを作成します。
static TokenProvider	createSharedAccessSignatureTokenProvider(String sasToken, Instant sasTokenValidUntil) 既に作成されたトークンを常に返す Shared Access Signature トークン プロバイダーを作成します。
abstract CompletableFuture<SecurityToken>	getSecurityTokenAsync(String audience) 特定の対象ユーザーのセキュリティ トークンを非同期的に取得します。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

TokenProvider

public TokenProvider()

メソッドの詳細

createAzureActiveDirectoryTokenProvider

public static TokenProvider createAzureActiveDirectoryTokenProvider(AzureActiveDirectoryTokenProvider.AuthenticationCallback callback, String authority, Object callbackState)

ユーザー定義の AuthenticationCallback を使用してトークンを作成する Azure Active Directory トークン プロバイダーを作成します。 これはユーティリティ メソッドです。

Parameters:

callback - トークンを発行する機関のターゲット リソースとアドレスを受け取り、ターゲット URL のセキュリティ トークンを提供するカスタム AuthenticationCallback

authority - Azure Active Directory インスタンスの URL

callbackState - AuthenticationCallback に指定できるカスタム パラメーター

Returns:

Azure Active Directory トークン プロバイダーのインスタンス

createManagedIdentityTokenProvider

public static TokenProvider createManagedIdentityTokenProvider()

マネージド ID トークン プロバイダーを作成します。 これはユーティリティ メソッドです。

Returns:

マネージド ID トークン プロバイダーのインスタンス

createSharedAccessSignatureTokenProvider

public static TokenProvider createSharedAccessSignatureTokenProvider(String sasKeyName, String sasKey)

指定されたキー名とキー値を使用して Shared Access Signature トークン プロバイダーを作成します。 返されたトークン プロバイダーは、有効期間が 20 分のトークンを作成します。 これはユーティリティ メソッドです。

Parameters:

sasKeyName - SAS キー名

sasKey - SAS キー値

Returns:

指定されたキー名、キー値を持つ Shared Access Signature トークン プロバイダーのインスタンス。

createSharedAccessSignatureTokenProvider

public static TokenProvider createSharedAccessSignatureTokenProvider(String sasToken, Instant sasTokenValidUntil)

既に作成されたトークンを常に返す Shared Access Signature トークン プロバイダーを作成します。 これはユーティリティ メソッドです。

Parameters:

sasToken - メソッドによって getSecurityTokenAsync(String audience) 返される Shared Access Signature トークンが既に作成されています。

sasTokenValidUntil - トークンの有効期限が切れた瞬間

Returns:

既に作成されたトークンを常に返す Shared Access Signature トークン プロバイダーのインスタンス。

getSecurityTokenAsync

public abstract CompletableFuture getSecurityTokenAsync(String audience)

特定の対象ユーザーのセキュリティ トークンを非同期的に取得します。 このメソッドの実装では、呼び出しごとに新しいトークンを作成するか、キャッシュされたトークンを返すかを選択できます。 ただし、返されるトークンは有効である必要があります。

Parameters:

audience - このセキュリティ トークンを提示するエンティティのパス

Returns:

完了時に を SecurityToken 返す CompletableFuture のインスタンス。