nablarch.fw.web.handler

クラス HttpCharacterEncodingHandler

java.lang.Object

nablarch.fw.web.handler.HttpCharacterEncodingHandler

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

Handler<java.lang.Object,java.lang.Object>

public class HttpCharacterEncodingHandler
extends java.lang.Object
implements Handler<java.lang.Object,java.lang.Object>

HTTP エンコーディング制御ハンドラ。

 #setDefaultEncoding(String) に指定されたエンコーディングを HttpServletRequest/HttpServletResponse に対して設定する。
 明示的に設定しない場合は"UTF-8"を使用する。
 

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

コンストラクタ

コンストラクタと説明
HttpCharacterEncodingHandler() デフォルトコンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.nio.charset.Charset	getDefaultEncoding() デフォルトエンコーディングを取得する。
java.lang.Object	handle(java.lang.Object data, ExecutionContext context) エンコーディングを設定する。
protected java.nio.charset.Charset	resolveRequestEncoding(javax.servlet.http.HttpServletRequest request) リクエストのエンコーディングを解決する。
protected java.nio.charset.Charset	resolveResponseEncoding(javax.servlet.http.HttpServletRequest request) レスポンスのエンコーディングを解決する。
void	setAppendResponseCharacterEncoding(boolean appendResponseCharacterEncoding) レスポンスのContent-Typeに「;charset=xx」を付加するかのフラグを設定する。
void	setDefaultEncoding(java.lang.String name) デフォルトエンコーディングを設定する。
void	setDefaultEncodingCharset(java.nio.charset.Charset encoding) デフォルトエンコーディングを設定する。

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

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

コンストラクタの詳細

HttpCharacterEncodingHandler

@Published(tag="architect")
public HttpCharacterEncodingHandler()

デフォルトコンストラクタ。

メソッドの詳細

setDefaultEncoding

public void setDefaultEncoding(java.lang.String name)

デフォルトエンコーディングを設定する。

パラメータ:

name - エンコーディング名

setDefaultEncodingCharset

public void setDefaultEncodingCharset(java.nio.charset.Charset encoding)

デフォルトエンコーディングを設定する。

パラメータ:

encoding - エンコーディング

getDefaultEncoding

public java.nio.charset.Charset getDefaultEncoding()

デフォルトエンコーディングを取得する。

戻り値:

エンコーディング

setAppendResponseCharacterEncoding

public void setAppendResponseCharacterEncoding(boolean appendResponseCharacterEncoding)

レスポンスのContent-Typeに「;charset=xx」を付加するかのフラグを設定する。

パラメータ:

appendResponseCharacterEncoding - フラグ

handle

public java.lang.Object handle(java.lang.Object data,
                               ExecutionContext context)

エンコーディングを設定する。
本ハンドラは以下の手順で処理を行う。

1. resolveRequestEncoding(HttpServletRequest) で解決したエンコーディングを HttpServletRequest に設定する。
2. resolveResponseEncoding(HttpServletRequest) で解決したエンコーディングを HttpServletResponse に設定する。
3. 後続のハンドラに処理を委譲する。

定義:

handle インタフェース内 Handler<java.lang.Object,java.lang.Object>

パラメータ:

data - 入力データ

context - 実行コンテキスト

戻り値:

処理結果データ

resolveRequestEncoding

@Published(tag="architect")
protected java.nio.charset.Charset resolveRequestEncoding(javax.servlet.http.HttpServletRequest request)

リクエストのエンコーディングを解決する。

 本ハンドラでは設定されているデフォルトエンコーディングを返却する。
 URI 等のリクエスト情報によってエンコーディングを切り替える必要がある場合は、
 本メソッドを拡張し、エンコーディングを解決する処理を実装すること。

 ただし、本メソッド内ではリクエストパラメータの取得を行ってはならない。
 リクエストパラメータの取得を行ってしまうと、エンコーディングの指定が行えなくなってしまうので、
 文字化けの原因となる。
 

パラメータ:

request - リクエスト

戻り値:

リクエストのエンコーディング

resolveResponseEncoding

@Published(tag="architect")
protected java.nio.charset.Charset resolveResponseEncoding(javax.servlet.http.HttpServletRequest request)

レスポンスのエンコーディングを解決する。

 本ハンドラでは設定されているデフォルトエンコーディングを返却する。
 URI 等のリクエスト情報によってエンコーディングを切り替える必要がある場合は、
 本メソッドを拡張し、エンコーディングを解決する処理を実装すること。

 ただし、本メソッド内ではリクエストパラメータの取得を行ってはならない。
 リクエストパラメータの取得を行ってしまうと、エンコーディングの指定が行えなくなってしまうので、
 文字化けの原因となる。
 

パラメータ:

request - リクエスト

戻り値:

レスポンスのエンコーディング