jp.co.intra_mart.foundation.oauth.provider.router

クラス OAuthActionFilter

java.lang.Object

jp.co.intra_mart.foundation.oauth.provider.router.OAuthActionFilter

すべての実装されたインタフェース:

ActionFilter

public class OAuthActionFilter
extends Object
implements ActionFilter

OAuth 認証を行うための Filter を提供します。

導入されたバージョン:

8.0.1

バージョン:

8.0.16

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected static Logger	SECURITY_LOGGER セキュリティロガー

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
OAuthActionFilter(String scope) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	doFilter(String path, PathVariables variables, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ActionFilterChain filterChain) Filter 機能を実行します。
protected void	setErrorResponse(Integer statusCode, OAuthException exception, javax.servlet.http.HttpServletResponse response) エラー時のレスポンスを出力します。
protected boolean	skipLogin(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) OAuthによる認証・ログイン処理を省略するかどうかを返却します。
protected boolean	skipLogout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) ログアウト処理を省略するかどうかを返却します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

SECURITY_LOGGER

protected static final Logger SECURITY_LOGGER

セキュリティロガー

コンストラクタの詳細

OAuthActionFilter

public OAuthActionFilter(String scope)

コンストラクタ。

パラメータ:

scope - スコープ

メソッドの詳細

doFilter

public boolean doFilter(String path,
                        PathVariables variables,
                        javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        ActionFilterChain filterChain)
                 throws IOException,
                        javax.servlet.ServletException

インタフェースからコピーされた説明: ActionFilter

Filter 機能を実行します。

定義:

doFilter インタフェース内 ActionFilter

パラメータ:

path - パス

variables - パス変数

request - リクエスト

response - レスポンス

filterChain - 次のフィルタ

戻り値:

true: 処理を継続します, false: 処理を継続しません。

例外:

IOException - 入出力処理においてエラーが発生した場合

javax.servlet.ServletException - サーブレット・コンテナでエラーが発生した場合

setErrorResponse

protected void setErrorResponse(Integer statusCode,
                                OAuthException exception,
                                javax.servlet.http.HttpServletResponse response)
                         throws IOException

エラー時のレスポンスを出力します。

パラメータ:

statusCode - ステータスコード

exception - 例外クラス

response - レスポンス

例外:

IOException - レスポンスの出力に失敗した場合にスローされます。

skipLogin

protected boolean skipLogin(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)

OAuthによる認証・ログイン処理を省略するかどうかを返却します。
OAuthActionFilter では常にfalseを返却します。

パラメータ:

request - リクエスト

response - レスポンス

戻り値:

認証・ログイン処理を省略するかどうか

skipLogout

protected boolean skipLogout(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)

ログアウト処理を省略するかどうかを返却します。
OAuthActionFilter では常にfalseを返却します。

パラメータ:

request - リクエスト

response - レスポンス

戻り値:

ログアウト処理を省略するかどうか