Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.2 / xref / org / apache / shiro / guice / ShiroModule.html
blob: 913f3054b4c09e7f4b4df5f228d4f220d6c2b95f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ShiroModule xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/shiro/guice/ShiroModule.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.guice;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> com.google.common.collect.Sets;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> com.google.inject.Key;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> com.google.inject.PrivateModule;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> com.google.inject.TypeLiteral;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> com.google.inject.binder.AnnotatedBindingBuilder;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> com.google.inject.binder.LinkedBindingBuilder;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> com.google.inject.multibindings.Multibinder;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> com.google.inject.util.Types;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.config.ConfigurationException;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.env.Environment;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.DefaultSecurityManager;
<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.SecurityManager;
<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.Realm;
<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.DefaultSessionManager;
<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.SessionManager;
<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.Destroyable;
<a name="37" href="#37">37</a>
<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> javax.annotation.PreDestroy;
<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> java.util.WeakHashMap;
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Sets up Shiro lifecycles within Guice, enables the injecting of Shiro objects, and binds a default</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.mgt.SecurityManager} and {@link org.apache.shiro.session.mgt.SessionManager}. At least one realm must be added by using</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * {@link #bindRealm() bindRealm}.</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
<a name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/shiro/guice/ShiroModule.html">ShiroModule</a> <strong class="jxr_keyword">extends</strong> PrivateModule implements <a href="../../../../org/apache/shiro/util/Destroyable.html">Destroyable</a> {
<a name="50" href="#50">50</a>
<a name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> Set&lt;Destroyable&gt; destroyables = Sets.newSetFromMap(<strong class="jxr_keyword">new</strong> WeakHashMap&lt;Destroyable, Boolean&gt;());
<a name="52" href="#52">52</a>
<a name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> configure() {
<a name="54" href="#54">54</a> <em class="jxr_comment">// setup security manager</em>
<a name="55" href="#55">55</a> bindSecurityManager(bind(SecurityManager.<strong class="jxr_keyword">class</strong>));
<a name="56" href="#56">56</a> bindSessionManager(bind(SessionManager.<strong class="jxr_keyword">class</strong>));
<a name="57" href="#57">57</a> bindEnvironment(bind(Environment.<strong class="jxr_keyword">class</strong>));
<a name="58" href="#58">58</a> bindListener(BeanTypeListener.MATCHER, <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/guice/BeanTypeListener.html">BeanTypeListener</a>());
<a name="59" href="#59">59</a> <strong class="jxr_keyword">final</strong> DestroyableInjectionListener.DestroyableRegistry registry = <strong class="jxr_keyword">new</strong> DestroyableInjectionListener.DestroyableRegistry() {
<a name="60" href="#60">60</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> add(<a href="../../../../org/apache/shiro/util/Destroyable.html">Destroyable</a> destroyable) {
<a name="61" href="#61">61</a> ShiroModule.<strong class="jxr_keyword">this</strong>.add(destroyable);
<a name="62" href="#62">62</a> }
<a name="63" href="#63">63</a>
<a name="64" href="#64">64</a> @PreDestroy
<a name="65" href="#65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> destroy() <strong class="jxr_keyword">throws</strong> Exception {
<a name="66" href="#66">66</a> ShiroModule.<strong class="jxr_keyword">this</strong>.destroy();
<a name="67" href="#67">67</a> }
<a name="68" href="#68">68</a> };
<a name="69" href="#69">69</a> bindListener(LifecycleTypeListener.MATCHER, <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/guice/LifecycleTypeListener.html">LifecycleTypeListener</a>(registry));
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> expose(SecurityManager.<strong class="jxr_keyword">class</strong>);
<a name="72" href="#72">72</a>
<a name="73" href="#73">73</a> configureShiro();
<a name="74" href="#74">74</a> bind(realmCollectionKey())
<a name="75" href="#75">75</a> .to(realmSetKey());
<a name="76" href="#76">76</a>
<a name="77" href="#77">77</a> bind(DestroyableInjectionListener.DestroyableRegistry.<strong class="jxr_keyword">class</strong>).toInstance(registry);
<a name="78" href="#78">78</a> BeanTypeListener.ensureBeanTypeMapExists(binder());
<a name="79" href="#79">79</a> }
<a name="80" href="#80">80</a>
<a name="81" href="#81">81</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>})
<a name="82" href="#82">82</a> <strong class="jxr_keyword">private</strong> Key&lt;Set&lt;Realm&gt;&gt; realmSetKey() {
<a name="83" href="#83">83</a> <strong class="jxr_keyword">return</strong> (Key&lt;Set&lt;Realm&gt;&gt;) Key.get(TypeLiteral.get(Types.setOf(Realm.<strong class="jxr_keyword">class</strong>)));
<a name="84" href="#84">84</a> }
<a name="85" href="#85">85</a>
<a name="86" href="#86">86</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>})
<a name="87" href="#87">87</a> <strong class="jxr_keyword">private</strong> Key&lt;Collection&lt;Realm&gt;&gt; realmCollectionKey() {
<a name="88" href="#88">88</a> <strong class="jxr_keyword">return</strong> (Key&lt;Collection&lt;Realm&gt;&gt;) Key.get(Types.newParameterizedType(Collection.<strong class="jxr_keyword">class</strong>, Realm.<strong class="jxr_keyword">class</strong>));
<a name="89" href="#89">89</a> }
<a name="90" href="#90">90</a>
<a name="91" href="#91">91</a> <em class="jxr_javadoccomment">/**</em>
<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * Implement this method in order to configure your realms and any other Shiro customization you may need.</em>
<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em>
<a name="94" href="#94">94</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> configureShiro();
<a name="95" href="#95">95</a>
<a name="96" href="#96">96</a> <em class="jxr_javadoccomment">/**</em>
<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * This is the preferred manner to bind a realm. The {@link org.apache.shiro.mgt.SecurityManager} will be injected with any Realm bound</em>
<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * with this method.</em>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> *</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @return a binding builder for a realm</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> */</em>
<a name="102" href="#102">102</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> LinkedBindingBuilder&lt;Realm&gt; bindRealm() {
<a name="103" href="#103">103</a> Multibinder&lt;Realm&gt; multibinder = Multibinder.newSetBinder(binder(), Realm.<strong class="jxr_keyword">class</strong>);
<a name="104" href="#104">104</a> <strong class="jxr_keyword">return</strong> multibinder.addBinding();
<a name="105" href="#105">105</a> }
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">/**</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * Binds the security manager. Override this method in order to provide your own security manager binding.</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * By default, a {@link org.apache.shiro.mgt.DefaultSecurityManager} is bound as an eager singleton.</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> *</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * @param bind</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> */</em>
<a name="114" href="#114">114</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> bindSecurityManager(AnnotatedBindingBuilder&lt;? <strong class="jxr_keyword">super</strong> SecurityManager&gt; bind) {
<a name="115" href="#115">115</a> <strong class="jxr_keyword">try</strong> {
<a name="116" href="#116">116</a> bind.toConstructor(DefaultSecurityManager.<strong class="jxr_keyword">class</strong>.getConstructor(Collection.<strong class="jxr_keyword">class</strong>)).asEagerSingleton();
<a name="117" href="#117">117</a> } <strong class="jxr_keyword">catch</strong> (NoSuchMethodException e) {
<a name="118" href="#118">118</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/config/ConfigurationException.html">ConfigurationException</a>(<span class="jxr_string">"This really shouldn't happen. Either something has changed in Shiro, or there's a bug in "</span> + ShiroModule.<strong class="jxr_keyword">class</strong>.getSimpleName(), e);
<a name="119" href="#119">119</a> }
<a name="120" href="#120">120</a> }
<a name="121" href="#121">121</a>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">/**</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * Binds the session manager. Override this method in order to provide your own session manager binding.</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * By default, a {@link org.apache.shiro.session.mgt.DefaultSessionManager} is bound as an eager singleton.</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> *</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @param bind</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em>
<a name="129" href="#129">129</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> bindSessionManager(AnnotatedBindingBuilder&lt;SessionManager&gt; bind) {
<a name="130" href="#130">130</a> bind.to(DefaultSessionManager.<strong class="jxr_keyword">class</strong>).asEagerSingleton();
<a name="131" href="#131">131</a> }
<a name="132" href="#132">132</a>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">/**</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * Binds the environment. Override this method in order to provide your own environment binding.</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * By default, a {@link GuiceEnvironment} is bound as an eager singleton.</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> *</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * @param bind</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> */</em>
<a name="140" href="#140">140</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> bindEnvironment(AnnotatedBindingBuilder&lt;Environment&gt; bind) {
<a name="141" href="#141">141</a> bind.to(GuiceEnvironment.<strong class="jxr_keyword">class</strong>).asEagerSingleton();
<a name="142" href="#142">142</a> }
<a name="143" href="#143">143</a>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">/**</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * Binds a key to use for injecting setters in shiro classes.</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @param typeLiteral the bean property type</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * @param key the key to use to satisfy the bean property dependency</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @param &lt;T&gt;</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> */</em>
<a name="150" href="#150">150</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> &lt;T&gt; <strong class="jxr_keyword">void</strong> bindBeanType(TypeLiteral&lt;T&gt; typeLiteral, Key&lt;? <strong class="jxr_keyword">extends</strong> T&gt; key) {
<a name="151" href="#151">151</a> BeanTypeListener.bindBeanType(binder(), typeLiteral, key);
<a name="152" href="#152">152</a> }
<a name="153" href="#153">153</a>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">/**</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * Destroys all beans created within this module that implement {@link org.apache.shiro.util.Destroyable}. Should be called when this</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * module will no longer be used.</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> *</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * @throws Exception</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> */</em>
<a name="160" href="#160">160</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> destroy() <strong class="jxr_keyword">throws</strong> Exception {
<a name="161" href="#161">161</a> <strong class="jxr_keyword">for</strong> (Destroyable destroyable : destroyables) {
<a name="162" href="#162">162</a> destroyable.destroy();
<a name="163" href="#163">163</a> }
<a name="164" href="#164">164</a> }
<a name="165" href="#165">165</a>
<a name="166" href="#166">166</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> add(<a href="../../../../org/apache/shiro/util/Destroyable.html">Destroyable</a> destroyable) {
<a name="167" href="#167">167</a> <strong class="jxr_keyword">this</strong>.destroyables.add(destroyable);
<a name="168" href="#168">168</a> }
<a name="169" href="#169">169</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>