Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.5 / apidocs / src-html / org / apache / shiro / mgt / RealmSecurityManager.html
blob: b08d61e83a6dc1e6e71d56e91ddff10ac9155393 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.mgt;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.cache.CacheManager;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.cache.CacheManagerAware;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.shiro.realm.Realm;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.shiro.util.LifecycleUtils;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.ArrayList;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Collection;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Shiro support of a {@link SecurityManager} class hierarchy based around a collection of<a name="line.31"></a>
<span class="sourceLineNo">032</span> * {@link org.apache.shiro.realm.Realm}s. All actual {@code SecurityManager} method implementations are left to<a name="line.32"></a>
<span class="sourceLineNo">033</span> * subclasses.<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @since 0.9<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>public abstract class RealmSecurityManager extends CachingSecurityManager {<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> /**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Internal collection of &lt;code&gt;Realm&lt;/code&gt;s used for all authentication and authorization operations.<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span> private Collection&lt;Realm&gt; realms;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Default no-arg constructor.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> public RealmSecurityManager() {<a name="line.47"></a>
<span class="sourceLineNo">048</span> super();<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Convenience method for applications using a single realm that merely wraps the realm in a list and then invokes<a name="line.52"></a>
<span class="sourceLineNo">053</span> * the {@link #setRealms} method.<a name="line.53"></a>
<span class="sourceLineNo">054</span> *<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @param realm the realm to set for a single-realm application.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @since 0.2<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> public void setRealm(Realm realm) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> if (realm == null) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> throw new IllegalArgumentException("Realm argument cannot be null");<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span> Collection&lt;Realm&gt; realms = new ArrayList&lt;Realm&gt;(1);<a name="line.62"></a>
<span class="sourceLineNo">063</span> realms.add(realm);<a name="line.63"></a>
<span class="sourceLineNo">064</span> setRealms(realms);<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Sets the realms managed by this &lt;tt&gt;SecurityManager&lt;/tt&gt; instance.<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @param realms the realms managed by this &lt;tt&gt;SecurityManager&lt;/tt&gt; instance.<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @throws IllegalArgumentException if the realms collection is null or empty.<a name="line.71"></a>
<span class="sourceLineNo">072</span> */<a name="line.72"></a>
<span class="sourceLineNo">073</span> public void setRealms(Collection&lt;Realm&gt; realms) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> if (realms == null) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> throw new IllegalArgumentException("Realms collection argument cannot be null.");<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span> if (realms.isEmpty()) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> throw new IllegalArgumentException("Realms collection argument cannot be empty.");<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span> this.realms = realms;<a name="line.80"></a>
<span class="sourceLineNo">081</span> afterRealmsSet();<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> protected void afterRealmsSet() {<a name="line.84"></a>
<span class="sourceLineNo">085</span> applyCacheManagerToRealms();<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /**<a name="line.88"></a>
<span class="sourceLineNo">089</span> * Returns the {@link Realm Realm}s managed by this SecurityManager instance.<a name="line.89"></a>
<span class="sourceLineNo">090</span> *<a name="line.90"></a>
<span class="sourceLineNo">091</span> * @return the {@link Realm Realm}s managed by this SecurityManager instance.<a name="line.91"></a>
<span class="sourceLineNo">092</span> */<a name="line.92"></a>
<span class="sourceLineNo">093</span> public Collection&lt;Realm&gt; getRealms() {<a name="line.93"></a>
<span class="sourceLineNo">094</span> return realms;<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> /**<a name="line.97"></a>
<span class="sourceLineNo">098</span> * Sets the internal {@link #getCacheManager CacheManager} on any internal configured<a name="line.98"></a>
<span class="sourceLineNo">099</span> * {@link #getRealms Realms} that implement the {@link org.apache.shiro.cache.CacheManagerAware CacheManagerAware} interface.<a name="line.99"></a>
<span class="sourceLineNo">100</span> * &lt;p/&gt;<a name="line.100"></a>
<span class="sourceLineNo">101</span> * This method is called after setting a cacheManager on this securityManager via the<a name="line.101"></a>
<span class="sourceLineNo">102</span> * {@link #setCacheManager(org.apache.shiro.cache.CacheManager) setCacheManager} method to allow it to be propagated<a name="line.102"></a>
<span class="sourceLineNo">103</span> * down to all the internal Realms that would need to use it.<a name="line.103"></a>
<span class="sourceLineNo">104</span> * &lt;p/&gt;<a name="line.104"></a>
<span class="sourceLineNo">105</span> * It is also called after setting one or more realms via the {@link #setRealm setRealm} or<a name="line.105"></a>
<span class="sourceLineNo">106</span> * {@link #setRealms setRealms} methods to allow these newly available realms to be given the cache manager<a name="line.106"></a>
<span class="sourceLineNo">107</span> * already in use.<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> protected void applyCacheManagerToRealms() {<a name="line.109"></a>
<span class="sourceLineNo">110</span> CacheManager cacheManager = getCacheManager();<a name="line.110"></a>
<span class="sourceLineNo">111</span> Collection&lt;Realm&gt; realms = getRealms();<a name="line.111"></a>
<span class="sourceLineNo">112</span> if (cacheManager != null &amp;&amp; realms != null &amp;&amp; !realms.isEmpty()) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> for (Realm realm : realms) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> if (realm instanceof CacheManagerAware) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> ((CacheManagerAware) realm).setCacheManager(cacheManager);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> /**<a name="line.121"></a>
<span class="sourceLineNo">122</span> * Simply calls {@link #applyCacheManagerToRealms() applyCacheManagerToRealms()} to allow the<a name="line.122"></a>
<span class="sourceLineNo">123</span> * 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>
<span class="sourceLineNo">124</span> * that would need to use it.<a name="line.124"></a>
<span class="sourceLineNo">125</span> */<a name="line.125"></a>
<span class="sourceLineNo">126</span> protected void afterCacheManagerSet() {<a name="line.126"></a>
<span class="sourceLineNo">127</span> applyCacheManagerToRealms();<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> public void destroy() {<a name="line.130"></a>
<span class="sourceLineNo">131</span> LifecycleUtils.destroy(getRealms());<a name="line.131"></a>
<span class="sourceLineNo">132</span> this.realms = null;<a name="line.132"></a>
<span class="sourceLineNo">133</span> super.destroy();<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span>}<a name="line.136"></a>
</pre>
</div>
</body>
</html>