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