クラス HttpAuthenticationMechanismWrapper
- java.lang.ObjectSE
-
- jakarta.security.enterprise.authentication.mechanism.http.HttpAuthenticationMechanismWrapper
- 実装されているすべてのインターフェース:
HttpAuthenticationMechanism
public class HttpAuthenticationMechanismWrapper extends ObjectSE implements HttpAuthenticationMechanism
このクラスはHttpAuthenticationMechanismインターフェースの実装であり、追加の機能または異なる機能を提供したい開発者がサブクラス化できます。すべてのメソッドは、デフォルトでラップされたオブジェクトを呼び出します。
- 導入:
- 3.0
コンストラクターの概要
コンストラクター コンストラクター 説明 HttpAuthenticationMechanismWrapper()このコンストラクターは、プロキシの使用のみを目的としています。HttpAuthenticationMechanismWrapper(HttpAuthenticationMechanism httpAuthenticationMechanism)委譲先のオブジェクトでラッパーを構築します。
方法の概要
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 voidcleanSubject(HttpServletRequest request, HttpServletResponse response, HttpMessageContext httpMessageContext)サブジェクトからメカニズム固有のプリンシパルとクレデンシャルを削除し、メカニズムが使用した可能性のあるその他の状態を削除します。HttpAuthenticationMechanismgetWrapped()ラップされているオブジェクトを返します。AuthenticationStatussecureResponse(HttpServletRequest request, HttpServletResponse response, HttpMessageContext httpMessageContext)オプションで、レスポンスを保護します。AuthenticationStatusvalidateRequest(HttpServletRequest request, HttpServletResponse response, HttpMessageContext httpMessageContext)HTTP リクエストを認証します。
コンストラクターの詳細
HttpAuthenticationMechanismWrapper
public HttpAuthenticationMechanismWrapper()
このコンストラクターは、プロキシの使用のみを目的としています。
HttpAuthenticationMechanismWrapper
public HttpAuthenticationMechanismWrapper(HttpAuthenticationMechanism httpAuthenticationMechanism)
委譲先のオブジェクトでラッパーを構築します。- パラメーター:
httpAuthenticationMechanism- すべてのメソッドが呼び出すラップされたオブジェクト。
メソッドの詳細
getWrapped
public HttpAuthenticationMechanism getWrapped()
ラップされているオブジェクトを返します。- 戻り値:
- ラップされているオブジェクト。
validateRequest
public AuthenticationStatus validateRequest(HttpServletRequest request, HttpServletResponse response, HttpMessageContext httpMessageContext) throws AuthenticationException
インターフェースからコピーされた説明:HttpAuthenticationMechanismHTTP リクエストを認証します。このメソッドは、リソースに対する HTTP クライアントリクエストに応じて呼び出され、常に
FilterまたはHttpServletの前に呼び出されます。さらに、このメソッドはHttpServletRequest.authenticate(HttpServletResponse)にレスポンスして呼び出されますデフォルトでは、このメソッドは、リクエストが保護されたリソースまたは保護されていないリソースに対するものであるかどうか、同じ HTTP セッション内で呼び出し元が正常に認証されたかどうかに関係なく、すべてのリクエストに対して常に呼び出されることに注意してください。
CDI/Interceptor 仕様インターセプターを使用して、必要に応じてこのメソッドの呼び出しを防ぐことができます。2 つの例については、
AutoApplySessionおよびRememberMeを参照してください。- 次で指定:
- インターフェース
HttpAuthenticationMechanismのvalidateRequest - パラメーター:
request- クライアントが行ったリクエストが含まれていますresponse- クライアントに送信されるレスポンスが含まれていますhttpMessageContext- コンテナーと対話するためのコンテキスト- 戻り値:
- このメソッドによって実行された処理の完了ステータス
- 例外:
AuthenticationException- 処理が失敗したとき
secureResponse
public AuthenticationStatus secureResponse(HttpServletRequest request, HttpServletResponse response, HttpMessageContext httpMessageContext) throws AuthenticationException
インターフェースからコピーされた説明:HttpAuthenticationMechanismオプションで、レスポンスを保護します。このメソッドは、リクエストに対して後処理を行うために呼び出され、 常に
FilterまたはHttpServletの後に呼び出されます。このメソッドは、(サーブレット)リソースが実際に呼び出されたときにのみ呼び出されることに注意してください。つまり、
FilterまたはHttpServletが SUCCESS を返す前に呼び出されたvalidateRequestへの以前の呼び出しが呼び出された場合のみです。- 次で指定:
- インターフェース
HttpAuthenticationMechanismのsecureResponse - パラメーター:
request- クライアントが行ったリクエストが含まれていますresponse- クライアントに送信されるレスポンスが含まれていますhttpMessageContext- コンテナーと対話するためのコンテキスト- 戻り値:
- このメソッドによって実行された処理の完了ステータス
- 例外:
AuthenticationException- 処理が失敗したとき
cleanSubject
public void cleanSubject(HttpServletRequest request, HttpServletResponse response, HttpMessageContext httpMessageContext)
インターフェースからコピーされた説明:HttpAuthenticationMechanismサブジェクトからメカニズム固有のプリンシパルとクレデンシャルを削除し、メカニズムが使用した可能性のあるその他の状態を削除します。このメソッドは
HttpServletRequest.logout()にレスポンスして呼び出され、認証メカニズムに、以前に確立された認証済み ID に関連付けられた状態を削除するオプションを提供します。例: Cookie 内に状態を保存する認証メカニズムは、ここでその Cookie を削除して送信できます。- 次で指定:
- インターフェース
HttpAuthenticationMechanismのcleanSubject - パラメーター:
request- クライアントが行ったリクエストが含まれていますresponse- クライアントに送信されるレスポンスが含まれていますhttpMessageContext- コンテナーと対話するためのコンテキスト