1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.web.encoding;
35
36 import java.io.IOException;
37
38 import javax.servlet.FilterChain;
39 import javax.servlet.FilterConfig;
40 import javax.servlet.ServletException;
41 import javax.servlet.ServletRequest;
42 import javax.servlet.ServletResponse;
43 import javax.servlet.http.HttpServletResponse;
44
45
46 /**
47 * Encoding filter
48 */
49 public class EncodingFilter implements javax.servlet.Filter
50 {
51 private static final String REQUEST_ENCODING = "UTF-8";
52
53 /**
54 * Initializes the filter
55 * @param filterConfig The filter config
56 * @throws ServletException If an error occured
57 */
58 public void init( FilterConfig filterConfig ) throws ServletException
59 {
60 // This would be a good place to collect a parameterized
61 // default encoding type. For brevity, we're going to
62 // use a hard-coded value in this example.
63 }
64
65 /**
66 * Apply the filter
67 * @param request The HTTP request
68 * @param response The HTTP response
69 * @param filterChain The Filter Chain
70 * @throws IOException If an error occured
71 * @throws ServletException If an error occured
72 */
73 public void doFilter( ServletRequest request, ServletResponse response, FilterChain filterChain )
74 throws IOException, ServletException
75 {
76 // Wrap the response object. You should create a mechanism
77 // to ensure the response object only gets wrapped once.
78 // In this example, the response object will inappropriately
79 // get wrapped multiple times during a forward.
80 response = new EncodingServletResponse( (HttpServletResponse) response );
81
82 // Specify the encoding to assume for the request so
83 // the parameters can be properly decoded/.
84 request.setCharacterEncoding( REQUEST_ENCODING );
85
86 filterChain.doFilter( request, response );
87 }
88
89 /**
90 * Destroy the filter
91 */
92 public void destroy( )
93 {
94 // no-op
95 }
96 }