intra-mart(R) 6.0.13

jp.co.intra_mart.foundation.security.certification
インタフェース ErrorPageProvider


public interface ErrorPageProvider

エラーページプロバイダインタフェース。

ユーザ用の各種エラーページを取得するためのインタフェース
エラーページプロバイダを実装する場合は必ずこのインタフェースを実装します。
アクセスセキュリティAPIはこのインタフェースを通じて必要なエラーページを取得します。

このインターフェースを実装したクラスを以下の設定ファイルに記述します。
サーバーマネージャインストールディレクトリ/conf/access-security.xml

 <access-security>
   <security-config>
     <error-page-provider>
       <page-provider-class>エラーページプロバイダインタフェース実装クラス名(フルパッケージ名)</page-provider-class>            
       <init-param>
         <param-name>初期化パラメータ名</param-name>
         <param-value>初期化パラメータ値</param-value>
       </init-param>
     </error-page-provider>
   </security-config>
 </access-security>
 
<init-param>タグは複数設定可能です。
このタグに設定された値は、クラス初期化時に、init関数の引数として渡されます。

導入されたバージョン:
5.0
バージョン:
1.0

メソッドの概要
 String getCertificationErrorPage(SessionInfo sessionInfo, HttpServletRequest request, HttpServletResponse response)
          認証失敗エラーページURLを取得する。
 String getGroupErrorPage(SessionInfo sessionInfo, HttpServletRequest request, HttpServletResponse response)
          ログイングループエラーページURLを取得する。
 String getLicenceErrorPage(SessionInfo sessionInfo, HttpServletRequest request, HttpServletResponse response)
          ライセンスエラーページURLを取得する。
 String getLockedErrorPage(SessionInfo sessionInfo, HttpServletRequest request, HttpServletResponse response)
          ユーザロックエラーページURLを取得する。
 String getNoPermissionErrorPage(SessionInfo sessionInfo, HttpServletRequest request, HttpServletResponse response)
          無許可アクセスエラーページURLを取得する。
 String getSessionErrorPage(SessionInfo sessionInfo, HttpServletRequest request, HttpServletResponse response)
          セッションエラーページURLを取得する。
 String getSessionTimeoutErrorPage(HttpServletRequest request, HttpServletResponse response)
          セッションタイムアウトエラーページURLを取得する。
 String getSystemErrorPage(SessionInfo sessionInfo, HttpServletRequest request, HttpServletResponse response)
          認証処理エラーページURLを取得する。
 void init(Map params)
          ページプロバイダの初期化を行います。
 

メソッドの詳細

init

public void init(Map params)
ページプロバイダの初期化を行います。

ページプロバイダのインスタンス生成時に一度だけ呼び出されます。

パラメータ:
params - 初期化パラメータのマップ

getCertificationErrorPage

public String getCertificationErrorPage(SessionInfo sessionInfo,
                                        HttpServletRequest request,
                                        HttpServletResponse response)
認証失敗エラーページURLを取得する。

認証に失敗した場合( SecurityConstraint.CR_NG)に表示するページを取得する。

パラメータ:
sessionInfo - セッション情報
request - サーブレットリクエスト
response - サーブレットレスポンス
戻り値:
認証失敗エラーページURL

getLockedErrorPage

public String getLockedErrorPage(SessionInfo sessionInfo,
                                 HttpServletRequest request,
                                 HttpServletResponse response)
ユーザロックエラーページURLを取得する。

各ログインタイプ別のページプロバイダからユーザロックエラーページが取得できなかった場合に利用される。

パラメータ:
sessionInfo - セッション情報
request - サーブレットリクエスト
response - サーブレットレスポンス
戻り値:
ユーザロックエラーページURL

getLicenceErrorPage

public String getLicenceErrorPage(SessionInfo sessionInfo,
                                  HttpServletRequest request,
                                  HttpServletResponse response)
ライセンスエラーページURLを取得する。

認証するユーザにライセンスがないか、または有効期間内でない場合( SecurityConstraint.CR_NO_LICENSE )に表示するページを取得する。

パラメータ:
sessionInfo - セッション情報
request - サーブレットリクエスト
response - サーブレットレスポンス
戻り値:
ライセンスエラーページURL

getGroupErrorPage

public String getGroupErrorPage(SessionInfo sessionInfo,
                                HttpServletRequest request,
                                HttpServletResponse response)
ログイングループエラーページURLを取得する。

認証するログイングループが存在しない場合( SecurityConstraint.CR_NO_GROUP )に表示するページを取得する。

パラメータ:
sessionInfo - セッション情報
request - サーブレットリクエスト
response - サーブレットレスポンス
戻り値:
ログイングループエラーページURL

getSessionErrorPage

public String getSessionErrorPage(SessionInfo sessionInfo,
                                  HttpServletRequest request,
                                  HttpServletResponse response)
セッションエラーページURLを取得する。

セッション情報に不整合が出た場合( SecurityConstraint.CR_SESSION_UNMATCH )に表示するページを取得する。

パラメータ:
sessionInfo - セッション情報
request - サーブレットリクエスト
response - サーブレットレスポンス
戻り値:
セッションエラーページURL

getSessionTimeoutErrorPage

public String getSessionTimeoutErrorPage(HttpServletRequest request,
                                         HttpServletResponse response)
セッションタイムアウトエラーページURLを取得する。

セッションがタイムアウトになった場合( SecurityConstraint.CR_SESSION_TIMEOUT )に表示するページを取得する。

パラメータ:
request - サーブレットリクエスト
response - サーブレットレスポンス
戻り値:
セッションタイムアウトエラーページURL

getNoPermissionErrorPage

public String getNoPermissionErrorPage(SessionInfo sessionInfo,
                                       HttpServletRequest request,
                                       HttpServletResponse response)
無許可アクセスエラーページURLを取得する。

無許可のURLにアクセスした場合( SecurityConstraint.CR_NO_PERMISSION )に表示するページを取得する。

パラメータ:
sessionInfo - セッション情報
request - サーブレットリクエスト
response - サーブレットレスポンス
戻り値:
無許可アクセスエラーページURL

getSystemErrorPage

public String getSystemErrorPage(SessionInfo sessionInfo,
                                 HttpServletRequest request,
                                 HttpServletResponse response)
認証処理エラーページURLを取得する。

認証処理中にエラーが発生した場合( SecurityConstraint.CR_ERROR)に表示するページを取得する。

パラメータ:
sessionInfo - セッション情報
request - サーブレットリクエスト
response - サーブレットレスポンス
戻り値:
認証処理エラーページURL

intra-mart(R) 6.0.13

Copyright © 2000-2009 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.