nablarch.fw.web.handler

Class HttpCharacterEncodingHandler

java.lang.Object

nablarch.fw.web.handler.HttpCharacterEncodingHandler

All Implemented Interfaces:

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"を使用する。
 

Constructor Summary

Constructors

Constructor and Description
HttpCharacterEncodingHandler() デフォルトコンストラクタ。

Method Summary

Modifier and Type	Method and Description
java.nio.charset.Charset	getDefaultEncoding() デフォルトエンコーディングを取得する。
java.lang.Object	handle(java.lang.Object data, ExecutionContext context) エンコーディングを設定する。 本ハンドラは以下の手順で処理を行う。 resolveRequestEncoding(HttpServletRequest) で解決したエンコーディングを HttpServletRequest に設定する。 resolveResponseEncoding(HttpServletRequest) で解決したエンコーディングを HttpServletResponse に設定する。 後続のハンドラに処理を委譲する。
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) デフォルトエンコーディングを設定する。

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpCharacterEncodingHandler

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

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

Method Detail

setDefaultEncoding

public void setDefaultEncoding(java.lang.String name)

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

Parameters:

name - エンコーディング名

setDefaultEncodingCharset

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

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

Parameters:

encoding - エンコーディング

getDefaultEncoding

public java.nio.charset.Charset getDefaultEncoding()

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

Returns:

エンコーディング

setAppendResponseCharacterEncoding

public void setAppendResponseCharacterEncoding(boolean appendResponseCharacterEncoding)

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

Parameters:

appendResponseCharacterEncoding - フラグ

handle

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

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

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

Specified by:

handle in interface Handler<java.lang.Object,java.lang.Object>

Parameters:

data - 入力データ

context - 実行コンテキスト

Returns:

処理結果データ

resolveRequestEncoding

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

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

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

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

Parameters:

request - リクエスト

Returns:

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

resolveResponseEncoding

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

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

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

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

Parameters:

request - リクエスト

Returns:

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