blob: 1810e20e416e55a8b74ae895a2b0b2a15bfb68d5 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="fr">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.guice;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import java.lang.reflect.Method;</a>
<span class="sourceLineNo">022</span><a id="line.22">import java.util.Collection;</a>
<span class="sourceLineNo">023</span><a id="line.23">import java.util.Collections;</a>
<span class="sourceLineNo">024</span><a id="line.24">import java.util.List;</a>
<span class="sourceLineNo">025</span><a id="line.25">import java.util.Set;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.util.WeakHashMap;</a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">import javax.annotation.PreDestroy;</a>
<span class="sourceLineNo">029</span><a id="line.29"></a>
<span class="sourceLineNo">030</span><a id="line.30">import com.google.inject.Provider;</a>
<span class="sourceLineNo">031</span><a id="line.31">import com.google.inject.matcher.Matchers;</a>
<span class="sourceLineNo">032</span><a id="line.32">import com.google.inject.spi.InjectionListener;</a>
<span class="sourceLineNo">033</span><a id="line.33">import com.google.inject.spi.TypeEncounter;</a>
<span class="sourceLineNo">034</span><a id="line.34">import com.google.inject.spi.TypeListener;</a>
<span class="sourceLineNo">035</span><a id="line.35">import org.apache.shiro.config.ConfigurationException;</a>
<span class="sourceLineNo">036</span><a id="line.36">import org.apache.shiro.env.Environment;</a>
<span class="sourceLineNo">037</span><a id="line.37">import org.apache.shiro.event.EventBus;</a>
<span class="sourceLineNo">038</span><a id="line.38">import org.apache.shiro.event.EventBusAware;</a>
<span class="sourceLineNo">039</span><a id="line.39">import org.apache.shiro.event.Subscribe;</a>
<span class="sourceLineNo">040</span><a id="line.40">import org.apache.shiro.event.support.DefaultEventBus;</a>
<span class="sourceLineNo">041</span><a id="line.41">import org.apache.shiro.mgt.DefaultSecurityManager;</a>
<span class="sourceLineNo">042</span><a id="line.42">import org.apache.shiro.mgt.SecurityManager;</a>
<span class="sourceLineNo">043</span><a id="line.43">import org.apache.shiro.realm.Realm;</a>
<span class="sourceLineNo">044</span><a id="line.44">import org.apache.shiro.session.mgt.DefaultSessionManager;</a>
<span class="sourceLineNo">045</span><a id="line.45">import org.apache.shiro.session.mgt.SessionManager;</a>
<span class="sourceLineNo">046</span><a id="line.46">import org.apache.shiro.util.ClassUtils;</a>
<span class="sourceLineNo">047</span><a id="line.47">import org.apache.shiro.util.Destroyable;</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49">import com.google.inject.Key;</a>
<span class="sourceLineNo">050</span><a id="line.50">import com.google.inject.PrivateModule;</a>
<span class="sourceLineNo">051</span><a id="line.51">import com.google.inject.TypeLiteral;</a>
<span class="sourceLineNo">052</span><a id="line.52">import com.google.inject.binder.AnnotatedBindingBuilder;</a>
<span class="sourceLineNo">053</span><a id="line.53">import com.google.inject.binder.LinkedBindingBuilder;</a>
<span class="sourceLineNo">054</span><a id="line.54">import com.google.inject.multibindings.Multibinder;</a>
<span class="sourceLineNo">055</span><a id="line.55">import com.google.inject.util.Types;</a>
<span class="sourceLineNo">056</span><a id="line.56">import org.slf4j.Logger;</a>
<span class="sourceLineNo">057</span><a id="line.57">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">058</span><a id="line.58"></a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60">/**</a>
<span class="sourceLineNo">061</span><a id="line.61"> * Sets up Shiro lifecycles within Guice, enables the injecting of Shiro objects, and binds a default</a>
<span class="sourceLineNo">062</span><a id="line.62"> * {@link org.apache.shiro.mgt.SecurityManager} and {@link org.apache.shiro.session.mgt.SessionManager}. At least one realm must be added by using</a>
<span class="sourceLineNo">063</span><a id="line.63"> * {@link #bindRealm() bindRealm}.</a>
<span class="sourceLineNo">064</span><a id="line.64"> */</a>
<span class="sourceLineNo">065</span><a id="line.65">public abstract class ShiroModule extends PrivateModule implements Destroyable {</a>
<span class="sourceLineNo">066</span><a id="line.66"></a>
<span class="sourceLineNo">067</span><a id="line.67"> private final Logger log = LoggerFactory.getLogger(ShiroModule.class);</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> private Set&lt;Destroyable&gt; destroyables = Collections.newSetFromMap(new WeakHashMap&lt;Destroyable, Boolean&gt;());</a>
<span class="sourceLineNo">070</span><a id="line.70"> public void configure() {</a>
<span class="sourceLineNo">071</span><a id="line.71"> // setup security manager</a>
<span class="sourceLineNo">072</span><a id="line.72"> bindSecurityManager(bind(SecurityManager.class));</a>
<span class="sourceLineNo">073</span><a id="line.73"> bindSessionManager(bind(SessionManager.class));</a>
<span class="sourceLineNo">074</span><a id="line.74"> bindEnvironment(bind(Environment.class));</a>
<span class="sourceLineNo">075</span><a id="line.75"> bindListener(BeanTypeListener.MATCHER, new BeanTypeListener());</a>
<span class="sourceLineNo">076</span><a id="line.76"> bindEventBus(bind(EventBus.class));</a>
<span class="sourceLineNo">077</span><a id="line.77"> bindListener(Matchers.any(), new SubscribedEventTypeListener());</a>
<span class="sourceLineNo">078</span><a id="line.78"> bindListener(Matchers.any(), new EventBusAwareTypeListener());</a>
<span class="sourceLineNo">079</span><a id="line.79"> final DestroyableInjectionListener.DestroyableRegistry registry = new DestroyableInjectionListener.DestroyableRegistry() {</a>
<span class="sourceLineNo">080</span><a id="line.80"> public void add(Destroyable destroyable) {</a>
<span class="sourceLineNo">081</span><a id="line.81"> ShiroModule.this.add(destroyable);</a>
<span class="sourceLineNo">082</span><a id="line.82"> }</a>
<span class="sourceLineNo">083</span><a id="line.83"></a>
<span class="sourceLineNo">084</span><a id="line.84"> @PreDestroy</a>
<span class="sourceLineNo">085</span><a id="line.85"> public void destroy() {</a>
<span class="sourceLineNo">086</span><a id="line.86"> ShiroModule.this.destroy();</a>
<span class="sourceLineNo">087</span><a id="line.87"> }</a>
<span class="sourceLineNo">088</span><a id="line.88"> };</a>
<span class="sourceLineNo">089</span><a id="line.89"> bindListener(LifecycleTypeListener.MATCHER, new LifecycleTypeListener(registry));</a>
<span class="sourceLineNo">090</span><a id="line.90"></a>
<span class="sourceLineNo">091</span><a id="line.91"> expose(SecurityManager.class);</a>
<span class="sourceLineNo">092</span><a id="line.92"> expose(EventBus.class);</a>
<span class="sourceLineNo">093</span><a id="line.93"></a>
<span class="sourceLineNo">094</span><a id="line.94"> configureShiro();</a>
<span class="sourceLineNo">095</span><a id="line.95"> bind(realmCollectionKey())</a>
<span class="sourceLineNo">096</span><a id="line.96"> .to(realmSetKey());</a>
<span class="sourceLineNo">097</span><a id="line.97"></a>
<span class="sourceLineNo">098</span><a id="line.98"> bind(DestroyableInjectionListener.DestroyableRegistry.class).toInstance(registry);</a>
<span class="sourceLineNo">099</span><a id="line.99"> BeanTypeListener.ensureBeanTypeMapExists(binder());</a>
<span class="sourceLineNo">100</span><a id="line.100"> }</a>
<span class="sourceLineNo">101</span><a id="line.101"></a>
<span class="sourceLineNo">102</span><a id="line.102"> @SuppressWarnings({"unchecked"})</a>
<span class="sourceLineNo">103</span><a id="line.103"> private Key&lt;Set&lt;Realm&gt;&gt; realmSetKey() {</a>
<span class="sourceLineNo">104</span><a id="line.104"> return (Key&lt;Set&lt;Realm&gt;&gt;) Key.get(TypeLiteral.get(Types.setOf(Realm.class)));</a>
<span class="sourceLineNo">105</span><a id="line.105"> }</a>
<span class="sourceLineNo">106</span><a id="line.106"></a>
<span class="sourceLineNo">107</span><a id="line.107"> @SuppressWarnings({"unchecked"})</a>
<span class="sourceLineNo">108</span><a id="line.108"> private Key&lt;Collection&lt;Realm&gt;&gt; realmCollectionKey() {</a>
<span class="sourceLineNo">109</span><a id="line.109"> return (Key&lt;Collection&lt;Realm&gt;&gt;) Key.get(Types.newParameterizedType(Collection.class, Realm.class));</a>
<span class="sourceLineNo">110</span><a id="line.110"> }</a>
<span class="sourceLineNo">111</span><a id="line.111"></a>
<span class="sourceLineNo">112</span><a id="line.112"> /**</a>
<span class="sourceLineNo">113</span><a id="line.113"> * Implement this method in order to configure your realms and any other Shiro customization you may need.</a>
<span class="sourceLineNo">114</span><a id="line.114"> */</a>
<span class="sourceLineNo">115</span><a id="line.115"> protected abstract void configureShiro();</a>
<span class="sourceLineNo">116</span><a id="line.116"></a>
<span class="sourceLineNo">117</span><a id="line.117"> /**</a>
<span class="sourceLineNo">118</span><a id="line.118"> * This is the preferred manner to bind a realm. The {@link org.apache.shiro.mgt.SecurityManager} will be injected with any Realm bound</a>
<span class="sourceLineNo">119</span><a id="line.119"> * with this method.</a>
<span class="sourceLineNo">120</span><a id="line.120"> *</a>
<span class="sourceLineNo">121</span><a id="line.121"> * @return a binding builder for a realm</a>
<span class="sourceLineNo">122</span><a id="line.122"> */</a>
<span class="sourceLineNo">123</span><a id="line.123"> protected final LinkedBindingBuilder&lt;Realm&gt; bindRealm() {</a>
<span class="sourceLineNo">124</span><a id="line.124"> Multibinder&lt;Realm&gt; multibinder = Multibinder.newSetBinder(binder(), Realm.class);</a>
<span class="sourceLineNo">125</span><a id="line.125"> return multibinder.addBinding();</a>
<span class="sourceLineNo">126</span><a id="line.126"> }</a>
<span class="sourceLineNo">127</span><a id="line.127"></a>
<span class="sourceLineNo">128</span><a id="line.128"> /**</a>
<span class="sourceLineNo">129</span><a id="line.129"> * Binds the security manager. Override this method in order to provide your own security manager binding.</a>
<span class="sourceLineNo">130</span><a id="line.130"> * &lt;p/&gt;</a>
<span class="sourceLineNo">131</span><a id="line.131"> * By default, a {@link org.apache.shiro.mgt.DefaultSecurityManager} is bound as an eager singleton.</a>
<span class="sourceLineNo">132</span><a id="line.132"> *</a>
<span class="sourceLineNo">133</span><a id="line.133"> * @param bind</a>
<span class="sourceLineNo">134</span><a id="line.134"> */</a>
<span class="sourceLineNo">135</span><a id="line.135"> protected void bindSecurityManager(AnnotatedBindingBuilder&lt;? super SecurityManager&gt; bind) {</a>
<span class="sourceLineNo">136</span><a id="line.136"> try {</a>
<span class="sourceLineNo">137</span><a id="line.137"> bind.toConstructor(DefaultSecurityManager.class.getConstructor(Collection.class)).asEagerSingleton();</a>
<span class="sourceLineNo">138</span><a id="line.138"> } catch (NoSuchMethodException e) {</a>
<span class="sourceLineNo">139</span><a id="line.139"> throw new ConfigurationException("This really shouldn't happen. Either something has changed in Shiro, or there's a bug in " + ShiroModule.class.getSimpleName(), e);</a>
<span class="sourceLineNo">140</span><a id="line.140"> }</a>
<span class="sourceLineNo">141</span><a id="line.141"> }</a>
<span class="sourceLineNo">142</span><a id="line.142"></a>
<span class="sourceLineNo">143</span><a id="line.143"> /**</a>
<span class="sourceLineNo">144</span><a id="line.144"> * Binds the session manager. Override this method in order to provide your own session manager binding.</a>
<span class="sourceLineNo">145</span><a id="line.145"> * &lt;p/&gt;</a>
<span class="sourceLineNo">146</span><a id="line.146"> * By default, a {@link org.apache.shiro.session.mgt.DefaultSessionManager} is bound as an eager singleton.</a>
<span class="sourceLineNo">147</span><a id="line.147"> *</a>
<span class="sourceLineNo">148</span><a id="line.148"> * @param bind</a>
<span class="sourceLineNo">149</span><a id="line.149"> */</a>
<span class="sourceLineNo">150</span><a id="line.150"> protected void bindSessionManager(AnnotatedBindingBuilder&lt;SessionManager&gt; bind) {</a>
<span class="sourceLineNo">151</span><a id="line.151"> bind.to(DefaultSessionManager.class).asEagerSingleton();</a>
<span class="sourceLineNo">152</span><a id="line.152"> }</a>
<span class="sourceLineNo">153</span><a id="line.153"></a>
<span class="sourceLineNo">154</span><a id="line.154"> /**</a>
<span class="sourceLineNo">155</span><a id="line.155"> * Binds the environment. Override this method in order to provide your own environment binding.</a>
<span class="sourceLineNo">156</span><a id="line.156"> * &lt;p/&gt;</a>
<span class="sourceLineNo">157</span><a id="line.157"> * By default, a {@link GuiceEnvironment} is bound as an eager singleton.</a>
<span class="sourceLineNo">158</span><a id="line.158"> *</a>
<span class="sourceLineNo">159</span><a id="line.159"> * @param bind</a>
<span class="sourceLineNo">160</span><a id="line.160"> */</a>
<span class="sourceLineNo">161</span><a id="line.161"> protected void bindEnvironment(AnnotatedBindingBuilder&lt;Environment&gt; bind) {</a>
<span class="sourceLineNo">162</span><a id="line.162"> bind.to(GuiceEnvironment.class).asEagerSingleton();</a>
<span class="sourceLineNo">163</span><a id="line.163"> }</a>
<span class="sourceLineNo">164</span><a id="line.164"></a>
<span class="sourceLineNo">165</span><a id="line.165"> /**</a>
<span class="sourceLineNo">166</span><a id="line.166"> * Binds a key to use for injecting setters in shiro classes.</a>
<span class="sourceLineNo">167</span><a id="line.167"> * @param typeLiteral the bean property type</a>
<span class="sourceLineNo">168</span><a id="line.168"> * @param key the key to use to satisfy the bean property dependency</a>
<span class="sourceLineNo">169</span><a id="line.169"> * @param &lt;T&gt;</a>
<span class="sourceLineNo">170</span><a id="line.170"> */</a>
<span class="sourceLineNo">171</span><a id="line.171"> protected final &lt;T&gt; void bindBeanType(TypeLiteral&lt;T&gt; typeLiteral, Key&lt;? extends T&gt; key) {</a>
<span class="sourceLineNo">172</span><a id="line.172"> BeanTypeListener.bindBeanType(binder(), typeLiteral, key);</a>
<span class="sourceLineNo">173</span><a id="line.173"> }</a>
<span class="sourceLineNo">174</span><a id="line.174"></a>
<span class="sourceLineNo">175</span><a id="line.175"> /**</a>
<span class="sourceLineNo">176</span><a id="line.176"> * Binds the EventBus. Override this method in order to provide your own {@link EventBus} binding.</a>
<span class="sourceLineNo">177</span><a id="line.177"> * @param bind</a>
<span class="sourceLineNo">178</span><a id="line.178"> * @since 1.4</a>
<span class="sourceLineNo">179</span><a id="line.179"> */</a>
<span class="sourceLineNo">180</span><a id="line.180"> protected void bindEventBus(AnnotatedBindingBuilder&lt;EventBus&gt; bind) {</a>
<span class="sourceLineNo">181</span><a id="line.181"> bind.to(DefaultEventBus.class).asEagerSingleton();</a>
<span class="sourceLineNo">182</span><a id="line.182"> }</a>
<span class="sourceLineNo">183</span><a id="line.183"></a>
<span class="sourceLineNo">184</span><a id="line.184"> /**</a>
<span class="sourceLineNo">185</span><a id="line.185"> * Destroys all beans created within this module that implement {@link org.apache.shiro.util.Destroyable}. Should be called when this</a>
<span class="sourceLineNo">186</span><a id="line.186"> * module will no longer be used.</a>
<span class="sourceLineNo">187</span><a id="line.187"> *</a>
<span class="sourceLineNo">188</span><a id="line.188"> * @throws Exception</a>
<span class="sourceLineNo">189</span><a id="line.189"> */</a>
<span class="sourceLineNo">190</span><a id="line.190"> public final void destroy() {</a>
<span class="sourceLineNo">191</span><a id="line.191"> for (Destroyable destroyable : destroyables) {</a>
<span class="sourceLineNo">192</span><a id="line.192"> try {</a>
<span class="sourceLineNo">193</span><a id="line.193"> destroyable.destroy();</a>
<span class="sourceLineNo">194</span><a id="line.194"> }</a>
<span class="sourceLineNo">195</span><a id="line.195"> catch(Exception e) {</a>
<span class="sourceLineNo">196</span><a id="line.196"> log.warn("Error destroying component class: " + destroyable.getClass(), e);</a>
<span class="sourceLineNo">197</span><a id="line.197"> }</a>
<span class="sourceLineNo">198</span><a id="line.198"> }</a>
<span class="sourceLineNo">199</span><a id="line.199"> }</a>
<span class="sourceLineNo">200</span><a id="line.200"></a>
<span class="sourceLineNo">201</span><a id="line.201"> public void add(Destroyable destroyable) {</a>
<span class="sourceLineNo">202</span><a id="line.202"> this.destroyables.add(destroyable);</a>
<span class="sourceLineNo">203</span><a id="line.203"> }</a>
<span class="sourceLineNo">204</span><a id="line.204"></a>
<span class="sourceLineNo">205</span><a id="line.205"> private class SubscribedEventTypeListener implements TypeListener {</a>
<span class="sourceLineNo">206</span><a id="line.206"> @Override</a>
<span class="sourceLineNo">207</span><a id="line.207"> public &lt;I&gt; void hear(TypeLiteral&lt;I&gt; typeLiteral, TypeEncounter&lt;I&gt; typeEncounter) {</a>
<span class="sourceLineNo">208</span><a id="line.208"></a>
<span class="sourceLineNo">209</span><a id="line.209"> final Provider&lt;EventBus&gt; eventBusProvider = typeEncounter.getProvider(EventBus.class);</a>
<span class="sourceLineNo">210</span><a id="line.210"></a>
<span class="sourceLineNo">211</span><a id="line.211"> List&lt;Method&gt; methods = ClassUtils.getAnnotatedMethods(typeLiteral.getRawType(), Subscribe.class);</a>
<span class="sourceLineNo">212</span><a id="line.212"> if (methods != null &amp;&amp; !methods.isEmpty()) {</a>
<span class="sourceLineNo">213</span><a id="line.213"> typeEncounter.register( new InjectionListener&lt;I&gt;() {</a>
<span class="sourceLineNo">214</span><a id="line.214"> @Override</a>
<span class="sourceLineNo">215</span><a id="line.215"> public void afterInjection(Object o) {</a>
<span class="sourceLineNo">216</span><a id="line.216"> eventBusProvider.get().register(o);</a>
<span class="sourceLineNo">217</span><a id="line.217"> }</a>
<span class="sourceLineNo">218</span><a id="line.218"> });</a>
<span class="sourceLineNo">219</span><a id="line.219"> }</a>
<span class="sourceLineNo">220</span><a id="line.220"> }</a>
<span class="sourceLineNo">221</span><a id="line.221"> }</a>
<span class="sourceLineNo">222</span><a id="line.222"></a>
<span class="sourceLineNo">223</span><a id="line.223"> private class EventBusAwareTypeListener implements TypeListener {</a>
<span class="sourceLineNo">224</span><a id="line.224"> @Override</a>
<span class="sourceLineNo">225</span><a id="line.225"> public &lt;I&gt; void hear(TypeLiteral&lt;I&gt; typeLiteral, TypeEncounter&lt;I&gt; typeEncounter) {</a>
<span class="sourceLineNo">226</span><a id="line.226"></a>
<span class="sourceLineNo">227</span><a id="line.227"> final Provider&lt;EventBus&gt; eventBusProvider = typeEncounter.getProvider(EventBus.class);</a>
<span class="sourceLineNo">228</span><a id="line.228"></a>
<span class="sourceLineNo">229</span><a id="line.229"> if (EventBusAware.class.isAssignableFrom(typeLiteral.getRawType())) {</a>
<span class="sourceLineNo">230</span><a id="line.230"> typeEncounter.register( new InjectionListener&lt;I&gt;() {</a>
<span class="sourceLineNo">231</span><a id="line.231"> @Override</a>
<span class="sourceLineNo">232</span><a id="line.232"> public void afterInjection(Object o) {</a>
<span class="sourceLineNo">233</span><a id="line.233"> ((EventBusAware)o).setEventBus(eventBusProvider.get());</a>
<span class="sourceLineNo">234</span><a id="line.234"> }</a>
<span class="sourceLineNo">235</span><a id="line.235"> });</a>
<span class="sourceLineNo">236</span><a id="line.236"> }</a>
<span class="sourceLineNo">237</span><a id="line.237"> }</a>
<span class="sourceLineNo">238</span><a id="line.238"> }</a>
<span class="sourceLineNo">239</span><a id="line.239">}</a>
</pre>
</div>
</main>
</body>
</html>