public class SetCharacterEncodingFilter extends FilterBase
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 "false".Although this filter can be used unchanged, it is also easy to
subclass it and make the selectEncoding()
method more
intelligent about what encoding to choose, based on characteristics of
the incoming request (such as the values of the Accept-Language
and User-Agent
headers, or a value stashed in the current
user's session.
sm
Constructor and Description |
---|
SetCharacterEncodingFilter() |
Modifier and Type | Method and Description |
---|---|
void |
doFilter(ServletRequest request,
ServletResponse response,
FilterChain chain)
Select and set (if specified) the character encoding to be used to
interpret request parameters for this request.
|
java.lang.String |
getEncoding() |
protected Log |
getLogger() |
boolean |
isIgnore() |
protected java.lang.String |
selectEncoding(ServletRequest request)
Select an appropriate character encoding to be used, based on the
characteristics of the current request and/or filter initialization
parameters.
|
void |
setEncoding(java.lang.String encoding) |
void |
setIgnore(boolean ignore) |
destroy, init, isConfigProblemFatal
public void setEncoding(java.lang.String encoding)
public java.lang.String getEncoding()
public void setIgnore(boolean ignore)
public boolean isIgnore()
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException
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 occursServletException
- if a servlet error occursprotected Log getLogger()
getLogger
in class FilterBase
protected java.lang.String selectEncoding(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 processingCopyright © 2000-2018 Apache Software Foundation. All Rights Reserved.