public class SetCharacterEncodingFilter
extends java.lang.Object
implements javax.servlet.Filter
Example filter that sets the character encoding to be used in parsing the incoming request, either unconditionally or only if the client did not specify a character encoding. Configuration of this filter is based on the following initialization parameters:
ignore
initialization parameter. This parameter
is required, so there is no default.selectEncoding()
method is set. If set to "false,
selectEncoding()
is called only if the
client has not already specified an encoding. By default, this
parameter is set to "true".Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
encoding
The default character encoding to set for requests that pass through
this filter.
|
protected javax.servlet.FilterConfig |
filterConfig
The filter configuration object we are associated with.
|
Constructor and Description |
---|
SetCharacterEncodingFilter() |
Modifier and Type | Method and Description |
---|---|
void |
destroy()
Take this filter out of service.
|
void |
doFilter(javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response,
javax.servlet.FilterChain chain)
Select and set (if specified) the character encoding to be used to
interpret request parameters for this request.
|
void |
init(javax.servlet.FilterConfig filterConfigIn) |
protected java.lang.String |
selectEncoding(javax.servlet.ServletRequest request)
Select an appropriate character encoding to be used, based on the
characteristics of the current request and/or filter initialization
parameters.
|
protected java.lang.String encoding
protected javax.servlet.FilterConfig filterConfig
public void destroy()
destroy
in interface javax.servlet.Filter
public void doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) throws java.io.IOException, javax.servlet.ServletException
doFilter
in interface javax.servlet.Filter
request
- The servlet request we are processingresponse
- The servlet response we are creatingchain
- The filter chain we are processingjava.io.IOException
- if an input/output error occursjavax.servlet.ServletException
- if a servlet error occurspublic void init(javax.servlet.FilterConfig filterConfigIn) throws javax.servlet.ServletException
init
in interface javax.servlet.Filter
javax.servlet.ServletException
protected java.lang.String selectEncoding(javax.servlet.ServletRequest request)
null
.
The default implementation unconditionally returns the value configured by the encoding initialization parameter for this filter.
request
- The servlet request we are processing