| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="fr"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.shiro.web.servlet;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.slf4j.Logger;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.slf4j.LoggerFactory;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import javax.servlet.FilterChain;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import javax.servlet.ServletException;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import javax.servlet.ServletRequest;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import javax.servlet.ServletResponse;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.io.IOException;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Filter base class that guarantees to be just executed once per request,<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * on any servlet container. It provides a {@link #doFilterInternal}<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * method with HttpServletRequest and HttpServletResponse arguments.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <p/><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * The {@link #getAlreadyFilteredAttributeName} method determines how<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * to identify that a request is already filtered. The default implementation<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * is based on the configured name of the concrete filter instance.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <h3>Controlling filter execution</h3><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * 1.2 introduced the {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method and<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * {@link #isEnabled()} property to allow explicit controll over whether the filter executes (or allows passthrough)<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * for any given request.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <p/><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <b>NOTE</b> This class was initially borrowed from the Spring framework but has continued modifications.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> *<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @since 0.1<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>public abstract class OncePerRequestFilter extends NameableFilter {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> /**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * Private internal log instance.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> private static final Logger log = LoggerFactory.getLogger(OncePerRequestFilter.class);<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Suffix that gets appended to the filter name for the "already filtered" request attribute.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> *<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @see #getAlreadyFilteredAttributeName<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> public static final String ALREADY_FILTERED_SUFFIX = ".FILTERED";<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Determines generally if this filter should execute or let requests fall through to the next chain element.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> *<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @see #isEnabled()<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> private boolean enabled = true; //most filters wish to execute when configured, so default to true<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /**<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * Returns {@code true} if this filter should <em>generally</em><b>*</b> execute for any request,<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * {@code false} if it should let the request/response pass through immediately to the next<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * element in the {@link FilterChain}. The default value is {@code true}, as most filters would inherently need<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * to execute when configured.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <p/><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * <b>*</b> This configuration property is for general configuration for any request that comes through<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * the filter. The<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse) isEnabled(request,response)}<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * method actually determines whether or not if the filter is enabled based on the current request.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @return {@code true} if this filter should <em>generally</em> execute, {@code false} if it should let the<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * request/response pass through immediately to the next element in the {@link FilterChain}.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @since 1.2<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> public boolean isEnabled() {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> return enabled;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Sets whether or not this filter <em>generally</em> executes for any request. See the<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * {@link #isEnabled() isEnabled()} JavaDoc as to what <em>general</em> execution means.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> *<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param enabled whether or not this filter <em>generally</em> executes.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @since 1.2<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public void setEnabled(boolean enabled) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> this.enabled = enabled;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> /**<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * This {@code doFilter} implementation stores a request attribute for<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * "already filtered", proceeding without filtering again if the<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * attribute is already there.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> *<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @see #getAlreadyFilteredAttributeName<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @see #shouldNotFilter<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @see #doFilterInternal<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> */<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> public final void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain)<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> throws ServletException, IOException {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> String alreadyFilteredAttributeName = getAlreadyFilteredAttributeName();<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> if ( request.getAttribute(alreadyFilteredAttributeName) != null ) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> log.trace("Filter '{}' already executed. Proceeding without invoking this filter.", getName());<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> filterChain.doFilter(request, response);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> } else //noinspection deprecation<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> if (/* added in 1.2: */ !isEnabled(request, response) ||<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> /* retain backwards compatibility: */ shouldNotFilter(request) ) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> log.debug("Filter '{}' is not enabled for the current request. Proceeding without invoking this filter.",<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> getName());<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> filterChain.doFilter(request, response);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> } else {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> // Do invoke this filter...<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> log.trace("Filter '{}' not yet executed. Executing now.", getName());<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> request.setAttribute(alreadyFilteredAttributeName, Boolean.TRUE);<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> try {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> doFilterInternal(request, response, filterChain);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> } finally {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> // Once the request has finished, we're done and we don't<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> // need to mark as 'already filtered' any more.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> request.removeAttribute(alreadyFilteredAttributeName);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> }<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> }<a name="line.132"></a> |
| <span class="sourceLineNo">133</span><a name="line.133"></a> |
| <span class="sourceLineNo">134</span> /**<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * Returns {@code true} if this filter should filter the specified request, {@code false} if it should let the<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * request/response pass through immediately to the next element in the {@code FilterChain}.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * <p/><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * This default implementation merely returns the value of {@link #isEnabled() isEnabled()}, which is<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * {@code true} by default (to ensure the filter always executes by default), but it can be overridden by<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * subclasses for request-specific behavior if necessary. For example, a filter could be enabled or disabled<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * based on the request path being accessed.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * <p/><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * <b>Helpful Hint:</b> if your subclass extends {@link org.apache.shiro.web.filter.PathMatchingFilter PathMatchingFilter},<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * you may wish to instead override the<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * {@link org.apache.shiro.web.filter.PathMatchingFilter#isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String, Object)<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * PathMatchingFilter.isEnabled(request,response,path,pathSpecificConfig)}<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * method if you want to make your enable/disable decision based on any path-specific configuration.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> *<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @param request the incoming servlet request<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @param response the outbound servlet response<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @return {@code true} if this filter should filter the specified request, {@code false} if it should let the<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * request/response pass through immediately to the next element in the {@code FilterChain}.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * @throws IOException in the case of any IO error<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @throws ServletException in the case of any error<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @see org.apache.shiro.web.filter.PathMatchingFilter#isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String, Object)<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @since 1.2<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> */<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> @SuppressWarnings({"UnusedParameters"})<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> protected boolean isEnabled(ServletRequest request, ServletResponse response) throws ServletException, IOException {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> return isEnabled();<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> /**<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * Return name of the request attribute that identifies that a request has already been filtered.<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * <p/><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * The default implementation takes the configured {@link #getName() name} and appends &quot;{@code .FILTERED}&quot;.<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * If the filter is not fully initialized, it falls back to the implementation's class name.<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> *<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @return the name of the request attribute that identifies that a request has already been filtered.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @see #getName<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * @see #ALREADY_FILTERED_SUFFIX<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> */<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> protected String getAlreadyFilteredAttributeName() {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> String name = getName();<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> if (name == null) {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> name = getClass().getName();<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return name + ALREADY_FILTERED_SUFFIX;<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> /**<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * Can be overridden in subclasses for custom filtering control,<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * returning <code>true</code> to avoid filtering of the given request.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * <p>The default implementation always returns <code>false</code>.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> *<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * @param request current HTTP request<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * @return whether the given request should <i>not</i> be filtered<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @throws ServletException in case of errors<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @deprecated in favor of overriding {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)}<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * for custom behavior. This method will be removed in Shiro 2.0.<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> */<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> @Deprecated<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> protected boolean shouldNotFilter(ServletRequest request) throws ServletException {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> return false;<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span><a name="line.197"></a> |
| <span class="sourceLineNo">198</span><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> /**<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * Same contract as for<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * {@link #doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)},<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * but guaranteed to be invoked only once per request.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> *<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * @param request incoming {@code ServletRequest}<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * @param response outgoing {@code ServletResponse}<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * @param chain the {@code FilterChain} to execute<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * @throws ServletException if there is a problem processing the request<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @throws IOException if there is an I/O problem processing the request<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> */<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> protected abstract void doFilterInternal(ServletRequest request, ServletResponse response, FilterChain chain)<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> throws ServletException, IOException;<a name="line.211"></a> |
| <span class="sourceLineNo">212</span>}<a name="line.212"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
