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

インターフェース ServerAuthConfig

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

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

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

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

    関連事項:
    AuthConfigProvider

    • メソッドの詳細

      • getAuthContext

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

        このメソッドの実装は ServerAuthModules が所定 authContextID に関連付けられた検証リクエストと安全なレスポンスに使用されるカプセル化 ServerAuthContext インスタンスを返します。

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

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

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