パッケージ jakarta.security.auth.message.config

インターフェース ClientAuthConfig

すべてのスーパーインターフェース:
AuthConfig
public interface ClientAuthConfig extends AuthConfig
このインターフェースは、メッセージレイヤーとアプリケーションコンテキスト（たとえば、特定のアプリケーションまたはアプリケーションセットのメッセージングコンテキスト）の ClientAuthContext オブジェクトの構成をカプセル化します。

このインターフェースの実装は、AuthConfigProvider によって返されます。

呼び出し元は、ClientAuthConfig と対話して、レイヤーおよび ClientAuthConfig のアプリケーションコンテキスト内での特定のメッセージ交換の処理に適した ClientAuthContext オブジェクトを取得します。各 ClientAuthContext オブジェクトは、ClientAuthContext にカプセル化された 1 つ以上の ClientAuthModules のインスタンス化、初期化、呼び出しを担当します。

ClientAuthContext を取得した後、呼び出し元はコンテキストを操作して、カプセル化された ClientAuthModules を呼び出し、クライアントリクエストを保護し、サーバーレスポンスを検証します。

関連事項:

  • メソッドの詳細

    • getAuthContext

      ClientAuthContext getAuthContext(StringSE authContextID, SubjectSE clientSubject, MapSE<StringSE,ObjectSE> properties) throws AuthException
      この ClientAuthConfig から ClientAuthContext インスタンスを取得します。

      このメソッドの実装は ClientAuthModules が所定 authContextID に関連付けられたリクエスト / レスポンスを確保し、検証するために使用されるカプセル化 ClientAuthContext インスタンスを返します。

      具体的には、このメソッドは引数 authContextID を使用してこの ClientAuthConfig オブジェクトにアクセスし、返される ClientAuthContext インスタンスにカプセル化される ClientAuthModules を決定します。

      ClientAuthConfig オブジェクトは、返された ClientAuthContext インスタンスによって初期化されたときにカプセル化されたモジュールに渡されるリクエストとレスポンスの MessagePolicy オブジェクトを確立します。呼び出されたときにこれらのポリシーを強制するのはモジュールの責任です。

      パラメーター:
      authContextID - 指定された config のインデックスに使用される文字列識別子、または null。この値は、返される ClientAuthContext の secureRequest メソッドに渡されるすべての MessageInfo オブジェクトの getAuthContextID メソッドによって返される値と同じである必要があります。
      clientSubject - 取得した認証コンテキストによって保護されるサービスリクエストのソースを表すサブジェクト。サブジェクトのプリンシパルとクレデンシャルを使用して、認証コンテキストを選択または取得できます。サブジェクトが null でない場合、追加のプリンシパルまたは資格情報（リクエストのソースに関する）をサブジェクトに追加できます。このパラメーターには NULL 値を渡すことができます。
      properties - モジュールの初期化時にカプセル化されたモジュールに渡されるプロパティを拡張するために呼び出し元が使用できる Map オブジェクト。このパラメーターには null 値を渡すことができます。
      戻り値:
      ClientAuthModules をカプセル化 ClientAuthContext インスタンスは固定とするために使用される検証リクエスト / 所与 authContextID に関連付けられたレスポンス、または null（無モジュールが構成されていないことを示します）。
      例外:
      AuthException - このメソッドが失敗した場合。