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

インターフェース ClientAuthModule

  • すべてのスーパーインターフェース:
    ClientAuth
    public interface ClientAuthModule
extends ClientAuth
    ClientAuthModule はリクエストメッセージを保護し、受信したレスポンスメッセージを検証します。

    モジュールの実装では、さまざまなクライアントとしてさまざまなリクエストを保護するために使用できると想定する必要があります。モジュールは、複数の呼び出し元が同時に使用できることも想定する必要があります。必要に応じて状態を適切に保存および復元するのは、モジュール実装の責任です。そうする必要のないモジュールは、完全にステートレスのままになる場合があります。

    インターフェースのすべての実装は、パブリックゼロ引数コンストラクターを提供する必要があります。

    関連事項:
    ClientAuthContext

    • メソッドの詳細

      • initialize

        void initialize​(MessagePolicy requestPolicy,
                MessagePolicy responsePolicy,
                CallbackHandlerSE handler,
                MapSE<StringSE,​ObjectSE> options)
         throws AuthException
        このモジュールを、適用するリクエストおよびレスポンスメッセージポリシー、CallbackHandler、モジュール固有の構成プロパティを使用して初期化します。

        リクエストポリシーとレスポンスポリシーの両方を null にすることはできません。

        パラメーター:
        requestPolicy - このモジュールが適用する必要のあるリクエストポリシー、または null。
        responsePolicy - このモジュールが適用する必要のあるレスポンスポリシー、または null。
        handler - 情報をリクエストするために使用される CallbackHandler。
        options - モジュール固有の構成プロパティのマップ。
        例外:
        AuthException - オプション引数にモジュールでサポートされていない要素が含まれている場合を含め、モジュールの初期化が失敗した場合。

      • getSupportedMessageTypes

        ClassSE<?>[] getSupportedMessageTypes()
        モジュールでサポートされているメッセージ型を表す 1 つ以上の Class オブジェクトを取得します。
        戻り値:
        各要素がモジュールでサポートされるメッセージ型を定義する Class オブジェクトの配列。モジュールは、少なくとも 1 つの要素を含む配列を返す必要があります。空の配列は、モジュールが任意のメッセージ型をサポートしようとすることを示します。このメソッドが null を返すことはありません。