4.7. 認証エラー¶
認証機能で発生するエラーについて説明します。
項目
4.7.1. 認証エラーの概要¶
認証機能では、処理の結果に応じた認証エラーが定義されています。認証エラーが発生した場合は、認証エラーの種別に応じた「エラー」画面が表示されます。エラー種別とエラー画面は設定ファイルで定義され、エラー時の処理を変更することが可能です。認証エラーの一覧は、「 認証エラー一覧 」を参照してください。エラー画面を変更する設定方法は、「 認証エラー画面の設定 」を参照してください。注意
ここでは、認証機能が提供する認証エラーの説明と、エラー画面の変更方法を説明します。独自に認証エラーを追加することはできません。
4.7.2. 認証エラー一覧¶
認証エラーの一覧は、以下の通りです。
4.7.2.1. 一般ユーザの認証エラー¶
4.7.2.1.1. ログインエラー¶
エラー種別コード CERTIFICATION_ERROR エラーページパス user/certification/error/certification_error_page 戻り先 ログイン画面 説明
- エラーが発生する原因は、以下の通りです。
- ユーザが存在しない場合。
- 認証モジュールが認証失敗を返却した場合。
4.7.2.1.2. ライセンスエラー¶
エラー種別コード LICENSE_ERROR エラーページパス user/certification/error/certification_error_page 戻り先 ログイン画面 説明
- エラーが発生する原因は、以下の通りです。
- アカウントライセンスが付与されていない場合。
- アカウントの有効期間が期間外の場合。
4.7.2.1.3. アカウントロックエラー¶
エラー種別コード LOCKED_ERROR エラーページパス user/certification/error/certification_error_page 戻り先 ログイン画面 説明
- エラーが発生する原因は、以下の通りです。
- アカウントロックされていて、アカウントロック期間を超えていない場合。
4.7.2.1.4. 認証処理エラー¶
エラー種別コード SYSTEM_ERROR エラーページパス user/certification/error/system_error_page 戻り先 なし 説明
- エラーが発生する原因は、以下の通りです。
- 認証モジュールが解決できない場合。
- 認証モジュール、または、認証リスナーがエラーを返却した場合。
- ユーザコードが取得できない場合。
4.7.2.1.5. 未認証エラー(認証確認)¶
エラー種別コード CONFIRM_UNAUTHORIZED_ERROR エラーページパス 初期設定なし。(HTTP401エラー画面を利用します) 戻り先 ログイン画面 説明
- エラーが発生する原因は、以下の通りです。
- 認証確認対象画面アクセス時に、未認証の場合。
4.7.2.1.6. 認証確認エラー¶
エラー種別コード CERTIFICATION_CONFIRM_ERROR エラーページパス user/certification/error/certification_confirm_error_page 戻り先 認証確認画面 説明
- エラーが発生する原因は、以下の通りです。
- 認証モジュールが認証失敗を返却した場合。
4.7.2.1.7. テナントID無効エラー¶
エラー種別コード TENANT_NOT_FOUND_ERROR エラーページパス user/certification/error/certification_error_page 戻り先 ログイン画面 説明
- エラーが発生する原因は、以下の通りです。
- 指定されたテナントIDが存在しない場合。
導入バージョン intra-mart Accel Platform 2014 Spring(Granada)
4.7.2.2. システム管理者の認証エラー¶
4.7.2.2.1. ログインエラー¶
エラー種別コード ADMIN_CERTIFICATION_ERROR エラーページパス system/certification/error/admin_certification_error_page 戻り先 ログイン画面 説明
- エラーが発生する原因は、以下の通りです。
- システム管理者が存在しない場合。
- 認証モジュールが認証失敗を返却した場合。
4.7.2.2.2. 認証処理エラー¶
エラー種別コード ADMIN_SYSTEM_ERROR エラーページパス system/certification/error/admin_system_error_page 戻り先 なし 説明
- エラーが発生する原因は、以下の通りです。
- 認証モジュールが解決できなかった場合。
- 認証モジュール、または、認証リスナーがエラーを返却した場合。
- ユーザコードが取得できない場合。
4.7.2.2.3. 未認証エラー(認証確認)¶
エラー種別コード ADMIN_CONFIRM_UNAUTHORIZED_ERROR エラーページパス 初期設定なし。(HTTP401エラー画面を利用します) 戻り先 ログイン画面 説明
- エラーが発生する原因は、以下の通りです。
- 認証確認対象画面アクセス時に、未認証の場合。
4.7.2.2.4. 認証確認エラー¶
エラー種別コード ADMIN_CERTIFICATION_CONFIRM_ERROR エラーページパス system/certification/error/admin_certification_confirm_error_page 戻り先 認証確認画面 説明
- エラーが発生する原因は、以下の通りです。
- 認証モジュールが認証失敗を返却した場合。
4.7.3. 認証エラー画面の設定¶
認証エラー画面は、PageManager API を利用して、以下の plugin.xml から取得しています。一般ユーザ用設定
ファイル <plugin/jp.co.intra_mart.certification.page.standard/plugin.xml> プラグインID jp.co.intra_mart.certification.page.standard.error 一般ユーザ用設定(テナントID無効エラー)
ファイル <plugin/jp.co.intra_mart.certification.page.vt/plugin.xml> プラグインID jp.co.intra_mart.certification.page.vt.error 導入バージョン intra-mart Accel Platform 2014 Spring(Granada) システム管理者用設定
ファイル <plugin/jp.co.intra_mart.certification.page.administrator/plugin.xml> プラグインID jp.co.intra_mart.certification.page.administrator.error 認証エラー画面を変更する場合、上記プラグインの情報を参照して、新しい設定ファイルを作成してください。ログインエラー画面の変更方法は以下の通りです。
新しいエラー画面を作成する。
任意のエラー画面を作成してください。エラー画面は、認証機能から FORWARD されて呼びだされます。エラー画面からログイン画面に遷移する場合、遷移先情報を持ちまわる必要があります。遷移先情報については、「 遷移先情報キー 」を参照してください。plugin.xml ファイルを作成する。
plugin.xml ファイルを作成し、plugin ディレクトリ配下の任意のディレクトリに配置してください。ユニークなプラグインIDを作成し、rank 属性を標準プラグインの「100」より小さく設定して、プラグインの設定を行ってください。以下の設定を行う、plugin.xml の例を示します。
- プラグインID: sample.certification.error
- rank: 90
- エラー種別: ログインエラー( CERTIFICATION_ERROR )
- エラー画面: /sample/certification/error/certification_error_page
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 <?xml version="1.0" encoding="UTF-8"?> <plugin> <extension point="jp.co.intra_mart.page"> <page-config name="Sample" id="sample.certification.error" version="8.0" rank="90"> <!-- スクリプト開発モデルの場合のページプロバイダ --> <page-provider-class>jp.co.intra_mart.system.page.provider.script.StandardJsspPageProvider</page-provider-class> <init-param> <!-- ログインエラーのエラーページID --> <param-name>jp.co.intra_mart.foundation.security.certification.CertificationStatus.CERTIFICATION_ERROR</param-name> <!-- 変更するエラーページのパス --> <param-value>/sample/certification/error/certification_error_page</param-value> </init-param> </page-config> </extension> </plugin>plugin.xml のエラー種別(<param-name>)には、以下を設定してください。jp.co.intra_mart.foundation.security.certification.CertificationStatus. + 「エラー種別コード」
コラム
PageManager API については、APIドキュメントを参照してください。
- PageManager クラスの APIドキュメント (JavaEE開発モデル)
- PageManager オブジェクトの APIドキュメント (スクリプト開発モデル)