|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.web.SetCharacterEncodingFilter
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".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.
Field Summary | |
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. |
protected boolean |
ignore
Should a character encoding specified by the client be ignored? |
Constructor Summary | |
SetCharacterEncodingFilter()
|
Method Summary | |
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 filterConfig)
Place this filter into service. |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.lang.String encoding
protected javax.servlet.FilterConfig filterConfig
protected boolean ignore
Constructor Detail |
public SetCharacterEncodingFilter()
Method Detail |
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 processingchain
- The filter chain we are processing
java.io.IOException
- if an input/output error occurs
javax.servlet.ServletException
- if a servlet error occurspublic void init(javax.servlet.FilterConfig filterConfig) throws javax.servlet.ServletException
init
in interface javax.servlet.Filter
filterConfig
- The filter configuration object
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |