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