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