| <!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.guice.web;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import javax.servlet.Filter;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import javax.servlet.ServletContext;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.config.ConfigurationException;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.shiro.env.Environment;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.shiro.guice.ShiroModule;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.shiro.mgt.SecurityManager;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.shiro.session.mgt.SessionManager;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.shiro.util.StringUtils;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.shiro.web.env.WebEnvironment;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.shiro.web.filter.PathMatchingFilter;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.shiro.web.filter.authc.AnonymousFilter;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.shiro.web.filter.authc.FormAuthenticationFilter;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.shiro.web.filter.authc.LogoutFilter;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.shiro.web.filter.authc.UserFilter;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.shiro.web.filter.authz.PermissionsAuthorizationFilter;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.shiro.web.filter.authz.PortFilter;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.shiro.web.filter.authz.RolesAuthorizationFilter;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.shiro.web.filter.authz.SslFilter;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.shiro.web.filter.mgt.FilterChainResolver;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.shiro.web.filter.session.NoSessionCreationFilter;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.shiro.web.mgt.DefaultWebSecurityManager;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.shiro.web.mgt.WebSecurityManager;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.shiro.web.session.mgt.ServletContainerSessionManager;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import com.google.inject.Binder;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import com.google.inject.Key;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import com.google.inject.TypeLiteral;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import com.google.inject.binder.AnnotatedBindingBuilder;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import com.google.inject.name.Names;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>import com.google.inject.servlet.ServletModule;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span>/**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Sets up Shiro lifecycles within Guice, enables the injecting of Shiro objects, and binds a default<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * {@link org.apache.shiro.web.mgt.WebSecurityManager}, {@link org.apache.shiro.mgt.SecurityManager} and {@link org.apache.shiro.session.mgt.SessionManager}. At least one realm must be added by<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * using {@link #bindRealm() bindRealm}.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <p/><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Also provides for the configuring of filter chains and binds a {@link org.apache.shiro.web.filter.mgt.FilterChainResolver} with that information.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span>public abstract class ShiroWebModule extends ShiroModule {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> public static final Key<AnonymousFilter> ANON = Key.get(AnonymousFilter.class);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> public static final Key<FormAuthenticationFilter> AUTHC = Key.get(FormAuthenticationFilter.class);<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> public static final Key<BasicHttpAuthenticationFilter> AUTHC_BASIC = Key.get(BasicHttpAuthenticationFilter.class);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public static final Key<NoSessionCreationFilter> NO_SESSION_CREATION = Key.get(NoSessionCreationFilter.class);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public static final Key<LogoutFilter> LOGOUT = Key.get(LogoutFilter.class);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> public static final Key<PermissionsAuthorizationFilter> PERMS = Key.get(PermissionsAuthorizationFilter.class);<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public static final Key<PortFilter> PORT = Key.get(PortFilter.class);<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public static final Key<HttpMethodPermissionFilter> REST = Key.get(HttpMethodPermissionFilter.class);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> public static final Key<RolesAuthorizationFilter> ROLES = Key.get(RolesAuthorizationFilter.class);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public static final Key<SslFilter> SSL = Key.get(SslFilter.class);<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> public static final Key<UserFilter> USER = Key.get(UserFilter.class);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> static final String NAME = "SHIRO";<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> * We use a LinkedHashMap here to ensure that iterator order is the same as add order. This is important, as the<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * FilterChainResolver uses iterator order when searching for a matching chain.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> private final Map<String, FilterConfig<? extends Filter>[]> filterChains = new LinkedHashMap<String, FilterConfig<? extends Filter>[]>();<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> private final ServletContext servletContext;<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> public ShiroWebModule(ServletContext servletContext) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> this.servletContext = servletContext;<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> public static void bindGuiceFilter(Binder binder) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> binder.install(guiceFilterModule());<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> @SuppressWarnings({"UnusedDeclaration"})<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> public static void bindGuiceFilter(final String pattern, Binder binder) {<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> binder.install(guiceFilterModule(pattern));<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> }<a name="line.109"></a> |
| <span class="sourceLineNo">110</span><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> public static ServletModule guiceFilterModule() {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> return guiceFilterModule("/*");<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> public static ServletModule guiceFilterModule(final String pattern) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return new ServletModule() {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> @Override<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> protected void configureServlets() {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> filter(pattern).through(GuiceShiroFilter.class);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> };<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> @Override<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> protected final void configureShiro() {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> bindBeanType(TypeLiteral.get(ServletContext.class), Key.get(ServletContext.class, Names.named(NAME)));<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> bind(Key.get(ServletContext.class, Names.named(NAME))).toInstance(this.servletContext);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> bindWebSecurityManager(bind(WebSecurityManager.class));<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> bindWebEnvironment(bind(WebEnvironment.class));<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> bind(GuiceShiroFilter.class).asEagerSingleton();<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> expose(GuiceShiroFilter.class);<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> this.configureShiroWeb();<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> bind(FilterChainResolver.class).toProvider(new FilterChainResolverProvider(setupFilterChainConfigs()));<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> private Map<String, Key<? extends Filter>[]> setupFilterChainConfigs() {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> // loop through and build a map of Filter Key -> Map<Path, Config><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> Map<Key<? extends Filter>, Map<String, String>> filterToPathToConfig = new HashMap<Key<? extends Filter>, Map<String, String>>();<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> // At the same time build a map to return with Path -> Key[]<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> Map<String, Key<? extends Filter>[]> resultConfigMap = new HashMap<String, Key<? extends Filter>[]>();<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> for (Map.Entry<String, FilterConfig<? extends Filter>[]> filterChain : filterChains.entrySet()) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> String path = filterChain.getKey();<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> // collect the keys used for this path<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> List<Key<? extends Filter>> keysForPath = new ArrayList<Key<? extends Filter>>();<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> for (int i = 0; i < filterChain.getValue().length; i++) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> FilterConfig<? extends Filter> filterConfig = filterChain.getValue()[i];<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> Key<? extends Filter> key = filterConfig.getKey();<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> String config = filterConfig.getConfigValue();<a name="line.157"></a> |
| <span class="sourceLineNo">158</span><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> // initialize key in filterToPathToConfig, if it doesn't exist<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> if (filterToPathToConfig.get(key) == null) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> filterToPathToConfig.put((key), new HashMap<String, String>());<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> // now set the value<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> filterToPathToConfig.get(key).put(path, config);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> // Config error if someone configured a non PathMatchingFilter with a config value<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> if (StringUtils.hasText(config) && !PathMatchingFilter.class.isAssignableFrom(key.getTypeLiteral().getRawType())) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> throw new ConfigurationException("Config information requires a PathMatchingFilter - can't apply to " + key.getTypeLiteral().getRawType());<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> }<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> // store the key in keysForPath<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> keysForPath.add(key);<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> // map the current path to all of its Keys<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> resultConfigMap.put(path, keysForPath.toArray(new Key[keysForPath.size()]));<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> // now we find only the PathMatchingFilter and configure bindings<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> // non PathMatchingFilter, can be loaded with the default provider via the class name<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> for (Key<? extends Filter> key : filterToPathToConfig.keySet()) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> if (PathMatchingFilter.class.isAssignableFrom(key.getTypeLiteral().getRawType())) {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> bindPathMatchingFilter(castToPathMatching(key), filterToPathToConfig.get(key));<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> else {<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> bind(key);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> }<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> }<a name="line.188"></a> |
| <span class="sourceLineNo">189</span><a name="line.189"></a> |
| <span class="sourceLineNo">190</span> return resultConfigMap;<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> }<a name="line.191"></a> |
| <span class="sourceLineNo">192</span><a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> private <T extends PathMatchingFilter> void bindPathMatchingFilter(Key<T> filterKey, Map<String, String> configs) {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> bind(filterKey).toProvider(new PathMatchingFilterProvider<T>(filterKey, configs)).asEagerSingleton();<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> @SuppressWarnings({"unchecked"})<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> private Key<? extends PathMatchingFilter> castToPathMatching(Key<? extends Filter> key) {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> return (Key<? extends PathMatchingFilter>) key;<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> }<a name="line.201"></a> |
| <span class="sourceLineNo">202</span><a name="line.202"></a> |
| <span class="sourceLineNo">203</span> protected abstract void configureShiroWeb();<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> @SuppressWarnings({"unchecked"})<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> @Override<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> protected final void bindSecurityManager(AnnotatedBindingBuilder<? super SecurityManager> bind) {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> bind.to(WebSecurityManager.class); // SHIRO-435<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> }<a name="line.209"></a> |
| <span class="sourceLineNo">210</span><a name="line.210"></a> |
| <span class="sourceLineNo">211</span> /**<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * Binds the security manager. Override this method in order to provide your own security manager binding.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * <p/><a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * By default, a {@link org.apache.shiro.web.mgt.DefaultWebSecurityManager} is bound as an eager singleton.<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> *<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * @param bind<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> */<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> protected void bindWebSecurityManager(AnnotatedBindingBuilder<? super WebSecurityManager> bind) {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> try {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> bind.toConstructor(DefaultWebSecurityManager.class.getConstructor(Collection.class)).asEagerSingleton();<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> } catch (NoSuchMethodException e) {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> throw new ConfigurationException("This really shouldn't happen. Either something has changed in Shiro, or there's a bug in ShiroModule.", e);<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> }<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<a name="line.224"></a> |
| <span class="sourceLineNo">225</span><a name="line.225"></a> |
| <span class="sourceLineNo">226</span> /**<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * Binds the session manager. Override this method in order to provide your own session manager binding.<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * <p/><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * By default, a {@link org.apache.shiro.web.session.mgt.DefaultWebSessionManager} is bound as an eager singleton.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> *<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * @param bind<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> */<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> @Override<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> protected void bindSessionManager(AnnotatedBindingBuilder<SessionManager> bind) {<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> bind.to(ServletContainerSessionManager.class).asEagerSingleton();<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> }<a name="line.236"></a> |
| <span class="sourceLineNo">237</span><a name="line.237"></a> |
| <span class="sourceLineNo">238</span> @Override<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> protected final void bindEnvironment(AnnotatedBindingBuilder<Environment> bind) {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> bind.to(WebEnvironment.class); // SHIRO-435<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> }<a name="line.241"></a> |
| <span class="sourceLineNo">242</span><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> protected void bindWebEnvironment(AnnotatedBindingBuilder<? super WebEnvironment> bind) {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> bind.to(WebGuiceEnvironment.class).asEagerSingleton();<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> }<a name="line.245"></a> |
| <span class="sourceLineNo">246</span><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> protected final void addFilterChain(String pattern, Key<? extends Filter> key) {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> // check for legacy API<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> if (key instanceof FilterConfigKey) {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> addLegacyFilterChain(pattern, (FilterConfigKey) key);<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> else {<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> addFilterChain(pattern, new FilterConfig<Filter>((Key<Filter>) key, ""));<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> }<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> }<a name="line.255"></a> |
| <span class="sourceLineNo">256</span><a name="line.256"></a> |
| <span class="sourceLineNo">257</span> /**<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * Maps 'n' number of <code>filterConfig</code>s to a specific path pattern.<BR/><a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * For example, a path of '/my_private_resource/**' to 'filterConfig(AUTHC)' would require<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * any resource under the path '/my_private_resource' would be processed through the {@link FormAuthenticationFilter}.<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> *<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * @param pattern URL patter to be mapped to a FilterConfig, e.g. '/my_private-path/**'<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * @param filterConfigs FilterConfiguration representing the Filter and config to be used when processing resources on <code>pattern</code>.<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * @since 1.4<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> */<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> protected final void addFilterChain(String pattern, FilterConfig<? extends Filter>... filterConfigs) {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> filterChains.put(pattern, filterConfigs);<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> /**<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * Builds a FilterConfig from a Filer and configuration String<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * @param baseKey The Key of the Filter class to be used.<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * @param <T> A Servlet Filter class.<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * @return A FilterConfig used to map a String path to this configuration.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * @since 1.4<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> */<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> protected static <T extends Filter> FilterConfig<T> filterConfig(Key<T> baseKey, String configValue) {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> return new FilterConfig<T>(baseKey, configValue);<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> /**<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * Builds a FilterConfig from a Filer and configuration String<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * @param baseKey The Key of the Filter class to be used.<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * @param <T> A Servlet Filter class.<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * @return A FilterConfig used to map a String path to this configuration.<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * @since 1.4<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> */<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> protected static <T extends Filter> FilterConfig<T> filterConfig(Key<T> baseKey) {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> return filterConfig(baseKey, "");<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> }<a name="line.290"></a> |
| <span class="sourceLineNo">291</span><a name="line.291"></a> |
| <span class="sourceLineNo">292</span> /**<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * Builds a FilterConfig from a Filer and configuration String<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * @param typeLiteral The TyleLiteral of the filter key to be used.<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * @param configValue the configuration used.<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * @param <T> A Servlet Filter class.<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * @return A FilterConfig used to map a String path to this configuration.<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * @since 1.4<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> */<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> protected static <T extends Filter> FilterConfig<T> filterConfig(TypeLiteral<T> typeLiteral, String configValue) {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> return filterConfig(Key.get(typeLiteral), configValue);<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> }<a name="line.303"></a> |
| <span class="sourceLineNo">304</span><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> /**<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * Builds a FilterConfig from a Filer and configuration String<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * @param type The filter to be used.<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * @param configValue the configuration used.<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * @param <T> A Servlet Filter class.<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * @return A FilterConfig used to map a String path to this configuration.<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * @since 1.4<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> */<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> protected static <T extends Filter> FilterConfig<T> filterConfig(Class<T> type, String configValue) {<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> return filterConfig(Key.get(type), configValue);<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span><a name="line.317"></a> |
| <span class="sourceLineNo">318</span><a name="line.318"></a> |
| <span class="sourceLineNo">319</span> /**<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * Filter configuration which pairs a Filter class with its configuration used on a path.<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * @param <T> The Servlet Filter class.<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * @since 1.4<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> */<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> public static class FilterConfig<T extends Filter> {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> private Key<T> key;<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> private String configValue;<a name="line.326"></a> |
| <span class="sourceLineNo">327</span><a name="line.327"></a> |
| <span class="sourceLineNo">328</span> private FilterConfig(Key<T> key, String configValue) {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> super();<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> this.key = key;<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> this.configValue = configValue;<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> }<a name="line.332"></a> |
| <span class="sourceLineNo">333</span><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> public Key<T> getKey() {<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> return key;<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> }<a name="line.336"></a> |
| <span class="sourceLineNo">337</span><a name="line.337"></a> |
| <span class="sourceLineNo">338</span> public String getConfigValue() {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> return configValue;<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> }<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> }<a name="line.341"></a> |
| <span class="sourceLineNo">342</span><a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span><a name="line.344"></a> |
| <span class="sourceLineNo">345</span><a name="line.345"></a> |
| <span class="sourceLineNo">346</span><a name="line.346"></a> |
| <span class="sourceLineNo">347</span><a name="line.347"></a> |
| <span class="sourceLineNo">348</span><a name="line.348"></a> |
| <span class="sourceLineNo">349</span> // legacy methods<a name="line.349"></a> |
| <span class="sourceLineNo">350</span><a name="line.350"></a> |
| <span class="sourceLineNo">351</span><a name="line.351"></a> |
| <span class="sourceLineNo">352</span> static boolean isGuiceVersion3() {<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> try {<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> Class.forName("com.google.inject.multibindings.MapKey");<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> return false;<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> } catch (ClassNotFoundException e) {<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> return true;<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> }<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> }<a name="line.359"></a> |
| <span class="sourceLineNo">360</span><a name="line.360"></a> |
| <span class="sourceLineNo">361</span> private void addLegacyFilterChain(String pattern, FilterConfigKey filterConfigKey) {<a name="line.361"></a> |
| <span class="sourceLineNo">362</span><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> FilterConfig<Filter> filterConfig = new FilterConfig<Filter>(filterConfigKey.getKey(), filterConfigKey.getConfigValue());<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> addFilterChain(pattern, filterConfig);<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> }<a name="line.365"></a> |
| <span class="sourceLineNo">366</span><a name="line.366"></a> |
| <span class="sourceLineNo">367</span> /**<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * Adds a filter chain to the shiro configuration.<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * <p/><a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * NOTE: If the provided key is for a subclass of {@link org.apache.shiro.web.filter.PathMatchingFilter}, it will be registered with a proper<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * provider.<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> *<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * @param pattern<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> * @param keys<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> */<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> @Deprecated<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> protected final void addFilterChain(String pattern, Key<? extends Filter>... keys) {<a name="line.378"></a> |
| <span class="sourceLineNo">379</span><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> // We need to extract the keys and FilterConfigKey and convert to the new format.<a name="line.380"></a> |
| <span class="sourceLineNo">381</span><a name="line.381"></a> |
| <span class="sourceLineNo">382</span> FilterConfig[] filterConfigs = new FilterConfig[keys.length];<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> for (int ii = 0; ii < keys.length; ii++) {<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> Key<? extends Filter> key = keys[ii];<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> // If this is a path matching filter, we need to remember the config<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> if (key instanceof FilterConfigKey) {<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> // legacy config<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> FilterConfigKey legacyKey = (FilterConfigKey) key;<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> filterConfigs[ii] = new FilterConfig(legacyKey.getKey(), legacyKey.getConfigValue());<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> }<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> else {<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> // Some other type of Filter key, no config<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> filterConfigs[ii] = new FilterConfig(key, "");<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> }<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> }<a name="line.395"></a> |
| <span class="sourceLineNo">396</span><a name="line.396"></a> |
| <span class="sourceLineNo">397</span> filterChains.put(pattern, filterConfigs);<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> }<a name="line.398"></a> |
| <span class="sourceLineNo">399</span><a name="line.399"></a> |
| <span class="sourceLineNo">400</span> @Deprecated<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> protected static <T extends PathMatchingFilter> Key<T> config(Key<T> baseKey, String configValue) {<a name="line.401"></a> |
| <span class="sourceLineNo">402</span><a name="line.402"></a> |
| <span class="sourceLineNo">403</span> if( !isGuiceVersion3()) {<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> throw new ConfigurationException("Method ShiroWebModule.config(Key<? extends PathMatchingFilter>, String configValue), is not supported when using Guice 4+");<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> }<a name="line.405"></a> |
| <span class="sourceLineNo">406</span><a name="line.406"></a> |
| <span class="sourceLineNo">407</span> return new FilterConfigKey<T>(baseKey, configValue);<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> }<a name="line.408"></a> |
| <span class="sourceLineNo">409</span><a name="line.409"></a> |
| <span class="sourceLineNo">410</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> @Deprecated<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> protected static <T extends PathMatchingFilter> Key<T> config(TypeLiteral<T> typeLiteral, String configValue) {<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> return config(Key.get(typeLiteral), configValue);<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> }<a name="line.414"></a> |
| <span class="sourceLineNo">415</span><a name="line.415"></a> |
| <span class="sourceLineNo">416</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> @Deprecated<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> protected static <T extends PathMatchingFilter> Key<T> config(Class<T> type, String configValue) {<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> return config(Key.get(type), configValue);<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> }<a name="line.420"></a> |
| <span class="sourceLineNo">421</span><a name="line.421"></a> |
| <span class="sourceLineNo">422</span> @Deprecated<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> private static class FilterConfigKey<T extends PathMatchingFilter> extends Key<T> {<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> private Key<T> key;<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> private String configValue;<a name="line.425"></a> |
| <span class="sourceLineNo">426</span><a name="line.426"></a> |
| <span class="sourceLineNo">427</span> private FilterConfigKey(Key<T> key, String configValue) {<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> super();<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> this.key = key;<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> this.configValue = configValue;<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> }<a name="line.431"></a> |
| <span class="sourceLineNo">432</span><a name="line.432"></a> |
| <span class="sourceLineNo">433</span> public Key<T> getKey() {<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> return key;<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> }<a name="line.435"></a> |
| <span class="sourceLineNo">436</span><a name="line.436"></a> |
| <span class="sourceLineNo">437</span> public String getConfigValue() {<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> return configValue;<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> }<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> }<a name="line.440"></a> |
| <span class="sourceLineNo">441</span><a name="line.441"></a> |
| <span class="sourceLineNo">442</span>}<a name="line.442"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
