| <!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.env;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.mgt.SecurityManager;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.util.Destroyable;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.util.LifecycleUtils;</a> |
| <span class="sourceLineNo">024</span><a id="line.24"></a> |
| <span class="sourceLineNo">025</span><a id="line.25">import java.util.Map;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import java.util.concurrent.ConcurrentHashMap;</a> |
| <span class="sourceLineNo">027</span><a id="line.27"></a> |
| <span class="sourceLineNo">028</span><a id="line.28">/**</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * Simple/default {@code Environment} implementation that stores Shiro objects as key-value pairs in a</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * {@link java.util.Map Map} instance. The key is the object name, the value is the object itself.</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> *</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * @since 1.2</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> */</a> |
| <span class="sourceLineNo">034</span><a id="line.34">public class DefaultEnvironment implements NamedObjectEnvironment, Destroyable {</a> |
| <span class="sourceLineNo">035</span><a id="line.35"></a> |
| <span class="sourceLineNo">036</span><a id="line.36"> /**</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * The default name under which the application's {@code SecurityManager} instance may be acquired, equal to</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * {@code securityManager}.</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> */</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> public static final String DEFAULT_SECURITY_MANAGER_KEY = "securityManager";</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> protected final Map<String, Object> objects;</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> private String securityManagerName;</a> |
| <span class="sourceLineNo">044</span><a id="line.44"></a> |
| <span class="sourceLineNo">045</span><a id="line.45"> /**</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * Creates a new instance with a thread-safe {@link ConcurrentHashMap} backing map.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> */</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> public DefaultEnvironment() {</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> this(new ConcurrentHashMap<String, Object>());</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> }</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"> * Creates a new instance with the specified backing map.</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> *</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @param seed backing map to use to maintain Shiro objects.</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> */</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> @SuppressWarnings({"unchecked"})</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> public DefaultEnvironment(Map<String, ?> seed) {</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> this.securityManagerName = DEFAULT_SECURITY_MANAGER_KEY;</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> if (seed == null) {</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> throw new IllegalArgumentException("Backing map cannot be null.");</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> }</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> this.objects = (Map<String, Object>) seed;</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> }</a> |
| <span class="sourceLineNo">065</span><a id="line.65"></a> |
| <span class="sourceLineNo">066</span><a id="line.66"> /**</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * Returns the application's {@code SecurityManager} instance accessible in the backing map using the</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * {@link #getSecurityManagerName() securityManagerName} property as the lookup key.</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * <p/></a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * This implementation guarantees that a non-null instance is always returned, as this is expected for</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * Environment API end-users. If subclasses have the need to perform the map lookup without this guarantee</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * (for example, during initialization when the instance may not have been added to the map yet), the</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * {@link #lookupSecurityManager()} method is provided as an alternative.</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> *</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * @return the application's {@code SecurityManager} instance accessible in the backing map using the</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * {@link #getSecurityManagerName() securityManagerName} property as the lookup key.</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> */</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> public SecurityManager getSecurityManager() throws IllegalStateException {</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> SecurityManager securityManager = lookupSecurityManager();</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> if (securityManager == null) {</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> throw new IllegalStateException("No SecurityManager found in Environment. This is an invalid " +</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> "environment state.");</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> }</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> return securityManager;</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"> public void setSecurityManager(SecurityManager securityManager) {</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> if (securityManager == null) {</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> throw new IllegalArgumentException("Null SecurityManager instances are not allowed.");</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> }</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> String name = getSecurityManagerName();</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> setObject(name, securityManager);</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"> * Looks up the {@code SecurityManager} instance in the backing map without performing any non-null guarantees.</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> *</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * @return the {@code SecurityManager} in the backing map, or {@code null} if it has not yet been populated.</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> */</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> protected SecurityManager lookupSecurityManager() {</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> String name = getSecurityManagerName();</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> return getObject(name, SecurityManager.class);</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"> * Returns the name of the {@link SecurityManager} instance in the backing map. Used as a key to lookup the</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> * instance. Unless set otherwise, the default is {@code securityManager}.</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> *</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> * @return the name of the {@link SecurityManager} instance in the backing map. Used as a key to lookup the</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * instance.</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> */</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> public String getSecurityManagerName() {</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> return securityManagerName;</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> }</a> |
| <span class="sourceLineNo">115</span><a id="line.115"></a> |
| <span class="sourceLineNo">116</span><a id="line.116"> /**</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> * Sets the name of the {@link SecurityManager} instance in the backing map. Used as a key to lookup the</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * instance. Unless set otherwise, the default is {@code securityManager}.</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> *</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * @param securityManagerName the name of the {@link SecurityManager} instance in the backing map. Used as a key</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * to lookup the instance. </a> |
| <span class="sourceLineNo">122</span><a id="line.122"> */</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> public void setSecurityManagerName(String securityManagerName) {</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> this.securityManagerName = securityManagerName;</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> }</a> |
| <span class="sourceLineNo">126</span><a id="line.126"></a> |
| <span class="sourceLineNo">127</span><a id="line.127"> /**</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> * Returns the live (modifiable) internal objects collection.</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> *</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * @return the live (modifiable) internal objects collection.</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> */</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> public Map<String,Object> getObjects() {</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> return this.objects;</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> }</a> |
| <span class="sourceLineNo">135</span><a id="line.135"></a> |
| <span class="sourceLineNo">136</span><a id="line.136"> @SuppressWarnings({"unchecked"})</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> public <T> T getObject(String name, Class<T> requiredType) throws RequiredTypeException {</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> if (name == null) {</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> throw new NullPointerException("name parameter cannot be null.");</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> }</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> if (requiredType == null) {</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> throw new NullPointerException("requiredType parameter cannot be null.");</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> }</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> Object o = this.objects.get(name);</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> if (o == null) {</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> return null;</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> }</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> if (!requiredType.isInstance(o)) {</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> String msg = "Object named '" + name + "' (of type [" + o.getClass().getName() + "]) is not of required type [" + requiredType.getName() + "].";</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> throw new RequiredTypeException(msg);</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> }</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> return (T)o;</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> }</a> |
| <span class="sourceLineNo">154</span><a id="line.154"></a> |
| <span class="sourceLineNo">155</span><a id="line.155"> public void setObject(String name, Object instance) {</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> if (name == null) {</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> throw new NullPointerException("name parameter cannot be null.");</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> }</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> if (instance == null) {</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> this.objects.remove(name);</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> } else {</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> this.objects.put(name, instance);</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> }</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"></a> |
| <span class="sourceLineNo">167</span><a id="line.167"> public void destroy() throws Exception {</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> LifecycleUtils.destroy(this.objects.values());</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> }</a> |
| <span class="sourceLineNo">170</span><a id="line.170">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
