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