NablarchTagHandler (Nablarch-API)

java.lang.Object
- nablarch.common.web.handler.NablarchTagHandler

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

Handler<HttpRequest,HttpResponse>, HttpRequestHandler
```
public class NablarchTagHandler
extends java.lang.Object
implements HttpRequestHandler
```
Nablarchのカスタムタグ機能に必要なリクエスト処理を行うハンドラ。
このハンドラは、1リクエストにつき一度だけ下記の処理を行う。内部フォワードにより1リクエストにつき複数回呼ばれても初回のみ処理を行う。
- ボタン又はリンク毎のパラメータ変更機能を実現するために、リクエストに変更パラメータを設定する。
- リクエストにcheckboxタグのチェックなしに対応する値を設定する。
- hiddenタグの暗号化機能に対応する改竄チェックと復号を行う。
- HTTPアクセスログのリクエストパラメータを出力する。
- カスタムタグのデフォルト値をJSPで参照できるように、CustomTagConfigをリクエストスコープに設定する。
改竄チェックと復号は、カスタムタグのデフォルト値設定において、hiddenタグの暗号化機能を「使用する」に設定している場合のみ処理を行う。 hiddenタグの暗号化機能を「使用しない」に設定している場合は、何もせずに次のハンドラに処理を委譲する。さらに、カスタムタグのデフォルト値設定の暗号化を行わないリクエストIDに現在のリクエストIDが含まれる場合は、改竄チェックと復号を行わずに次のハンドラに処理を委譲する。
このハンドラを使用する場合は、改竄を検知した場合に遷移する画面とステータスを必ずプロパティで指定する必要がある。

HTTPアクセスログの出力は、HttpAccessLogUtilに委譲する。

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static java.lang.String`	`CUSTOM_TAG_CONFIG_KEY` `CustomTagConfig`をリクエストスコープに格納する際に使用するキー
`static java.lang.String`	`DECRYPTED_PARAMS` 復号したリクエストパラメータをリクエストスコープに設定する属性名

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

コンストラクタ
コンストラクタと説明

NablarchTagHandler()

コンストラクタ
コンストラクタと説明
`NablarchTagHandler()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`HttpResponse`	`handle(HttpRequest request, ExecutionContext context)` HTTPリクエストに対する処理を実行する。
`protected void`	`restoreKeyValueSet(HttpRequest request)` 複合キーの値を復元する。
`void`	`setPath(java.lang.String path)` 改竄を検知した場合に送信する画面のリソースパスを設定する。
`void`	`setSessionExpirePath(java.lang.String sessionExpirePath)` セッションから暗号化鍵情報が取得出来なかった場合に表示する画面のリソースパスを設定する。
`void`	`setSessionExpireStatusCode(int sessionExpireStatusCode)` セッションから情報が取得出来なかった場合のレスポンスステータスを設定する。
`void`	`setStatusCode(int statusCode)` 改竄を検知した場合のレスポンスステータスを設定する。
`protected void`	`writeParametersLog(HttpRequest request, ExecutionContext context)` HTTPアクセスログのリクエストパラメータを出力する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - DECRYPTED_PARAMS
```
public static final java.lang.String DECRYPTED_PARAMS
```
    復号したリクエストパラメータをリクエストスコープに設定する属性名
    
    関連項目:
    
    定数フィールド値
  - CUSTOM_TAG_CONFIG_KEY
```
public static final java.lang.String CUSTOM_TAG_CONFIG_KEY
```
    CustomTagConfigをリクエストスコープに格納する際に使用するキー
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - NablarchTagHandler
```
public NablarchTagHandler()
```
- メソッドの詳細
  - setPath
```
public void setPath(java.lang.String path)
```
    改竄を検知した場合に送信する画面のリソースパスを設定する。
    
    パラメータ:
    
    path - 改竄を検知した場合に送信する画面のリソースパス
  - setSessionExpirePath
```
public void setSessionExpirePath(java.lang.String sessionExpirePath)
```
    セッションから暗号化鍵情報が取得出来なかった場合に表示する画面のリソースパスを設定する。
    この値を設定しなかった場合、 path プロパティに設定した改竄エラー画面が表示される。
    
    パラメータ:
    
    sessionExpirePath - セッションから情報が取得出来なかった場合に表示する画面のリソースパス
  - setStatusCode
```
public void setStatusCode(int statusCode)
```
    改竄を検知した場合のレスポンスステータスを設定する。
    デフォルトは400。
    
    パラメータ:
    
    statusCode - 改竄を検知した場合のレスポンスステータス
  - setSessionExpireStatusCode
```
public void setSessionExpireStatusCode(int sessionExpireStatusCode)
```
    セッションから情報が取得出来なかった場合のレスポンスステータスを設定する。
    
    パラメータ:
    
    sessionExpireStatusCode - セッションから情報が取得出来なかった場合のレスポンスステータス
  - handle
```
public HttpResponse handle(HttpRequest request,
                           ExecutionContext context)
```
    HTTPリクエストに対する処理を実行する。
    
    1リクエストにつき一度だけ下記の処理を順に行う。内部フォワードにより1リクエストにつき複数回呼ばれても初回のみ処理を行う。
    - リクエストに変更パラメータを設定する。
    - "nablarch_tag_config"という変数名でリクエストスコープにCustomTagConfigを設定する。
    - hiddenタグの値を復号し、リクエストパラメータに設定する。復号では、改竄チェックを行い、改竄を検知した場合は指定された画面に遷移する。復号が成功した場合は、次のハンドラに処理を委譲する。復号処理は、HiddenEncryptionUtil.decryptHiddenValues(ExecutionContext, String)に移譲する。
    - HTTPアクセスログのリクエストパラメータを出力する。
    定義:
    
    handle インタフェース内 Handler<HttpRequest,HttpResponse>
    
    定義:
    
    handle インタフェース内 HttpRequestHandler
    
    パラメータ:
    
    request - HTTPリクエストオブジェクト
    
    context - サーバサイド実行コンテキストオブジェクト
    
    戻り値:
    
    HTTPレスポンスオブジェクト
  - restoreKeyValueSet
```
protected void restoreKeyValueSet(HttpRequest request)
```
    複合キーの値を復元する。
    
    パラメータ:
    
    request - HttpRequest
  - writeParametersLog
```
protected void writeParametersLog(HttpRequest request,
                                  ExecutionContext context)
                           throws java.lang.ClassCastException
```
    HTTPアクセスログのリクエストパラメータを出力する。
    
    パラメータ:
    
    request - HttpRequest
    
    context - ExecutionContext
    
    例外:
    
    java.lang.ClassCastException - context の型がServletExecutionContext で無い場合。

クラス NablarchTagHandler

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

DECRYPTED_PARAMS

CUSTOM_TAG_CONFIG_KEY

コンストラクタの詳細

NablarchTagHandler

メソッドの詳細

setPath

setSessionExpirePath

setStatusCode

setSessionExpireStatusCode

handle

restoreKeyValueSet

writeParametersLog