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;
35
36 import javax.servlet.ServletConfig;
37 import javax.servlet.http.HttpServletRequest;
38 import javax.servlet.http.HttpServletResponse;
39
40 /**
41 * Tools class to transmit config, request and response servlet parameters using {@link java.lang.ThreadLocal}.
42 */
43 public final class LocalVariables
44 {
45 private static ThreadLocal<ServletConfig> _tlConfig = new ThreadLocal<>( );
46 private static ThreadLocal<HttpServletRequest> _tlRequest = new ThreadLocal<>( );
47 private static ThreadLocal<HttpServletResponse> _tlResponse = new ThreadLocal<>( );
48
49 /**
50 * Utility classes have no constructor
51 */
52 private LocalVariables( )
53 {
54 }
55
56 /**
57 * Initialize thread locals variables
58 *
59 * @param config
60 * Current <code>ServletConfig</code> to associate to the thread
61 * @param request
62 * Current <code>HttpServletRequest</code> to associate to the thread
63 * @param response
64 * Current <code>HttpServletResponse</code> to associate to the thread
65 */
66 public static void setLocal( ServletConfig config, HttpServletRequest request, HttpServletResponse response )
67 {
68 _tlConfig.set( config );
69 _tlRequest.set( request );
70 _tlResponse.set( response );
71 }
72
73 /**
74 * Read <code>ServletConfig</code> associate to the current thread
75 *
76 * @return the <code>ServletConfig</code> associate to the current thread
77 */
78 public static ServletConfig getConfig( )
79 {
80 return _tlConfig.get( );
81 }
82
83 /**
84 * Read <code>HttpServletRequest</code> associate to the current thread
85 *
86 * @return the <code>HttpServletRequest</code> associate to the current thread
87 */
88 public static HttpServletRequest getRequest( )
89 {
90 return _tlRequest.get( );
91 }
92
93 /**
94 * Read <code>HttpServletResponse</code> associate to the current thread
95 *
96 * @return the <code>HttpServletResponse</code> associate to the current thread
97 */
98 public static HttpServletResponse getResponse( )
99 {
100 return _tlResponse.get( );
101 }
102 }