Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.3 / apidocs / src-html / org / apache / shiro / guice / ShiroModule.html
blob: 76cd00c25ab80ac2b6e53660b00050f0adc0d919 [file] [log] [blame]
<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.guice;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import com.google.common.collect.Sets;<a name="line.21"></a>
<FONT color="green">022</FONT> import com.google.inject.Key;<a name="line.22"></a>
<FONT color="green">023</FONT> import com.google.inject.PrivateModule;<a name="line.23"></a>
<FONT color="green">024</FONT> import com.google.inject.TypeLiteral;<a name="line.24"></a>
<FONT color="green">025</FONT> import com.google.inject.binder.AnnotatedBindingBuilder;<a name="line.25"></a>
<FONT color="green">026</FONT> import com.google.inject.binder.LinkedBindingBuilder;<a name="line.26"></a>
<FONT color="green">027</FONT> import com.google.inject.multibindings.Multibinder;<a name="line.27"></a>
<FONT color="green">028</FONT> import com.google.inject.util.Types;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.shiro.config.ConfigurationException;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.shiro.env.Environment;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.shiro.mgt.DefaultSecurityManager;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.shiro.mgt.SecurityManager;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.shiro.realm.Realm;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.shiro.session.mgt.DefaultSessionManager;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.apache.shiro.session.mgt.SessionManager;<a name="line.35"></a>
<FONT color="green">036</FONT> import org.apache.shiro.util.Destroyable;<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> import javax.annotation.PreDestroy;<a name="line.38"></a>
<FONT color="green">039</FONT> import java.util.Collection;<a name="line.39"></a>
<FONT color="green">040</FONT> import java.util.Set;<a name="line.40"></a>
<FONT color="green">041</FONT> import java.util.WeakHashMap;<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> /**<a name="line.44"></a>
<FONT color="green">045</FONT> * Sets up Shiro lifecycles within Guice, enables the injecting of Shiro objects, and binds a default<a name="line.45"></a>
<FONT color="green">046</FONT> * {@link org.apache.shiro.mgt.SecurityManager} and {@link org.apache.shiro.session.mgt.SessionManager}. At least one realm must be added by using<a name="line.46"></a>
<FONT color="green">047</FONT> * {@link #bindRealm() bindRealm}.<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> public abstract class ShiroModule extends PrivateModule implements Destroyable {<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> private Set&lt;Destroyable&gt; destroyables = Sets.newSetFromMap(new WeakHashMap&lt;Destroyable, Boolean&gt;());<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> public void configure() {<a name="line.53"></a>
<FONT color="green">054</FONT> // setup security manager<a name="line.54"></a>
<FONT color="green">055</FONT> bindSecurityManager(bind(SecurityManager.class));<a name="line.55"></a>
<FONT color="green">056</FONT> bindSessionManager(bind(SessionManager.class));<a name="line.56"></a>
<FONT color="green">057</FONT> bindEnvironment(bind(Environment.class));<a name="line.57"></a>
<FONT color="green">058</FONT> bindListener(BeanTypeListener.MATCHER, new BeanTypeListener());<a name="line.58"></a>
<FONT color="green">059</FONT> final DestroyableInjectionListener.DestroyableRegistry registry = new DestroyableInjectionListener.DestroyableRegistry() {<a name="line.59"></a>
<FONT color="green">060</FONT> public void add(Destroyable destroyable) {<a name="line.60"></a>
<FONT color="green">061</FONT> ShiroModule.this.add(destroyable);<a name="line.61"></a>
<FONT color="green">062</FONT> }<a name="line.62"></a>
<FONT color="green">063</FONT> <a name="line.63"></a>
<FONT color="green">064</FONT> @PreDestroy<a name="line.64"></a>
<FONT color="green">065</FONT> public void destroy() throws Exception {<a name="line.65"></a>
<FONT color="green">066</FONT> ShiroModule.this.destroy();<a name="line.66"></a>
<FONT color="green">067</FONT> }<a name="line.67"></a>
<FONT color="green">068</FONT> };<a name="line.68"></a>
<FONT color="green">069</FONT> bindListener(LifecycleTypeListener.MATCHER, new LifecycleTypeListener(registry));<a name="line.69"></a>
<FONT color="green">070</FONT> <a name="line.70"></a>
<FONT color="green">071</FONT> expose(SecurityManager.class);<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> configureShiro();<a name="line.73"></a>
<FONT color="green">074</FONT> bind(realmCollectionKey())<a name="line.74"></a>
<FONT color="green">075</FONT> .to(realmSetKey());<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> bind(DestroyableInjectionListener.DestroyableRegistry.class).toInstance(registry);<a name="line.77"></a>
<FONT color="green">078</FONT> BeanTypeListener.ensureBeanTypeMapExists(binder());<a name="line.78"></a>
<FONT color="green">079</FONT> }<a name="line.79"></a>
<FONT color="green">080</FONT> <a name="line.80"></a>
<FONT color="green">081</FONT> @SuppressWarnings({"unchecked"})<a name="line.81"></a>
<FONT color="green">082</FONT> private Key&lt;Set&lt;Realm&gt;&gt; realmSetKey() {<a name="line.82"></a>
<FONT color="green">083</FONT> return (Key&lt;Set&lt;Realm&gt;&gt;) Key.get(TypeLiteral.get(Types.setOf(Realm.class)));<a name="line.83"></a>
<FONT color="green">084</FONT> }<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> @SuppressWarnings({"unchecked"})<a name="line.86"></a>
<FONT color="green">087</FONT> private Key&lt;Collection&lt;Realm&gt;&gt; realmCollectionKey() {<a name="line.87"></a>
<FONT color="green">088</FONT> return (Key&lt;Collection&lt;Realm&gt;&gt;) Key.get(Types.newParameterizedType(Collection.class, Realm.class));<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> /**<a name="line.91"></a>
<FONT color="green">092</FONT> * Implement this method in order to configure your realms and any other Shiro customization you may need.<a name="line.92"></a>
<FONT color="green">093</FONT> */<a name="line.93"></a>
<FONT color="green">094</FONT> protected abstract void configureShiro();<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> /**<a name="line.96"></a>
<FONT color="green">097</FONT> * This is the preferred manner to bind a realm. The {@link org.apache.shiro.mgt.SecurityManager} will be injected with any Realm bound<a name="line.97"></a>
<FONT color="green">098</FONT> * with this method.<a name="line.98"></a>
<FONT color="green">099</FONT> *<a name="line.99"></a>
<FONT color="green">100</FONT> * @return a binding builder for a realm<a name="line.100"></a>
<FONT color="green">101</FONT> */<a name="line.101"></a>
<FONT color="green">102</FONT> protected final LinkedBindingBuilder&lt;Realm&gt; bindRealm() {<a name="line.102"></a>
<FONT color="green">103</FONT> Multibinder&lt;Realm&gt; multibinder = Multibinder.newSetBinder(binder(), Realm.class);<a name="line.103"></a>
<FONT color="green">104</FONT> return multibinder.addBinding();<a name="line.104"></a>
<FONT color="green">105</FONT> }<a name="line.105"></a>
<FONT color="green">106</FONT> <a name="line.106"></a>
<FONT color="green">107</FONT> /**<a name="line.107"></a>
<FONT color="green">108</FONT> * Binds the security manager. Override this method in order to provide your own security manager binding.<a name="line.108"></a>
<FONT color="green">109</FONT> * &lt;p/&gt;<a name="line.109"></a>
<FONT color="green">110</FONT> * By default, a {@link org.apache.shiro.mgt.DefaultSecurityManager} is bound as an eager singleton.<a name="line.110"></a>
<FONT color="green">111</FONT> *<a name="line.111"></a>
<FONT color="green">112</FONT> * @param bind<a name="line.112"></a>
<FONT color="green">113</FONT> */<a name="line.113"></a>
<FONT color="green">114</FONT> protected void bindSecurityManager(AnnotatedBindingBuilder&lt;? super SecurityManager&gt; bind) {<a name="line.114"></a>
<FONT color="green">115</FONT> try {<a name="line.115"></a>
<FONT color="green">116</FONT> bind.toConstructor(DefaultSecurityManager.class.getConstructor(Collection.class)).asEagerSingleton();<a name="line.116"></a>
<FONT color="green">117</FONT> } catch (NoSuchMethodException e) {<a name="line.117"></a>
<FONT color="green">118</FONT> 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 name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> }<a name="line.120"></a>
<FONT color="green">121</FONT> <a name="line.121"></a>
<FONT color="green">122</FONT> /**<a name="line.122"></a>
<FONT color="green">123</FONT> * Binds the session manager. Override this method in order to provide your own session manager binding.<a name="line.123"></a>
<FONT color="green">124</FONT> * &lt;p/&gt;<a name="line.124"></a>
<FONT color="green">125</FONT> * By default, a {@link org.apache.shiro.session.mgt.DefaultSessionManager} is bound as an eager singleton.<a name="line.125"></a>
<FONT color="green">126</FONT> *<a name="line.126"></a>
<FONT color="green">127</FONT> * @param bind<a name="line.127"></a>
<FONT color="green">128</FONT> */<a name="line.128"></a>
<FONT color="green">129</FONT> protected void bindSessionManager(AnnotatedBindingBuilder&lt;SessionManager&gt; bind) {<a name="line.129"></a>
<FONT color="green">130</FONT> bind.to(DefaultSessionManager.class).asEagerSingleton();<a name="line.130"></a>
<FONT color="green">131</FONT> }<a name="line.131"></a>
<FONT color="green">132</FONT> <a name="line.132"></a>
<FONT color="green">133</FONT> /**<a name="line.133"></a>
<FONT color="green">134</FONT> * Binds the environment. Override this method in order to provide your own environment binding.<a name="line.134"></a>
<FONT color="green">135</FONT> * &lt;p/&gt;<a name="line.135"></a>
<FONT color="green">136</FONT> * By default, a {@link GuiceEnvironment} is bound as an eager singleton.<a name="line.136"></a>
<FONT color="green">137</FONT> *<a name="line.137"></a>
<FONT color="green">138</FONT> * @param bind<a name="line.138"></a>
<FONT color="green">139</FONT> */<a name="line.139"></a>
<FONT color="green">140</FONT> protected void bindEnvironment(AnnotatedBindingBuilder&lt;Environment&gt; bind) {<a name="line.140"></a>
<FONT color="green">141</FONT> bind.to(GuiceEnvironment.class).asEagerSingleton();<a name="line.141"></a>
<FONT color="green">142</FONT> }<a name="line.142"></a>
<FONT color="green">143</FONT> <a name="line.143"></a>
<FONT color="green">144</FONT> /**<a name="line.144"></a>
<FONT color="green">145</FONT> * Binds a key to use for injecting setters in shiro classes.<a name="line.145"></a>
<FONT color="green">146</FONT> * @param typeLiteral the bean property type<a name="line.146"></a>
<FONT color="green">147</FONT> * @param key the key to use to satisfy the bean property dependency<a name="line.147"></a>
<FONT color="green">148</FONT> * @param &lt;T&gt;<a name="line.148"></a>
<FONT color="green">149</FONT> */<a name="line.149"></a>
<FONT color="green">150</FONT> protected final &lt;T&gt; void bindBeanType(TypeLiteral&lt;T&gt; typeLiteral, Key&lt;? extends T&gt; key) {<a name="line.150"></a>
<FONT color="green">151</FONT> BeanTypeListener.bindBeanType(binder(), typeLiteral, key);<a name="line.151"></a>
<FONT color="green">152</FONT> }<a name="line.152"></a>
<FONT color="green">153</FONT> <a name="line.153"></a>
<FONT color="green">154</FONT> /**<a name="line.154"></a>
<FONT color="green">155</FONT> * Destroys all beans created within this module that implement {@link org.apache.shiro.util.Destroyable}. Should be called when this<a name="line.155"></a>
<FONT color="green">156</FONT> * module will no longer be used.<a name="line.156"></a>
<FONT color="green">157</FONT> *<a name="line.157"></a>
<FONT color="green">158</FONT> * @throws Exception<a name="line.158"></a>
<FONT color="green">159</FONT> */<a name="line.159"></a>
<FONT color="green">160</FONT> public final void destroy() throws Exception {<a name="line.160"></a>
<FONT color="green">161</FONT> for (Destroyable destroyable : destroyables) {<a name="line.161"></a>
<FONT color="green">162</FONT> destroyable.destroy();<a name="line.162"></a>
<FONT color="green">163</FONT> }<a name="line.163"></a>
<FONT color="green">164</FONT> }<a name="line.164"></a>
<FONT color="green">165</FONT> <a name="line.165"></a>
<FONT color="green">166</FONT> public void add(Destroyable destroyable) {<a name="line.166"></a>
<FONT color="green">167</FONT> this.destroyables.add(destroyable);<a name="line.167"></a>
<FONT color="green">168</FONT> }<a name="line.168"></a>
<FONT color="green">169</FONT> }<a name="line.169"></a>
</PRE>
</BODY>
</HTML>