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