Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.6.0 / apidocs / src-html / org / apache / shiro / mgt / RealmSecurityManager.html
blob: 5bc409f2f655a464c6197d165718e1205f15b07c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<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.mgt;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.cache.CacheManager;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.cache.CacheManagerAware;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.event.EventBus;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.event.EventBusAware;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.realm.Realm;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.util.LifecycleUtils;</a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">import java.util.ArrayList;</a>
<span class="sourceLineNo">029</span><a id="line.29">import java.util.Collection;</a>
<span class="sourceLineNo">030</span><a id="line.30"></a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32">/**</a>
<span class="sourceLineNo">033</span><a id="line.33"> * Shiro support of a {@link SecurityManager} class hierarchy based around a collection of</a>
<span class="sourceLineNo">034</span><a id="line.34"> * {@link org.apache.shiro.realm.Realm}s. All actual {@code SecurityManager} method implementations are left to</a>
<span class="sourceLineNo">035</span><a id="line.35"> * subclasses.</a>
<span class="sourceLineNo">036</span><a id="line.36"> *</a>
<span class="sourceLineNo">037</span><a id="line.37"> * @since 0.9</a>
<span class="sourceLineNo">038</span><a id="line.38"> */</a>
<span class="sourceLineNo">039</span><a id="line.39">public abstract class RealmSecurityManager extends CachingSecurityManager {</a>
<span class="sourceLineNo">040</span><a id="line.40"></a>
<span class="sourceLineNo">041</span><a id="line.41"> /**</a>
<span class="sourceLineNo">042</span><a id="line.42"> * Internal collection of &lt;code&gt;Realm&lt;/code&gt;s used for all authentication and authorization operations.</a>
<span class="sourceLineNo">043</span><a id="line.43"> */</a>
<span class="sourceLineNo">044</span><a id="line.44"> private Collection&lt;Realm&gt; realms;</a>
<span class="sourceLineNo">045</span><a id="line.45"></a>
<span class="sourceLineNo">046</span><a id="line.46"> /**</a>
<span class="sourceLineNo">047</span><a id="line.47"> * Default no-arg constructor.</a>
<span class="sourceLineNo">048</span><a id="line.48"> */</a>
<span class="sourceLineNo">049</span><a id="line.49"> public RealmSecurityManager() {</a>
<span class="sourceLineNo">050</span><a id="line.50"> super();</a>
<span class="sourceLineNo">051</span><a id="line.51"> }</a>
<span class="sourceLineNo">052</span><a id="line.52"></a>
<span class="sourceLineNo">053</span><a id="line.53"> /**</a>
<span class="sourceLineNo">054</span><a id="line.54"> * Convenience method for applications using a single realm that merely wraps the realm in a list and then invokes</a>
<span class="sourceLineNo">055</span><a id="line.55"> * the {@link #setRealms} method.</a>
<span class="sourceLineNo">056</span><a id="line.56"> *</a>
<span class="sourceLineNo">057</span><a id="line.57"> * @param realm the realm to set for a single-realm application.</a>
<span class="sourceLineNo">058</span><a id="line.58"> * @since 0.2</a>
<span class="sourceLineNo">059</span><a id="line.59"> */</a>
<span class="sourceLineNo">060</span><a id="line.60"> public void setRealm(Realm realm) {</a>
<span class="sourceLineNo">061</span><a id="line.61"> if (realm == null) {</a>
<span class="sourceLineNo">062</span><a id="line.62"> throw new IllegalArgumentException("Realm argument cannot be null");</a>
<span class="sourceLineNo">063</span><a id="line.63"> }</a>
<span class="sourceLineNo">064</span><a id="line.64"> Collection&lt;Realm&gt; realms = new ArrayList&lt;Realm&gt;(1);</a>
<span class="sourceLineNo">065</span><a id="line.65"> realms.add(realm);</a>
<span class="sourceLineNo">066</span><a id="line.66"> setRealms(realms);</a>
<span class="sourceLineNo">067</span><a id="line.67"> }</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> /**</a>
<span class="sourceLineNo">070</span><a id="line.70"> * Sets the realms managed by this &lt;tt&gt;SecurityManager&lt;/tt&gt; instance.</a>
<span class="sourceLineNo">071</span><a id="line.71"> *</a>
<span class="sourceLineNo">072</span><a id="line.72"> * @param realms the realms managed by this &lt;tt&gt;SecurityManager&lt;/tt&gt; instance.</a>
<span class="sourceLineNo">073</span><a id="line.73"> * @throws IllegalArgumentException if the realms collection is null or empty.</a>
<span class="sourceLineNo">074</span><a id="line.74"> */</a>
<span class="sourceLineNo">075</span><a id="line.75"> public void setRealms(Collection&lt;Realm&gt; realms) {</a>
<span class="sourceLineNo">076</span><a id="line.76"> if (realms == null) {</a>
<span class="sourceLineNo">077</span><a id="line.77"> throw new IllegalArgumentException("Realms collection argument cannot be null.");</a>
<span class="sourceLineNo">078</span><a id="line.78"> }</a>
<span class="sourceLineNo">079</span><a id="line.79"> if (realms.isEmpty()) {</a>
<span class="sourceLineNo">080</span><a id="line.80"> throw new IllegalArgumentException("Realms collection argument cannot be empty.");</a>
<span class="sourceLineNo">081</span><a id="line.81"> }</a>
<span class="sourceLineNo">082</span><a id="line.82"> this.realms = realms;</a>
<span class="sourceLineNo">083</span><a id="line.83"> afterRealmsSet();</a>
<span class="sourceLineNo">084</span><a id="line.84"> }</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"> protected void afterRealmsSet() {</a>
<span class="sourceLineNo">087</span><a id="line.87"> applyCacheManagerToRealms();</a>
<span class="sourceLineNo">088</span><a id="line.88"> applyEventBusToRealms();</a>
<span class="sourceLineNo">089</span><a id="line.89"> }</a>
<span class="sourceLineNo">090</span><a id="line.90"></a>
<span class="sourceLineNo">091</span><a id="line.91"> /**</a>
<span class="sourceLineNo">092</span><a id="line.92"> * Returns the {@link Realm Realm}s managed by this SecurityManager instance.</a>
<span class="sourceLineNo">093</span><a id="line.93"> *</a>
<span class="sourceLineNo">094</span><a id="line.94"> * @return the {@link Realm Realm}s managed by this SecurityManager instance.</a>
<span class="sourceLineNo">095</span><a id="line.95"> */</a>
<span class="sourceLineNo">096</span><a id="line.96"> public Collection&lt;Realm&gt; getRealms() {</a>
<span class="sourceLineNo">097</span><a id="line.97"> return realms;</a>
<span class="sourceLineNo">098</span><a id="line.98"> }</a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100"> /**</a>
<span class="sourceLineNo">101</span><a id="line.101"> * Sets the internal {@link #getCacheManager CacheManager} on any internal configured</a>
<span class="sourceLineNo">102</span><a id="line.102"> * {@link #getRealms Realms} that implement the {@link org.apache.shiro.cache.CacheManagerAware CacheManagerAware} interface.</a>
<span class="sourceLineNo">103</span><a id="line.103"> * &lt;p/&gt;</a>
<span class="sourceLineNo">104</span><a id="line.104"> * This method is called after setting a cacheManager on this securityManager via the</a>
<span class="sourceLineNo">105</span><a id="line.105"> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) setCacheManager} method to allow it to be propagated</a>
<span class="sourceLineNo">106</span><a id="line.106"> * down to all the internal Realms that would need to use it.</a>
<span class="sourceLineNo">107</span><a id="line.107"> * &lt;p/&gt;</a>
<span class="sourceLineNo">108</span><a id="line.108"> * It is also called after setting one or more realms via the {@link #setRealm setRealm} or</a>
<span class="sourceLineNo">109</span><a id="line.109"> * {@link #setRealms setRealms} methods to allow these newly available realms to be given the cache manager</a>
<span class="sourceLineNo">110</span><a id="line.110"> * already in use.</a>
<span class="sourceLineNo">111</span><a id="line.111"> */</a>
<span class="sourceLineNo">112</span><a id="line.112"> protected void applyCacheManagerToRealms() {</a>
<span class="sourceLineNo">113</span><a id="line.113"> CacheManager cacheManager = getCacheManager();</a>
<span class="sourceLineNo">114</span><a id="line.114"> Collection&lt;Realm&gt; realms = getRealms();</a>
<span class="sourceLineNo">115</span><a id="line.115"> if (cacheManager != null &amp;&amp; realms != null &amp;&amp; !realms.isEmpty()) {</a>
<span class="sourceLineNo">116</span><a id="line.116"> for (Realm realm : realms) {</a>
<span class="sourceLineNo">117</span><a id="line.117"> if (realm instanceof CacheManagerAware) {</a>
<span class="sourceLineNo">118</span><a id="line.118"> ((CacheManagerAware) realm).setCacheManager(cacheManager);</a>
<span class="sourceLineNo">119</span><a id="line.119"> }</a>
<span class="sourceLineNo">120</span><a id="line.120"> }</a>
<span class="sourceLineNo">121</span><a id="line.121"> }</a>
<span class="sourceLineNo">122</span><a id="line.122"> }</a>
<span class="sourceLineNo">123</span><a id="line.123"></a>
<span class="sourceLineNo">124</span><a id="line.124"> /**</a>
<span class="sourceLineNo">125</span><a id="line.125"> * Sets the internal {@link #getEventBus EventBus} on any internal configured</a>
<span class="sourceLineNo">126</span><a id="line.126"> * {@link #getRealms Realms} that implement the {@link EventBusAware} interface.</a>
<span class="sourceLineNo">127</span><a id="line.127"> * &lt;p/&gt;</a>
<span class="sourceLineNo">128</span><a id="line.128"> * This method is called after setting an eventBus on this securityManager via the</a>
<span class="sourceLineNo">129</span><a id="line.129"> * {@link #setEventBus(org.apache.shiro.event.EventBus) setEventBus} method to allow it to be propagated</a>
<span class="sourceLineNo">130</span><a id="line.130"> * down to all the internal Realms that would need to use it.</a>
<span class="sourceLineNo">131</span><a id="line.131"> * &lt;p/&gt;</a>
<span class="sourceLineNo">132</span><a id="line.132"> * It is also called after setting one or more realms via the {@link #setRealm setRealm} or</a>
<span class="sourceLineNo">133</span><a id="line.133"> * {@link #setRealms setRealms} methods to allow these newly available realms to be given the EventBus</a>
<span class="sourceLineNo">134</span><a id="line.134"> * already in use.</a>
<span class="sourceLineNo">135</span><a id="line.135"> *</a>
<span class="sourceLineNo">136</span><a id="line.136"> * @since 1.3</a>
<span class="sourceLineNo">137</span><a id="line.137"> */</a>
<span class="sourceLineNo">138</span><a id="line.138"> protected void applyEventBusToRealms() {</a>
<span class="sourceLineNo">139</span><a id="line.139"> EventBus eventBus = getEventBus();</a>
<span class="sourceLineNo">140</span><a id="line.140"> Collection&lt;Realm&gt; realms = getRealms();</a>
<span class="sourceLineNo">141</span><a id="line.141"> if (eventBus != null &amp;&amp; realms != null &amp;&amp; !realms.isEmpty()) {</a>
<span class="sourceLineNo">142</span><a id="line.142"> for(Realm realm : realms) {</a>
<span class="sourceLineNo">143</span><a id="line.143"> if (realm instanceof EventBusAware) {</a>
<span class="sourceLineNo">144</span><a id="line.144"> ((EventBusAware)realm).setEventBus(eventBus);</a>
<span class="sourceLineNo">145</span><a id="line.145"> }</a>
<span class="sourceLineNo">146</span><a id="line.146"> }</a>
<span class="sourceLineNo">147</span><a id="line.147"> }</a>
<span class="sourceLineNo">148</span><a id="line.148"> }</a>
<span class="sourceLineNo">149</span><a id="line.149"></a>
<span class="sourceLineNo">150</span><a id="line.150"> /**</a>
<span class="sourceLineNo">151</span><a id="line.151"> * Simply calls {@link #applyCacheManagerToRealms() applyCacheManagerToRealms()} to allow the</a>
<span class="sourceLineNo">152</span><a id="line.152"> * newly set {@link org.apache.shiro.cache.CacheManager CacheManager} to be propagated to the internal collection of &lt;code&gt;Realm&lt;/code&gt;</a>
<span class="sourceLineNo">153</span><a id="line.153"> * that would need to use it.</a>
<span class="sourceLineNo">154</span><a id="line.154"> */</a>
<span class="sourceLineNo">155</span><a id="line.155"> protected void afterCacheManagerSet() {</a>
<span class="sourceLineNo">156</span><a id="line.156"> super.afterCacheManagerSet();</a>
<span class="sourceLineNo">157</span><a id="line.157"> applyCacheManagerToRealms();</a>
<span class="sourceLineNo">158</span><a id="line.158"> }</a>
<span class="sourceLineNo">159</span><a id="line.159"></a>
<span class="sourceLineNo">160</span><a id="line.160"> @Override</a>
<span class="sourceLineNo">161</span><a id="line.161"> protected void afterEventBusSet() {</a>
<span class="sourceLineNo">162</span><a id="line.162"> super.afterEventBusSet();</a>
<span class="sourceLineNo">163</span><a id="line.163"> applyEventBusToRealms();</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"> public void destroy() {</a>
<span class="sourceLineNo">167</span><a id="line.167"> LifecycleUtils.destroy(getRealms());</a>
<span class="sourceLineNo">168</span><a id="line.168"> this.realms = null;</a>
<span class="sourceLineNo">169</span><a id="line.169"> super.destroy();</a>
<span class="sourceLineNo">170</span><a id="line.170"> }</a>
<span class="sourceLineNo">171</span><a id="line.171"></a>
<span class="sourceLineNo">172</span><a id="line.172">}</a>
</pre>
</div>
</main>
</body>
</html>