パッケージ jakarta.security.enterprise.authentication.mechanism.http

クラス AuthenticationParameters

java.lang.ObjectSE
jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters
public class AuthenticationParameters extends ObjectSE
認証リクエストとともに提供されるパラメーター。

  • コンストラクターの概要

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

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    AuthenticationParameters
    credential(Credential credential)
    これらの AuthenticationParameters が渡される認証呼び出しに応答する認証メカニズムによって使用される資格情報を設定します。
    Credential
    getCredential()
    このインスタンスでパラメーターとして設定された資格情報。
    boolean
    isNewAuthentication()
    新しい認証ダイアログが必要かどうか。
    boolean
    isRememberMe()
    「私を覚えている」を使うべきかどうか。
    AuthenticationParameters
    newAuthentication(boolean newAuthentication)
    これらの AuthenticationParameters が渡される認証呼び出しに応答する認証メカニズムに、潜在的に存在するダイアログを続行するのではなく、明示的な新しい認証ダイアログが必要であることを通知します。
    AuthenticationParameters
    rememberMe(boolean rememberMe)
    この認証メカニズムへの呼び出しに "remember me" を適用する必要があることを示すシグナル、"remember me" 機能が認証呼び出しに応答する認証メカニズム用に構成されている場合。
    void
    setCredential(Credential credential)
    このインスタンスの資格情報をパラメーターとして設定します。
    void
    setNewAuthentication(boolean newAuthentication)
    新しい認証ダイアログが必要かどうかを設定します。
    void
    setRememberMe(boolean rememberMe)
    "remember me" を使用するかどうかを設定します。
    static AuthenticationParameters
    withParams()
    パラメーターの Fluent/Builder スタイルの作成に役立つ AuthenticationParameters の新しいインスタンスを作成します。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • コンストラクターの詳細

    • AuthenticationParameters

      public AuthenticationParameters()

  • メソッドの詳細

    • withParams

      public static AuthenticationParameters withParams()
      パラメーターの Fluent/Builder スタイルの作成に役立つ AuthenticationParameters の新しいインスタンスを作成します。
      戻り値:
      新しい AuthenticationParameters インスタンス。

    • credential

      public AuthenticationParameters credential(Credential credential)
      これらの AuthenticationParameters が渡される認証呼び出しに応答する認証メカニズムによって使用される資格情報を設定します。
      パラメーター:
      credential - 認証メカニズムによって使用される資格情報
      戻り値:
      この呼び出しが行われた AuthenticationParameters のインスタンス。流れるようなビルダースタイルのパラメーターの作成に役立ちます。

    • newAuthentication

      public AuthenticationParameters newAuthentication(boolean newAuthentication)
      これらの AuthenticationParameters が渡される認証呼び出しに応答する認証メカニズムに、潜在的に存在するダイアログを続行するのではなく、明示的な新しい認証ダイアログが必要であることを通知します。
      パラメーター:
      newAuthentication - 新しい認証ダイアログを開始する必要があるかどうか。
      戻り値:
      この呼び出しが行われた AuthenticationParameters のインスタンス。流れるようなビルダースタイルのパラメーターの作成に役立ちます。

    • rememberMe

      public AuthenticationParameters rememberMe(boolean rememberMe)
      この認証メカニズムへの呼び出しに "remember me" を適用する必要があることを示すシグナル、"remember me" 機能が認証呼び出しに応答する認証メカニズム用に構成されている場合。

      "remember me" が構成されていない場合、このパラメーターは通知なく無視されます。

      パラメーター:
      rememberMe - true の場合、認証が成功し、そのように構成されている場合、「記憶」機能が使用されます。
      戻り値:
      この呼び出しが行われた AuthenticationParameters のインスタンス。流れるようなビルダースタイルのパラメーターの作成に役立ちます。
      関連事項:

    • getCredential

      public Credential getCredential()
      このインスタンスでパラメーターとして設定された資格情報。
      戻り値:
      このインスタンスのパラメーターとして設定された資格
      関連事項:

    • setCredential

      public void setCredential(Credential credential)
      このインスタンスの資格情報をパラメーターとして設定します。
      パラメーター:
      credential - このインスタンスでパラメーターとして設定される資格情報。
      関連事項:

    • isNewAuthentication

      public boolean isNewAuthentication()
      新しい認証ダイアログが必要かどうか。
      戻り値:
      新しい認証ダイアログが必要かどうか。
      関連事項:

    • setNewAuthentication

      public void setNewAuthentication(boolean newAuthentication)
      新しい認証ダイアログが必要かどうかを設定します。
      パラメーター:
      newAuthentication - 新しい認証ダイアログが必要かどうか
      関連事項:

    • isRememberMe

      public boolean isRememberMe()
      「私を覚えている」を使うべきかどうか。
      戻り値:
      "remember me" を使用するかどうか。
      関連事項:

    • setRememberMe

      public void setRememberMe(boolean rememberMe)
      "remember me" を使用するかどうかを設定します。
      パラメーター:
      rememberMe - "remember me" を使用するかどうか。
      関連事項: