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.service.filter;
35  
36  import java.io.IOException;
37  
38  import javax.servlet.FilterChain;
39  import javax.servlet.ServletException;
40  import javax.servlet.ServletRequest;
41  import javax.servlet.ServletResponse;
42  
43  /**
44   * Lutece filter chain This is a fake filter chain used by LuteceMainFilter to simulate a chain for plugins filters
45   */
46  public class LuteceFilterChain implements FilterChain
47  {
48      private boolean _bFollowChain;
49      private ServletRequest _request;
50      private ServletResponse _response;
51  
52      /**
53       * Initialize the follow chain flag (does the filter called "chain.doFilter")
54       * 
55       * @param bFollowChain
56       *            The follow chain flag
57       */
58      public void setFollowChain( boolean bFollowChain )
59      {
60          _bFollowChain = bFollowChain;
61      }
62  
63      /**
64       * Returns the follow chain flag
65       * 
66       * @return The follow chain flag
67       */
68      public boolean shouldFollowChain( )
69      {
70          return _bFollowChain;
71      }
72  
73      /**
74       * Returns the request used by {@link #doFilter(ServletRequest, ServletResponse)}
75       * 
76       * @return the request
77       * @since 2.5
78       */
79      public ServletRequest getRequest( )
80      {
81          return _request;
82      }
83  
84      /**
85       * Sets the request used by {@link #doFilter(ServletRequest, ServletResponse)}
86       * 
87       * @param request
88       *            the request
89       * @since 2.5
90       */
91      public void setRequest( ServletRequest request )
92      {
93          _request = request;
94      }
95  
96      /**
97       * Returns the response used by {@link #doFilter(ServletRequest, ServletResponse)}
98       * 
99       * @return the response
100      * @since 2.5
101      */
102     public ServletResponse getResponse( )
103     {
104         return _response;
105     }
106 
107     /**
108      * Sets the response used by {@link #doFilter(ServletRequest, ServletResponse)}
109      * 
110      * @param response
111      *            the response
112      * @since 2.5
113      */
114     public void setResponse( ServletResponse response )
115     {
116         _response = response;
117     }
118 
119     /**
120      * {@inheritDoc }
121      */
122     public void doFilter( ServletRequest request, ServletResponse response ) throws IOException, ServletException
123     {
124         // Do nothing and set the follow chain flag to true
125         setFollowChain( true );
126         // Set request and response, eventually wrapped during filter process.
127         setRequest( request );
128         setResponse( response );
129     }
130 }