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

インターフェース HttpMessageContext

  • すべての既知の実装クラス:
    HttpMessageContextWrapper
    public interface HttpMessageContext
    HttpMessageContext には、リクエストごとの状態情報がすべて含まれ、クライアントリクエスト、サーバーレスポンス、認証コールバック用のコンテナーハンドラー、呼び出し元を表すサブジェクトがカプセル化されます。

    • メソッドの詳細

      • isProtected

        boolean isProtected()
        現在リクエストされているリソースが保護されているかどうかを確認します。保護されたリソースとは、制約が定義されているリソース（Jakarta Servlet、Jakarta Faces ページ、Jakarta Server Pages ページなど）です。web.xml。
        戻り値:
        保護されたリソースがリクエストされた場合は true、パブリックリソースがリクエストされた場合は false。

      • isAuthenticationRequest

        boolean isAuthenticationRequest()
        認証メカニズムへの現在の呼び出しが、アプリケーションが SecurityContext.authenticate(HttpServletRequest, HttpServletResponse, AuthenticationParameters) を呼び出した結果であるかどうかを確認します

        SecurityContext#authenticate が呼び出されなかった場合、認証メカニズムは、リクエストの開始時にコンテナーによって呼び出された可能性があります。

        戻り値:
        SecurityContext#authenticate が呼び出された場合は true、呼び出されなかった場合は false。

      • isRegisterSession

        boolean isRegisterSession()
        現在のリクエスト中に認証セッションを登録するようにランタイムがリクエストされているかどうかを確認します。
        戻り値:
        コードが認証セッションの登録を要求した場合は true、それ以外の場合は false。

      • setRegisterSession

        void setRegisterSession​(StringSE callerName,
                        SetSE<StringSE> groups)
        認証セッションを登録するようにランタイムにリクエストします。これにより、現在の HTTP セッションが有効である限り、ログインステータスが自動的に記憶されます。これがリクエストされない場合、HttpAuthenticationMechanism は、各リクエストの開始時にランタイムで手動で再認証する必要があります。
        パラメーター:
        callerName - 認証を記憶する必要がある発信者名
        groups - 認証を記憶する必要があるグループ。

      • cleanClientSubject

        void cleanClientSubject()
        このコンテキストに関連付けられているサブジェクトをクリーンアップするための便利なメソッド。

        このサブジェクトのクリーニングは、ServerAuthModule#cleanSubject メソッドの Jakarta Authentication のサーブレットコンテナープロファイルと、この仕様で定義されている HttpAuthenticationMechanism.cleanSubject(HttpServletRequest, HttpServletResponse, HttpMessageContext) メソッドで定義されているとおりに実行されます。

      • getAuthParameters

        AuthenticationParameters getAuthParameters()
        SecurityContext#authenticate（AuthParameters）呼び出しで提供されたパラメーターを返します。
        戻り値:
        SecurityContext#authenticate（AuthParameters）呼び出しで提供されたパラメーター、またはデフォルトのインスタンス。null になることはありません。

      • getHandler

        CallbackHandlerSE getHandler()
        この HttpMessageContext の作成時にランタイムが提供し、このコンテキストが認証の詳細をランタイムに伝達するために使用する低レベルの Jakarta Authentication ハンドラーを返します。

        メモ : これは低レベルのオブジェクトであり、ほとんどの高レベルのコードで直接使用する必要はありません。

        戻り値:
        ランタイムがこのコンテキストに提供したハンドラー

      • getMessageInfo

        MessageInfo getMessageInfo()
        現在のリクエストの低レベルの Jakarta Authentication メッセージ情報インスタンスを返します。

        メモ : これは低レベルのオブジェクトであり、ほとんどの高レベルのコードで直接使用する必要はありません。

        戻り値:
        現在のリクエストのメッセージ情報インスタンス。

      • getClientSubject

        SubjectSE getClientSubject()
        認証が行われるサブジェクトを返します。

        メモ : これは低レベルのオブジェクトであり、ほとんどの高レベルのコードで直接使用する必要はありません。

        戻り値:
        認証が行われる対象。

      • getRequest

        HttpServletRequest getRequest()
        現在のリクエストに関連付けられているリクエストオブジェクトを返します。
        戻り値:
        現在のリクエストに関連付けられているリクエストオブジェクト。

      • setRequest

        void setRequest​(HttpServletRequest request)
        リクエストオブジェクトを設定します。
        パラメーター:
        request - 設定するリクエストオブジェクト

      • withRequest

        HttpMessageContext withRequest​(HttpServletRequest request)
        リクエストオブジェクトを設定します。
        パラメーター:
        request - 設定されるリクエストオブジェクト。
        戻り値:
        このメソッドが呼び出された HttpMessageContext インスタンスは、流れるようなスタイルの呼び出しチェーンに役立ちます。

      • getResponse

        HttpServletResponse getResponse()
        現在のリクエストに関連付けられているレスポンスオブジェクトを返します。
        戻り値:
        現在のリクエストに関連付けられているレスポンスオブジェクト。

      • setResponse

        void setResponse​(HttpServletResponse response)
        レスポンスオブジェクトを設定します。
        パラメーター:
        response - 設定するレスポンスオブジェクト。

      • notifyContainerAboutLogin

        AuthenticationStatus notifyContainerAboutLogin​(StringSE callername,
                                               SetSE<StringSE> groups)
        SecurityContext.isCallerInRole(String) などで使用するためにアプリケーションで使用できるようにするために、指定された呼び出し元の名前とグループを登録するようにコンテナーに要求します。

        この呼び出しが返された後、認証された ID はすぐにはアクティブにならないことに注意してください。これは、この呼び出しが行われる認証メカニズムが制御をコンテナーに戻した後（実行時）にのみ発生します（エラーが発生しない場合）。

        便宜上、このメソッドは SUCCESS を返すため、このメソッドは HttpAuthenticationMechanism からの 1 つの流れるような return ステートメントで使用できます。

        パラメーター:
        callername - 発信者プリンシパルとなる発信者名
        groups - 発信者プリンシパルに関連付けられているグループ
        戻り値:
        AuthenticationStatus.SUCCESS

      • notifyContainerAboutLogin

        AuthenticationStatus notifyContainerAboutLogin​(PrincipalSE principal,
                                               SetSE<StringSE> groups)
        SecurityContext.isCallerInRole(String) などで使用するためにアプリケーションで使用できるようにするために、指定された呼び出し元のプリンシパルとグループを登録するようにコンテナーに要求します。

        この呼び出しにより、コンテナーは、呼び出し元の ID を表す 2 つの呼び出し元プリンシパルを確立する可能性があることに注意してください。ここでは、プリンシパルパラメーターとして提供されるプリンシパルと、コンテナーの呼び出し元 ID の表現として使用される 2 番目のプリンシパルです。2 番目のプリンシパルは、コンテナーが呼び出し元を表すために異なるプリンシパル型を使用する場合にのみ追加されます。型が同じである場合、1 つのプリンシパルのみが追加されます。

        2 番目のプリンシパルが追加された場合、Principal.getName() によって返される値は両方のプリンシパルで同じになります。

        2 つのプリンシパルが追加されると、コンテナーの呼び出し元プリンシパルが SecurityContext.getCallerPrincipal() から返され、ここでパラメーターとして指定されたプリンシパルは SecurityContext.getPrincipalsByType(Class) を使用して取得できます。1 つだけ追加すると、SecurityContext.getCallerPrincipal() によって返されます。

        この呼び出しが返された後、認証された ID はすぐにはアクティブにならないことに注意してください。これは、この呼び出しが行われる認証メカニズムが制御をコンテナーに戻した後（実行時）にのみ発生します（エラーが発生しない場合）。

        便宜上、このメソッドは SUCCESS を返すため、このメソッドは HttpAuthenticationMechanism からの 1 つの流れるような return ステートメントで使用できます。

        パラメーター:
        principal - 発信者プリンシパルになるプリンシパル
        groups - 発信者プリンシパルに関連付けられているグループ
        戻り値:
        AuthenticationStatus.SUCCESS

      • doNothing

        AuthenticationStatus doNothing()
        コンテナーに「何もしない」ように指示します。

        何もしない場合、Jakarta Security 認証メカニズムは、戻り値を介してこれを明示的に示す必要があります。

        便宜上、このメソッドは NOT_DONE を返すため、このメソッドは HttpAuthenticationMechanism からの 1 つの流れるような return ステートメントで使用できます。

        戻り値:
        AuthenticationStatus.NOT_DONE

      • getCallerPrincipal

        PrincipalSE getCallerPrincipal()
        notifyContainerAboutLogin() の呼び出しによって設定されたプリンシパルを取得します。
        戻り値:
        発信者のプリンシパル

      • getGroups

        SetSE<StringSE> getGroups()
        notifyContainerAboutLogin() の呼び出しによって設定されたグループを取得します。
        戻り値:
        グループ