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