CharacterEncodingFilter (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.filter.GenericFilterBean
- - org.springframework.web.filter.OncePerRequestFilter
  - - org.springframework.web.filter.CharacterEncodingFilter

実装されたすべてのインターフェース:
FilterEE, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, EnvironmentCapable, ServletContextAware
```
public class CharacterEncodingFilter
extends OncePerRequestFilter
```
リクエストの文字エンコードを指定できるサーブレットフィルター。これは、現在のブラウザーは通常、HTML ページまたはフォームで指定されていても文字エンコードを設定しないため便利です。
このフィルターは、リクエストでエンコードが指定されていない場合にエンコードを適用するか、いずれにしてもこのフィルターのエンコードを適用できます（"forceEncoding" ="true" ）。後者の場合、エンコードはデフォルトのレスポンスエンコードとしても適用されます（ただし、これは通常、ビューで設定された完全なコンテンツ型によってオーバーライドされます）。
導入:
15.03.2004
作成者:
Juergen Hoeller
関連事項:
setEncoding(java.lang.String), setForceEncoding(boolean), ServletRequest.setCharacterEncoding(java.lang.String)EE, ServletResponse.setCharacterEncoding(java.lang.String)EE

フィールドサマリー
- クラス org.springframework.web.filter.OncePerRequestFilter から継承されたフィールド
  ALREADY_FILTERED_SUFFIX
- クラス org.springframework.web.filter.GenericFilterBean から継承されたフィールド
  logger

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

コンストラクター
コンストラクターと説明
`CharacterEncodingFilter()` デフォルトの `CharacterEncodingFilter` を作成し、エンコーディングを `setEncoding(java.lang.String)` で設定します。
`CharacterEncodingFilter(StringSE encoding)` 指定されたエンコーディングの `CharacterEncodingFilter` を作成します。
`CharacterEncodingFilter(StringSE encoding, boolean forceEncoding)` 指定されたエンコーディングの `CharacterEncodingFilter` を作成します。
`CharacterEncodingFilter(StringSE encoding, boolean forceRequestEncoding, boolean forceResponseEncoding)` 指定されたエンコーディングの `CharacterEncodingFilter` を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`doFilterInternal(HttpServletRequestEE request, HttpServletResponseEE response, FilterChainEE filterChain)` `doFilter` と同じ契約ですが、単一のリクエストスレッド内のリクエストごとに 1 回だけ呼び出されることが保証されています。
`StringSE`	`getEncoding()` リクエストまたはレスポンス、あるいはその両方に構成されたエンコードを返します。
`boolean`	`isForceRequestEncoding()` エンコードをリクエストで強制する必要があるかどうかを返します。
`boolean`	`isForceResponseEncoding()` レスポンスでエンコードを強制する必要があるかどうかを返します。
`void`	`setEncoding(StringSE encoding)` リクエストに使用するエンコーディングを設定します。
`void`	`setForceEncoding(boolean forceEncoding)` このフィルターの構成済み `encoding` が既存のリクエストおよびレスポンスエンコードをオーバーライドすることになっているかどうかを設定します。
`void`	`setForceRequestEncoding(boolean forceRequestEncoding)` このフィルターの構成済み `encoding` が既存のリクエストエンコードをオーバーライドすることになっているかどうかを設定します。
`void`	`setForceResponseEncoding(boolean forceResponseEncoding)` このフィルターの構成済み `encoding` が既存のレスポンスエンコードをオーバーライドすることになっているかどうかを設定します。

クラス org.springframework.web.filter.OncePerRequestFilter から継承されたメソッド
doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

クラス org.springframework.web.filter.GenericFilterBean から継承されたメソッド
addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - CharacterEncodingFilter
```
public CharacterEncodingFilter()
```
    デフォルトの CharacterEncodingFilter を作成し、エンコーディングを setEncoding(java.lang.String) で設定します。
    関連事項:
    setEncoding(java.lang.String)
  - CharacterEncodingFilter
```
public CharacterEncodingFilter(StringSE encoding)
```
    指定されたエンコーディングの CharacterEncodingFilter を作成します。
    パラメーター:
    encoding - 適用するエンコーディング
    導入:
    4.2.3
    関連事項:
    setEncoding(java.lang.String)
  - CharacterEncodingFilter
```
public CharacterEncodingFilter(StringSE encoding,
                               boolean forceEncoding)
```
    指定されたエンコーディングの CharacterEncodingFilter を作成します。
    パラメーター:
    encoding - 適用するエンコーディング
    forceEncoding - 指定されたエンコーディングが既存のリクエストおよびレスポンスエンコーディングをオーバーライドすることになっているかどうか
    導入:
    4.2.3
    関連事項:
    setEncoding(java.lang.String), setForceEncoding(boolean)
  - CharacterEncodingFilter
```
public CharacterEncodingFilter(StringSE encoding,
                               boolean forceRequestEncoding,
                               boolean forceResponseEncoding)
```
    指定されたエンコーディングの CharacterEncodingFilter を作成します。
    パラメーター:
    encoding - 適用するエンコーディング
    forceRequestEncoding - 指定されたエンコーディングが既存のリクエストエンコーディングをオーバーライドすることになっているかどうか
    forceResponseEncoding - 指定されたエンコーディングが既存のレスポンスエンコーディングをオーバーライドすることになっているかどうか
    導入:
    4.3
    関連事項:
    setEncoding(java.lang.String), setForceRequestEncoding(boolean), setForceResponseEncoding(boolean)
- メソッドの詳細
  - setEncoding
```
public void setEncoding(@Nullable
                        StringSE encoding)
```
    リクエストに使用するエンコーディングを設定します。このエンコードは、ServletRequest.setCharacterEncoding(java.lang.String)EE 呼び出しに渡されます。
    このエンコードが既存のリクエストエンコードをオーバーライドするかどうか（およびデフォルトのレスポンスエンコードとしても適用されるかどうか）は、"forceEncoding" フラグに依存します。
  - getEncoding
```
@Nullable
public StringSE getEncoding()
```
    リクエストまたはレスポンス、あるいはその両方に構成されたエンコードを返します。
    導入:
    4.3
  - setForceEncoding
```
public void setForceEncoding(boolean forceEncoding)
```
    このフィルターの構成済み encoding が既存のリクエストおよびレスポンスエンコードをオーバーライドすることになっているかどうかを設定します。
    デフォルトは "false" です。つまり、ServletRequest.getCharacterEncoding()EE が null 以外の値を返す場合、エンコードを変更しません。これを "true" に切り替えて、指定されたエンコーディングを強制し、デフォルトのレスポンスエンコーディングとしても適用します。
    これは、setForceRequestEncoding(boolean) と setForceResponseEncoding(boolean) の両方を設定することと同等です。
    関連事項:
    setForceRequestEncoding(boolean), setForceResponseEncoding(boolean)
  - setForceRequestEncoding
```
public void setForceRequestEncoding(boolean forceRequestEncoding)
```
    このフィルターの構成済み encoding が既存のリクエストエンコードをオーバーライドすることになっているかどうかを設定します。
    デフォルトは "false" です。つまり、ServletRequest.getCharacterEncoding()EE が null 以外の値を返す場合は、エンコーディングを変更しません。これを "true" に切り替えて、指定されたエンコーディングを強制します。
    導入:
    4.3
  - isForceRequestEncoding
```
public boolean isForceRequestEncoding()
```
    エンコードをリクエストで強制する必要があるかどうかを返します。
    導入:
    4.3
  - setForceResponseEncoding
```
public void setForceResponseEncoding(boolean forceResponseEncoding)
```
    このフィルターの構成済み encoding が既存のレスポンスエンコードをオーバーライドすることになっているかどうかを設定します。
    デフォルトは "false" です。つまり、エンコードを変更しません。これを "true" に切り替えて、どのような場合でもレスポンスに指定されたエンコーディングを適用します。
    導入:
    4.3
  - isForceResponseEncoding
```
public boolean isForceResponseEncoding()
```
    レスポンスでエンコードを強制する必要があるかどうかを返します。
    導入:
    4.3
  - doFilterInternal
```
protected void doFilterInternal(HttpServletRequestEE request,
                                HttpServletResponseEE response,
                                FilterChainEE filterChain)
                         throws ServletExceptionEE,
                                IOExceptionSE
```
    クラスからコピーされた説明: OncePerRequestFilter
    doFilter と同じ契約ですが、単一のリクエストスレッド内のリクエストごとに 1 回だけ呼び出されることが保証されています。詳細については、OncePerRequestFilter.shouldNotFilterAsyncDispatch() を参照してください。
    デフォルトの ServletRequest および ServletResponse の代わりに、HttpServletRequest および HttpServletResponse 引数を提供します。
    次で指定:
    クラス OncePerRequestFilter の doFilterInternal
    例外:
    ServletExceptionEE
    IOExceptionSE

クラス CharacterEncodingFilter

フィールドサマリー

クラス org.springframework.web.filter.OncePerRequestFilter から継承されたフィールド

クラス org.springframework.web.filter.GenericFilterBean から継承されたフィールド

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

メソッドのサマリー

クラス org.springframework.web.filter.OncePerRequestFilter から継承されたメソッド

クラス org.springframework.web.filter.GenericFilterBean から継承されたメソッド

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

コンストラクターの詳細

CharacterEncodingFilter

CharacterEncodingFilter

CharacterEncodingFilter

CharacterEncodingFilter

メソッドの詳細

setEncoding

getEncoding

setForceEncoding

setForceRequestEncoding

isForceRequestEncoding

setForceResponseEncoding

isForceResponseEncoding

doFilterInternal