| <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.filter.mgt;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.util.AntPathMatcher;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.util.PatternMatcher;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.web.util.WebUtils;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.slf4j.Logger;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.slf4j.LoggerFactory;<a name="line.25"></a> |
| <FONT color="green">026</FONT> <a name="line.26"></a> |
| <FONT color="green">027</FONT> import javax.servlet.FilterChain;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import javax.servlet.FilterConfig;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import javax.servlet.ServletRequest;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import javax.servlet.ServletResponse;<a name="line.30"></a> |
| <FONT color="green">031</FONT> <a name="line.31"></a> |
| <FONT color="green">032</FONT> /**<a name="line.32"></a> |
| <FONT color="green">033</FONT> * A {@code FilterChainResolver} that resolves {@link FilterChain}s based on url path<a name="line.33"></a> |
| <FONT color="green">034</FONT> * matching, as determined by a configurable {@link #setPathMatcher(org.apache.shiro.util.PatternMatcher) PathMatcher}.<a name="line.34"></a> |
| <FONT color="green">035</FONT> * <p/><a name="line.35"></a> |
| <FONT color="green">036</FONT> * This implementation functions by consulting a {@link org.apache.shiro.web.filter.mgt.FilterChainManager} for all configured filter chains (keyed<a name="line.36"></a> |
| <FONT color="green">037</FONT> * by configured path pattern). If an incoming Request path matches one of the configured path patterns (via<a name="line.37"></a> |
| <FONT color="green">038</FONT> * the {@code PathMatcher}, the corresponding configured {@code FilterChain} is returned.<a name="line.38"></a> |
| <FONT color="green">039</FONT> *<a name="line.39"></a> |
| <FONT color="green">040</FONT> * @since 1.0<a name="line.40"></a> |
| <FONT color="green">041</FONT> */<a name="line.41"></a> |
| <FONT color="green">042</FONT> public class PathMatchingFilterChainResolver implements FilterChainResolver {<a name="line.42"></a> |
| <FONT color="green">043</FONT> <a name="line.43"></a> |
| <FONT color="green">044</FONT> private static transient final Logger log = LoggerFactory.getLogger(PathMatchingFilterChainResolver.class);<a name="line.44"></a> |
| <FONT color="green">045</FONT> <a name="line.45"></a> |
| <FONT color="green">046</FONT> private FilterChainManager filterChainManager;<a name="line.46"></a> |
| <FONT color="green">047</FONT> <a name="line.47"></a> |
| <FONT color="green">048</FONT> private PatternMatcher pathMatcher;<a name="line.48"></a> |
| <FONT color="green">049</FONT> <a name="line.49"></a> |
| <FONT color="green">050</FONT> public PathMatchingFilterChainResolver() {<a name="line.50"></a> |
| <FONT color="green">051</FONT> this.pathMatcher = new AntPathMatcher();<a name="line.51"></a> |
| <FONT color="green">052</FONT> this.filterChainManager = new DefaultFilterChainManager();<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> public PathMatchingFilterChainResolver(FilterConfig filterConfig) {<a name="line.55"></a> |
| <FONT color="green">056</FONT> this.pathMatcher = new AntPathMatcher();<a name="line.56"></a> |
| <FONT color="green">057</FONT> this.filterChainManager = new DefaultFilterChainManager(filterConfig);<a name="line.57"></a> |
| <FONT color="green">058</FONT> }<a name="line.58"></a> |
| <FONT color="green">059</FONT> <a name="line.59"></a> |
| <FONT color="green">060</FONT> /**<a name="line.60"></a> |
| <FONT color="green">061</FONT> * Returns the {@code PatternMatcher} used when determining if an incoming request's path<a name="line.61"></a> |
| <FONT color="green">062</FONT> * matches a configured filter chain. Unless overridden, the<a name="line.62"></a> |
| <FONT color="green">063</FONT> * default implementation is an {@link org.apache.shiro.util.AntPathMatcher AntPathMatcher}.<a name="line.63"></a> |
| <FONT color="green">064</FONT> *<a name="line.64"></a> |
| <FONT color="green">065</FONT> * @return the {@code PatternMatcher} used when determining if an incoming request's path<a name="line.65"></a> |
| <FONT color="green">066</FONT> * matches a configured filter chain.<a name="line.66"></a> |
| <FONT color="green">067</FONT> */<a name="line.67"></a> |
| <FONT color="green">068</FONT> public PatternMatcher getPathMatcher() {<a name="line.68"></a> |
| <FONT color="green">069</FONT> return pathMatcher;<a name="line.69"></a> |
| <FONT color="green">070</FONT> }<a name="line.70"></a> |
| <FONT color="green">071</FONT> <a name="line.71"></a> |
| <FONT color="green">072</FONT> /**<a name="line.72"></a> |
| <FONT color="green">073</FONT> * Sets the {@code PatternMatcher} used when determining if an incoming request's path<a name="line.73"></a> |
| <FONT color="green">074</FONT> * matches a configured filter chain. Unless overridden, the<a name="line.74"></a> |
| <FONT color="green">075</FONT> * default implementation is an {@link org.apache.shiro.util.AntPathMatcher AntPathMatcher}.<a name="line.75"></a> |
| <FONT color="green">076</FONT> *<a name="line.76"></a> |
| <FONT color="green">077</FONT> * @param pathMatcher the {@code PatternMatcher} used when determining if an incoming request's path<a name="line.77"></a> |
| <FONT color="green">078</FONT> * matches a configured filter chain.<a name="line.78"></a> |
| <FONT color="green">079</FONT> */<a name="line.79"></a> |
| <FONT color="green">080</FONT> public void setPathMatcher(PatternMatcher pathMatcher) {<a name="line.80"></a> |
| <FONT color="green">081</FONT> this.pathMatcher = pathMatcher;<a name="line.81"></a> |
| <FONT color="green">082</FONT> }<a name="line.82"></a> |
| <FONT color="green">083</FONT> <a name="line.83"></a> |
| <FONT color="green">084</FONT> public FilterChainManager getFilterChainManager() {<a name="line.84"></a> |
| <FONT color="green">085</FONT> return filterChainManager;<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> @SuppressWarnings({"UnusedDeclaration"})<a name="line.88"></a> |
| <FONT color="green">089</FONT> public void setFilterChainManager(FilterChainManager filterChainManager) {<a name="line.89"></a> |
| <FONT color="green">090</FONT> this.filterChainManager = filterChainManager;<a name="line.90"></a> |
| <FONT color="green">091</FONT> }<a name="line.91"></a> |
| <FONT color="green">092</FONT> <a name="line.92"></a> |
| <FONT color="green">093</FONT> public FilterChain getChain(ServletRequest request, ServletResponse response, FilterChain originalChain) {<a name="line.93"></a> |
| <FONT color="green">094</FONT> FilterChainManager filterChainManager = getFilterChainManager();<a name="line.94"></a> |
| <FONT color="green">095</FONT> if (!filterChainManager.hasChains()) {<a name="line.95"></a> |
| <FONT color="green">096</FONT> return null;<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> String requestURI = getPathWithinApplication(request);<a name="line.99"></a> |
| <FONT color="green">100</FONT> <a name="line.100"></a> |
| <FONT color="green">101</FONT> //the 'chain names' in this implementation are actually path patterns defined by the user. We just use them<a name="line.101"></a> |
| <FONT color="green">102</FONT> //as the chain name for the FilterChainManager's requirements<a name="line.102"></a> |
| <FONT color="green">103</FONT> for (String pathPattern : filterChainManager.getChainNames()) {<a name="line.103"></a> |
| <FONT color="green">104</FONT> <a name="line.104"></a> |
| <FONT color="green">105</FONT> // If the path does match, then pass on to the subclass implementation for specific checks:<a name="line.105"></a> |
| <FONT color="green">106</FONT> if (pathMatches(pathPattern, requestURI)) {<a name="line.106"></a> |
| <FONT color="green">107</FONT> if (log.isTraceEnabled()) {<a name="line.107"></a> |
| <FONT color="green">108</FONT> log.trace("Matched path pattern [" + pathPattern + "] for requestURI [" + requestURI + "]. " +<a name="line.108"></a> |
| <FONT color="green">109</FONT> "Utilizing corresponding filter chain...");<a name="line.109"></a> |
| <FONT color="green">110</FONT> }<a name="line.110"></a> |
| <FONT color="green">111</FONT> return filterChainManager.proxy(originalChain, pathPattern);<a name="line.111"></a> |
| <FONT color="green">112</FONT> }<a name="line.112"></a> |
| <FONT color="green">113</FONT> }<a name="line.113"></a> |
| <FONT color="green">114</FONT> <a name="line.114"></a> |
| <FONT color="green">115</FONT> return null;<a name="line.115"></a> |
| <FONT color="green">116</FONT> }<a name="line.116"></a> |
| <FONT color="green">117</FONT> <a name="line.117"></a> |
| <FONT color="green">118</FONT> /**<a name="line.118"></a> |
| <FONT color="green">119</FONT> * Returns {@code true} if an incoming request path (the {@code path} argument)<a name="line.119"></a> |
| <FONT color="green">120</FONT> * matches a configured filter chain path (the {@code pattern} argument), {@code false} otherwise.<a name="line.120"></a> |
| <FONT color="green">121</FONT> * <p/><a name="line.121"></a> |
| <FONT color="green">122</FONT> * Simply delegates to<a name="line.122"></a> |
| <FONT color="green">123</FONT> * <b><code>{@link #getPathMatcher() getPathMatcher()}.{@link org.apache.shiro.util.PatternMatcher#matches(String, String) matches(pattern,path)}</code></b>.<a name="line.123"></a> |
| <FONT color="green">124</FONT> * Subclass implementors should think carefully before overriding this method, as typically a custom<a name="line.124"></a> |
| <FONT color="green">125</FONT> * {@code PathMatcher} should be configured for custom path matching behavior instead. Favor OO composition<a name="line.125"></a> |
| <FONT color="green">126</FONT> * rather than inheritance to limit your exposure to Shiro implementation details which may change over time.<a name="line.126"></a> |
| <FONT color="green">127</FONT> *<a name="line.127"></a> |
| <FONT color="green">128</FONT> * @param pattern the pattern to match against<a name="line.128"></a> |
| <FONT color="green">129</FONT> * @param path the value to match with the specified {@code pattern}<a name="line.129"></a> |
| <FONT color="green">130</FONT> * @return {@code true} if the request {@code path} matches the specified filter chain url {@code pattern},<a name="line.130"></a> |
| <FONT color="green">131</FONT> * {@code false} otherwise.<a name="line.131"></a> |
| <FONT color="green">132</FONT> */<a name="line.132"></a> |
| <FONT color="green">133</FONT> protected boolean pathMatches(String pattern, String path) {<a name="line.133"></a> |
| <FONT color="green">134</FONT> PatternMatcher pathMatcher = getPathMatcher();<a name="line.134"></a> |
| <FONT color="green">135</FONT> return pathMatcher.matches(pattern, path);<a name="line.135"></a> |
| <FONT color="green">136</FONT> }<a name="line.136"></a> |
| <FONT color="green">137</FONT> <a name="line.137"></a> |
| <FONT color="green">138</FONT> /**<a name="line.138"></a> |
| <FONT color="green">139</FONT> * Merely returns<a name="line.139"></a> |
| <FONT color="green">140</FONT> * <code>WebUtils.{@link org.apache.shiro.web.util.WebUtils#getPathWithinApplication(javax.servlet.http.HttpServletRequest) getPathWithinApplication(request)}</code><a name="line.140"></a> |
| <FONT color="green">141</FONT> * and can be overridden by subclasses for custom request-to-application-path resolution behavior.<a name="line.141"></a> |
| <FONT color="green">142</FONT> *<a name="line.142"></a> |
| <FONT color="green">143</FONT> * @param request the incoming {@code ServletRequest}<a name="line.143"></a> |
| <FONT color="green">144</FONT> * @return the request's path within the appliation.<a name="line.144"></a> |
| <FONT color="green">145</FONT> */<a name="line.145"></a> |
| <FONT color="green">146</FONT> protected String getPathWithinApplication(ServletRequest request) {<a name="line.146"></a> |
| <FONT color="green">147</FONT> return WebUtils.getPathWithinApplication(WebUtils.toHttp(request));<a name="line.147"></a> |
| <FONT color="green">148</FONT> }<a name="line.148"></a> |
| <FONT color="green">149</FONT> }<a name="line.149"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
