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 javax.servlet.http.HttpServletResponse;
37
38
39 /**
40 * This class provides a Wrapper of an Http response that manage a correct UTF-8 encoding
41 *
42 */
43 public class EncodingServletResponse extends javax.servlet.http.HttpServletResponseWrapper
44 {
45 private static final String RESPONSE_ENCODING = "UTF-8";
46 private boolean _bEncodingSpecified;
47
48 /**
49 * Constructor
50 * @param response The HTTP response
51 */
52 public EncodingServletResponse( HttpServletResponse response )
53 {
54 super( response );
55 }
56
57 /**
58 * Sets the content type
59 * @param type The content type
60 */
61 public void setContentType( String type )
62 {
63 String explicitType = type;
64
65 // If a specific encoding has not already been set by the app,
66 // let's see if this is a call to specify it. If the content
67 // type doesn't explicitly set an encoding, make it UTF-8.
68 if ( !_bEncodingSpecified )
69 {
70 String lowerType = type.toLowerCase( );
71
72 // See if this is a call to explicitly set the character encoding.
73 if ( lowerType.indexOf( "charset" ) < 0 )
74 {
75 // If no character encoding is specified, we still need to
76 // ensure the app is specifying text content.
77 if ( lowerType.startsWith( "text/" ) )
78 {
79 // App is sending a text response, but no encoding
80 // is specified, so we'll force it to UTF-8.
81 explicitType = type + "; charset=" + RESPONSE_ENCODING;
82 }
83 }
84 else
85 {
86 // App picked a specific encoding, so let's make
87 // sure we don't override it.
88 _bEncodingSpecified = true;
89 }
90 }
91
92 // Delegate to supertype to record encoding.
93 super.setContentType( explicitType );
94 }
95 }