| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <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.filter;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.util.AntPathMatcher;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.util.PatternMatcher;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.util.StringUtils;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.web.servlet.AdviceFilter;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.web.util.WebUtils;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.slf4j.Logger;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.slf4j.LoggerFactory;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import javax.servlet.Filter;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import javax.servlet.ServletRequest;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import javax.servlet.ServletResponse;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.LinkedHashMap;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.Map;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import static org.apache.shiro.util.StringUtils.split;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <p>Base class for Filters that will process only specified paths and allow all others to pass through.</p><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> *<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * @since 0.9<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>public abstract class PathMatchingFilter extends AdviceFilter implements PathConfigProcessor {<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> /**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Log available to this class only<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private static final Logger log = LoggerFactory.getLogger(PathMatchingFilter.class);<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> * PatternMatcher used in determining which paths to react to for a given request.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> protected PatternMatcher pathMatcher = new AntPathMatcher();<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> * A collection of path-to-config entries where the key is a path which this filter should process and<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * the value is the (possibly null) configuration element specific to this Filter for that specific path.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <p/><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <p>To put it another way, the keys are the paths (urls) that this Filter will process.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * <p>The values are filter-specific data that this Filter should use when processing the corresponding<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * key (path). The values can be null if no Filter-specific config was specified for that url.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> protected Map<String, Object> appliedPaths = new LinkedHashMap<String, Object>();<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> /**<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * Splits any comma-delmited values that might be found in the <code>config</code> argument and sets the resulting<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * <code>String[]</code> array on the <code>appliedPaths</code> internal Map.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * <p/><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * That is:<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <pre><code><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * String[] values = null;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * if (config != null) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * values = split(config);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * }<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * <p/><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * this.{@link #appliedPaths appliedPaths}.put(path, values);<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * </code></pre><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param path the application context path to match for executing this filter.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param config the specified for <em>this particular filter only</em> for the given <code>path</code><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @return this configured filter.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> */<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> public Filter processPathConfig(String path, String config) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> String[] values = null;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> if (config != null) {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> values = split(config);<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> this.appliedPaths.put(path, values);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> return this;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * Returns the context path within the application based on the specified <code>request</code>.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * <p/><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * This implementation merely delegates to<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * {@link WebUtils#getPathWithinApplication(javax.servlet.http.HttpServletRequest) WebUtils.getPathWithinApplication(request)},<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * but can be overridden by subclasses for custom logic.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> *<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @param request the incoming <code>ServletRequest</code><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @return the context path within the application.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> */<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> protected String getPathWithinApplication(ServletRequest request) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> return WebUtils.getPathWithinApplication(WebUtils.toHttp(request));<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> /**<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * Returns <code>true</code> if the incoming <code>request</code> matches the specified <code>path</code> pattern,<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * <code>false</code> otherwise.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * <p/><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * The default implementation acquires the <code>request</code>'s path within the application and determines<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * if that matches:<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * <p/><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * <code>String requestURI = {@link #getPathWithinApplication(javax.servlet.ServletRequest) getPathWithinApplication(request)};<br/><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * return {@link #pathsMatch(String, String) pathsMatch(path,requestURI)}</code><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> *<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param path the configured url pattern to check the incoming request against.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param request the incoming ServletRequest<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @return <code>true</code> if the incoming <code>request</code> matches the specified <code>path</code> pattern,<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * <code>false</code> otherwise.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> protected boolean pathsMatch(String path, ServletRequest request) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> String requestURI = getPathWithinApplication(request);<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> log.trace("Attempting to match pattern '{}' with current requestURI '{}'...", path, requestURI);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return pathsMatch(path, requestURI);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> /**<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * Returns <code>true</code> if the <code>path</code> matches the specified <code>pattern</code> string,<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * <code>false</code> otherwise.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * <p/><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * Simply delegates to<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * <b><code>this.pathMatcher.{@link PatternMatcher#matches(String, String) matches(pattern,path)}</code></b>,<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * but can be overridden by subclasses for custom matching behavior.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> *<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * @param pattern the pattern to match against<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @param path the value to match with the specified <code>pattern</code><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @return <code>true</code> if the <code>path</code> matches the specified <code>pattern</code> string,<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * <code>false</code> otherwise.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> */<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> protected boolean pathsMatch(String pattern, String path) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> return pathMatcher.matches(pattern, path);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> /**<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * Implementation that handles path-matching behavior before a request is evaluated. If the path matches and<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * the filter<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String, Object) isEnabled} for<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * that path/config, the request will be allowed through via the result from<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * {@link #onPreHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) onPreHandle}. If the<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * path does not match or the filter is not enabled for that path, this filter will allow passthrough immediately<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * to allow the {@code FilterChain} to continue executing.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * <p/><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * In order to retain path-matching functionality, subclasses should not override this method if at all<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * possible, and instead override<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * {@link #onPreHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) onPreHandle} instead.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> *<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @param request the incoming ServletRequest<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @param response the outgoing ServletResponse<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @return {@code true} if the filter chain is allowed to continue to execute, {@code false} if a subclass has<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * handled the request explicitly.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @throws Exception if an error occurs<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> */<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> protected boolean preHandle(ServletRequest request, ServletResponse response) throws Exception {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> if (this.appliedPaths == null || this.appliedPaths.isEmpty()) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> if (log.isTraceEnabled()) {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> log.trace("appliedPaths property is null or empty. This Filter will passthrough immediately.");<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> }<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> return true;<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> for (String path : this.appliedPaths.keySet()) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> // If the path does match, then pass on to the subclass implementation for specific checks<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> //(first match 'wins'):<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> if (pathsMatch(path, request)) {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> log.trace("Current requestURI matches pattern '{}'. Determining filter chain execution...", path);<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> Object config = this.appliedPaths.get(path);<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return isFilterChainContinued(request, response, path, config);<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> //no path matched, allow the request to go through:<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> return true;<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> /**<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * Simple method to abstract out logic from the preHandle implementation - it was getting a bit unruly.<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> *<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @since 1.2<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> */<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> @SuppressWarnings({"JavaDoc"})<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> private boolean isFilterChainContinued(ServletRequest request, ServletResponse response,<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> String path, Object pathConfig) throws Exception {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> if (isEnabled(request, response, path, pathConfig)) { //isEnabled check added in 1.2<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> if (log.isTraceEnabled()) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> log.trace("Filter '{}' is enabled for the current request under path '{}' with config [{}]. " +<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> "Delegating to subclass implementation for 'onPreHandle' check.",<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> new Object[]{getName(), path, pathConfig});<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> //The filter is enabled for this specific request, so delegate to subclass implementations<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> //so they can decide if the request should continue through the chain or not:<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> return onPreHandle(request, response, pathConfig);<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> if (log.isTraceEnabled()) {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> log.trace("Filter '{}' is disabled for the current request under path '{}' with config [{}]. " +<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> "The next element in the FilterChain will be called immediately.",<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> new Object[]{getName(), path, pathConfig});<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> }<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> //This filter is disabled for this specific request,<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> //return 'true' immediately to indicate that the filter will not process the request<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> //and let the request/response to continue through the filter chain:<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> return true;<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span><a name="line.216"></a> |
| <span class="sourceLineNo">217</span> /**<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * This default implementation always returns {@code true} and should be overridden by subclasses for custom<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * logic if necessary.<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> *<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * @param request the incoming ServletRequest<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * @param response the outgoing ServletResponse<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings.<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * @return {@code true} if the request should be able to continue, {@code false} if the filter will<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * handle the response directly.<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * @throws Exception if an error occurs<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * @see #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String, Object)<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> */<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> protected boolean onPreHandle(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception {<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> return true;<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> }<a name="line.231"></a> |
| <span class="sourceLineNo">232</span><a name="line.232"></a> |
| <span class="sourceLineNo">233</span> /**<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * Path-matching version of the parent class's<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method, but additionally allows<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * for inspection of any path-specific configuration values corresponding to the specified request. Subclasses<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * may wish to inspect this additional mapped configuration to determine if the filter is enabled or not.<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * <p/><a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * This method's default implementation ignores the {@code path} and {@code mappedValue} arguments and merely<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * returns the value from a call to {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)}.<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * It is expected that subclasses override this method if they need to perform enable/disable logic for a specific<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * request based on any path-specific config for the filter instance.<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> *<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * @param request the incoming servlet request<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @param response the outbound servlet response<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * @param path the path matched for the incoming servlet request that has been configured with the given {@code mappedValue}.<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings for the given {@code path}.<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * @return {@code true} if this filter should filter the specified request, {@code false} if it should let the<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * request/response pass through immediately to the next element in the {@code FilterChain}.<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * @throws Exception in the case of any error<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * @since 1.2<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> */<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> @SuppressWarnings({"UnusedParameters"})<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> protected boolean isEnabled(ServletRequest request, ServletResponse response, String path, Object mappedValue)<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> throws Exception {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> return isEnabled(request, response);<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> }<a name="line.257"></a> |
| <span class="sourceLineNo">258</span>}<a name="line.258"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
