View Javadoc
1   /*
2    * Copyright (c) 2002-2022, City of 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   * Encoding filter
47   */
48  public class EncodingFilter implements javax.servlet.Filter
49  {
50      private static final String REQUEST_ENCODING = "UTF-8";
51  
52      /**
53       * Initializes the filter
54       * 
55       * @param filterConfig
56       *            The filter config
57       * @throws ServletException
58       *             If an error occured
59       */
60      public void init( FilterConfig filterConfig ) throws ServletException
61      {
62          // This would be a good place to collect a parameterized
63          // default encoding type. For brevity, we're going to
64          // use a hard-coded value in this example.
65      }
66  
67      /**
68       * Apply the filter
69       * 
70       * @param request
71       *            The HTTP request
72       * @param response
73       *            The HTTP response
74       * @param filterChain
75       *            The Filter Chain
76       * @throws IOException
77       *             If an error occured
78       * @throws ServletException
79       *             If an error occured
80       */
81      public void doFilter( ServletRequest request, ServletResponse response, FilterChain filterChain ) throws IOException, ServletException
82      {
83          // Wrap the response object. You should create a mechanism
84          // to ensure the response object only gets wrapped once.
85          // In this example, the response object will inappropriately
86          // get wrapped multiple times during a forward.
87          response = new EncodingServletResponse( (HttpServletResponse) response );
88  
89          // Specify the encoding to assume for the request so
90          // the parameters can be properly decoded/.
91          request.setCharacterEncoding( REQUEST_ENCODING );
92  
93          filterChain.doFilter( request, response );
94      }
95  
96      /**
97       * Destroy the filter
98       */
99      public void destroy( )
100     {
101         // no-op
102     }
103 }