| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="fr"> |
| <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.event.EventBus;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.event.EventBusAware;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.event.support.DefaultEventBus;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.util.Destroyable;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.shiro.util.LifecycleUtils;<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> * A very basic starting point for the SecurityManager interface that merely provides logging and caching<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * support. All actual {@code SecurityManager} method implementations are left to subclasses.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <p/><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <b>Change in 1.0</b> - a default {@code CacheManager} instance is <em>not</em> created by default during<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * instantiation. As caching strategies can vary greatly depending on an application's needs, a {@code CacheManager}<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * instance must be explicitly configured if caching across the framework is to be enabled.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> *<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @since 0.9<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>public abstract class CachingSecurityManager implements SecurityManager, Destroyable, CacheManagerAware, EventBusAware {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> /**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * The CacheManager to use to perform caching operations to enhance performance. Can be null.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> private CacheManager cacheManager;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * The EventBus to use to use to publish and receive events of interest during Shiro's lifecycle.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @since 1.3<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private EventBus eventBus;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Default no-arg constructor that will automatically attempt to initialize a default cacheManager<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public CachingSecurityManager() {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> //use a default event bus:<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> setEventBus(new DefaultEventBus());<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> }<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Returns the CacheManager used by this SecurityManager.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> *<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @return the cacheManager used by this SecurityManager<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> public CacheManager getCacheManager() {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> return cacheManager;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * Sets the CacheManager used by this {@code SecurityManager} and potentially any of its<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * children components.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <p/><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * After the cacheManager attribute has been set, the template method<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * {@link #afterCacheManagerSet afterCacheManagerSet()} is executed to allow subclasses to adjust when a<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * cacheManager is available.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param cacheManager the CacheManager used by this {@code SecurityManager} and potentially any of its<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * children components.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public void setCacheManager(CacheManager cacheManager) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> this.cacheManager = cacheManager;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> afterCacheManagerSet();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * Template callback to notify subclasses that a<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * {@link org.apache.shiro.cache.CacheManager CacheManager} has been set and is available for use via the<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * {@link #getCacheManager getCacheManager()} method.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> protected void afterCacheManagerSet() {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> applyEventBusToCacheManager();<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Returns the {@code EventBus} used by this SecurityManager and potentially any of its children components.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> *<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @return the {@code EventBus} used by this SecurityManager and potentially any of its children components.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @since 1.3<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> */<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> public EventBus getEventBus() {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> return eventBus;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Sets the EventBus used by this {@code SecurityManager} and potentially any of its<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * children components.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * <p/><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * After the eventBus attribute has been set, the template method<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * {@link #afterEventBusSet() afterEventBusSet()} is executed to allow subclasses to adjust when a<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * eventBus is available.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> *<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param eventBus the EventBus used by this {@code SecurityManager} and potentially any of its<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * children components.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @since 1.3<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> public void setEventBus(EventBus eventBus) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> this.eventBus = eventBus;<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> afterEventBusSet();<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> /**<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * @since 1.3<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> */<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> protected void applyEventBusToCacheManager() {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> if (this.eventBus != null && this.cacheManager != null && this.cacheManager instanceof EventBusAware) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> ((EventBusAware)this.cacheManager).setEventBus(this.eventBus);<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><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> /**<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * Template callback to notify subclasses that an {@link EventBus EventBus} has been set and is available for use<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * via the {@link #getEventBus() getEventBus()} method.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> *<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * @since 1.3<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> */<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> protected void afterEventBusSet() {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> applyEventBusToCacheManager();<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> /**<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * Destroys the {@link #getCacheManager() cacheManager} via {@link LifecycleUtils#destroy LifecycleUtils.destroy}.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> public void destroy() {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> LifecycleUtils.destroy(getCacheManager());<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> this.cacheManager = null;<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> LifecycleUtils.destroy(getEventBus());<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> this.eventBus = new DefaultEventBus();<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span>}<a name="line.151"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
