| <!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.config;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.commons.beanutils.BeanUtils;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.commons.beanutils.PropertyUtils;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.codec.Base64;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.codec.Hex;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.config.event.BeanEvent;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.config.event.ConfiguredBeanEvent;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.shiro.config.event.DestroyedBeanEvent;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.shiro.config.event.InitializedBeanEvent;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.shiro.config.event.InstantiatedBeanEvent;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.shiro.event.EventBus;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.shiro.event.EventBusAware;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.shiro.event.Subscribe;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.shiro.event.support.DefaultEventBus;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.shiro.util.Assert;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.shiro.util.ByteSource;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.shiro.util.ClassUtils;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.shiro.util.CollectionUtils;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.shiro.util.Factory;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.shiro.util.LifecycleUtils;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.shiro.util.Nameable;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.shiro.util.StringUtils;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.slf4j.Logger;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.slf4j.LoggerFactory;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import java.beans.PropertyDescriptor;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import java.util.ArrayList;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import java.util.Arrays;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import java.util.Collection;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import java.util.Collections;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import java.util.LinkedHashMap;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import java.util.LinkedHashSet;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import java.util.List;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import java.util.Map;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import java.util.Set;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span>/**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Object builder that uses reflection and Apache Commons BeanUtils to build objects given a<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * map of "property values". Typically these come from the Shiro INI configuration and are used<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * to construct or modify the SecurityManager, its dependencies, and web-based security filters.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <p/><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Recognizes {@link Factory} implementations and will call<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * {@link org.apache.shiro.util.Factory#getInstance() getInstance} to satisfy any reference to this bean.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> *<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @since 0.9<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span>public class ReflectionBuilder {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> //TODO - complete JavaDoc<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> private static final Logger log = LoggerFactory.getLogger(ReflectionBuilder.class);<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private static final String OBJECT_REFERENCE_BEGIN_TOKEN = "$";<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> private static final String ESCAPED_OBJECT_REFERENCE_BEGIN_TOKEN = "\\$";<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> private static final String GLOBAL_PROPERTY_PREFIX = "shiro";<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> private static final char MAP_KEY_VALUE_DELIMITER = ':';<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> private static final String HEX_BEGIN_TOKEN = "0x";<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> private static final String NULL_VALUE_TOKEN = "null";<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> private static final String EMPTY_STRING_VALUE_TOKEN = "\"\"";<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> private static final char STRING_VALUE_DELIMETER = '"';<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> private static final char MAP_PROPERTY_BEGIN_TOKEN = '[';<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> private static final char MAP_PROPERTY_END_TOKEN = ']';<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private static final String EVENT_BUS_NAME = "eventBus";<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> private final Map<String, Object> objects;<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @since 1.3<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> private EventBus eventBus;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> /**<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * Keeps track of event subscribers that were automatically registered by this ReflectionBuilder during<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * object construction. This is used in case a new EventBus is discovered during object graph<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * construction: upon discovery of the new EventBus, the existing subscribers will be unregistered from the<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * old EventBus and then re-registered with the new EventBus.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> *<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @since 1.3<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> private final Map<String,Object> registeredEventSubscribers;<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> //@since 1.3<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> private Map<String,Object> createDefaultObjectMap() {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> Map<String,Object> map = new LinkedHashMap<String, Object>();<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> map.put(EVENT_BUS_NAME, new DefaultEventBus());<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> return map;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> public ReflectionBuilder() {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> this(null);<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> }<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> public ReflectionBuilder(Map<String, ?> defaults) {<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> this.objects = createDefaultObjectMap();<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> this.registeredEventSubscribers = new LinkedHashMap<String,Object>();<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> apply(defaults);<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> private void apply(Map<String, ?> objects) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> if(!CollectionUtils.isEmpty(objects)) {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> this.objects.putAll(objects);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> EventBus found = findEventBus(this.objects);<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> Assert.notNull(found, "An " + EventBus.class.getName() + " instance must be present in the object defaults");<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> enableEvents(found);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> public Map<String, ?> getObjects() {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> return objects;<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> * @param objects<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> */<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> public void setObjects(Map<String, ?> objects) {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> this.objects.clear();<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> this.objects.putAll(createDefaultObjectMap());<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> apply(objects);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> //@since 1.3<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> private void enableEvents(EventBus eventBus) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> Assert.notNull(eventBus, "EventBus argument cannot be null.");<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> //clean up old auto-registered subscribers:<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> for (Object subscriber : this.registeredEventSubscribers.values()) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> this.eventBus.unregister(subscriber);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> }<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> this.registeredEventSubscribers.clear();<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> this.eventBus = eventBus;<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> for(Map.Entry<String,Object> entry : this.objects.entrySet()) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> enableEventsIfNecessary(entry.getValue(), entry.getKey());<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> }<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> //@since 1.3<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> private void enableEventsIfNecessary(Object bean, String name) {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> boolean applied = applyEventBusIfNecessary(bean);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> if (!applied) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> //if the event bus is applied, and the bean wishes to be a subscriber as well (not just a publisher),<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> // we assume that the implementation registers itself with the event bus, i.e. eventBus.register(this);<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> //if the event bus isn't applied, only then do we need to check to see if the bean is an event subscriber,<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> // and if so, register it on the event bus automatically since it has no ability to do so itself:<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> if (isEventSubscriber(bean, name)) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> //found an event subscriber, so register them with the EventBus:<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> this.eventBus.register(bean);<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> this.registeredEventSubscribers.put(name, bean);<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> }<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> //@since 1.3<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> private boolean isEventSubscriber(Object bean, String name) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> List annotatedMethods = ClassUtils.getAnnotatedMethods(bean.getClass(), Subscribe.class);<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> return !CollectionUtils.isEmpty(annotatedMethods);<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> //@since 1.3<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> protected EventBus findEventBus(Map<String,?> objects) {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> if (CollectionUtils.isEmpty(objects)) {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> return null;<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> //prefer a named object first:<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> Object value = objects.get(EVENT_BUS_NAME);<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> if (value != null && value instanceof EventBus) {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> return (EventBus)value;<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span><a name="line.191"></a> |
| <span class="sourceLineNo">192</span> //couldn't find a named 'eventBus' EventBus object. Try to find the first typed value we can:<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> for( Object v : objects.values()) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> if (v instanceof EventBus) {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> return (EventBus)v;<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<a name="line.197"></a> |
| <span class="sourceLineNo">198</span><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> return null;<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span><a name="line.201"></a> |
| <span class="sourceLineNo">202</span> private boolean applyEventBusIfNecessary(Object value) {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> if (value instanceof EventBusAware) {<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> ((EventBusAware)value).setEventBus(this.eventBus);<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> return true;<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> return false;<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span><a name="line.209"></a> |
| <span class="sourceLineNo">210</span> public Object getBean(String id) {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> return objects.get(id);<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> }<a name="line.212"></a> |
| <span class="sourceLineNo">213</span><a name="line.213"></a> |
| <span class="sourceLineNo">214</span> @SuppressWarnings({"unchecked"})<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> public <T> T getBean(String id, Class<T> requiredType) {<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> if (requiredType == null) {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> throw new NullPointerException("requiredType argument cannot be null.");<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> }<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> Object bean = getBean(id);<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> if (bean == null) {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> return null;<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> Assert.state(requiredType.isAssignableFrom(bean.getClass()),<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> "Bean with id [" + id + "] is not of the required type [" + requiredType.getName() + "].");<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> return (T) bean;<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> }<a name="line.226"></a> |
| <span class="sourceLineNo">227</span><a name="line.227"></a> |
| <span class="sourceLineNo">228</span> private String parseBeanId(String lhs) {<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> Assert.notNull(lhs);<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> if (lhs.indexOf('.') < 0) {<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> return lhs;<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> }<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> String classSuffix = ".class";<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> int index = lhs.indexOf(classSuffix);<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> if (index >= 0) {<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> return lhs.substring(0, index);<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> }<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> return null;<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> }<a name="line.239"></a> |
| <span class="sourceLineNo">240</span><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> @SuppressWarnings({"unchecked"})<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> public Map<String, ?> buildObjects(Map<String, String> kvPairs) {<a name="line.242"></a> |
| <span class="sourceLineNo">243</span><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> if (kvPairs != null && !kvPairs.isEmpty()) {<a name="line.244"></a> |
| <span class="sourceLineNo">245</span><a name="line.245"></a> |
| <span class="sourceLineNo">246</span> BeanConfigurationProcessor processor = new BeanConfigurationProcessor();<a name="line.246"></a> |
| <span class="sourceLineNo">247</span><a name="line.247"></a> |
| <span class="sourceLineNo">248</span> for (Map.Entry<String, String> entry : kvPairs.entrySet()) {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> String lhs = entry.getKey();<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> String rhs = entry.getValue();<a name="line.250"></a> |
| <span class="sourceLineNo">251</span><a name="line.251"></a> |
| <span class="sourceLineNo">252</span> String beanId = parseBeanId(lhs);<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> if (beanId != null) { //a beanId could be parsed, so the line is a bean instance definition<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> processor.add(new InstantiationStatement(beanId, rhs));<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> } else { //the line must be a property configuration<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> processor.add(new AssignmentStatement(lhs, rhs));<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> }<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> }<a name="line.258"></a> |
| <span class="sourceLineNo">259</span><a name="line.259"></a> |
| <span class="sourceLineNo">260</span> processor.execute();<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> //SHIRO-413: init method must be called for constructed objects that are Initializable<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> LifecycleUtils.init(objects.values());<a name="line.264"></a> |
| <span class="sourceLineNo">265</span><a name="line.265"></a> |
| <span class="sourceLineNo">266</span> return objects;<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> }<a name="line.267"></a> |
| <span class="sourceLineNo">268</span><a name="line.268"></a> |
| <span class="sourceLineNo">269</span> public void destroy() {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> final Map<String, Object> immutableObjects = Collections.unmodifiableMap(objects);<a name="line.270"></a> |
| <span class="sourceLineNo">271</span><a name="line.271"></a> |
| <span class="sourceLineNo">272</span> //destroy objects in the opposite order they were initialized:<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> List<Map.Entry<String,?>> entries = new ArrayList<Map.Entry<String,?>>(objects.entrySet());<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> Collections.reverse(entries);<a name="line.274"></a> |
| <span class="sourceLineNo">275</span><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> for(Map.Entry<String, ?> entry: entries) {<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> String id = entry.getKey();<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> Object bean = entry.getValue();<a name="line.278"></a> |
| <span class="sourceLineNo">279</span><a name="line.279"></a> |
| <span class="sourceLineNo">280</span> //don't destroy the eventbus until the end - we need it to still be 'alive' while publishing destroy events:<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> if (bean != this.eventBus) { //memory equality check (not .equals) on purpose<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> LifecycleUtils.destroy(bean);<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> BeanEvent event = new DestroyedBeanEvent(id, bean, immutableObjects);<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> eventBus.publish(event);<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> this.eventBus.unregister(bean); //bean is now destroyed - it should not receive any other events<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> }<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> }<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> //only now destroy the event bus:<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> LifecycleUtils.destroy(this.eventBus);<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> }<a name="line.290"></a> |
| <span class="sourceLineNo">291</span><a name="line.291"></a> |
| <span class="sourceLineNo">292</span> protected void createNewInstance(Map<String, Object> objects, String name, String value) {<a name="line.292"></a> |
| <span class="sourceLineNo">293</span><a name="line.293"></a> |
| <span class="sourceLineNo">294</span> Object currentInstance = objects.get(name);<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> if (currentInstance != null) {<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> log.info("An instance with name '{}' already exists. " +<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> "Redefining this object as a new instance of type {}", name, value);<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> }<a name="line.298"></a> |
| <span class="sourceLineNo">299</span><a name="line.299"></a> |
| <span class="sourceLineNo">300</span> Object instance;//name with no property, assume right hand side of equals sign is the class name:<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> try {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> instance = ClassUtils.newInstance(value);<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> if (instance instanceof Nameable) {<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> ((Nameable) instance).setName(name);<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> }<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> } catch (Exception e) {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> String msg = "Unable to instantiate class [" + value + "] for object named '" + name + "'. " +<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> "Please ensure you've specified the fully qualified class name correctly.";<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> throw new ConfigurationException(msg, e);<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> }<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> objects.put(name, instance);<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> }<a name="line.312"></a> |
| <span class="sourceLineNo">313</span><a name="line.313"></a> |
| <span class="sourceLineNo">314</span> protected void applyProperty(String key, String value, Map objects) {<a name="line.314"></a> |
| <span class="sourceLineNo">315</span><a name="line.315"></a> |
| <span class="sourceLineNo">316</span> int index = key.indexOf('.');<a name="line.316"></a> |
| <span class="sourceLineNo">317</span><a name="line.317"></a> |
| <span class="sourceLineNo">318</span> if (index >= 0) {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> String name = key.substring(0, index);<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> String property = key.substring(index + 1, key.length());<a name="line.320"></a> |
| <span class="sourceLineNo">321</span><a name="line.321"></a> |
| <span class="sourceLineNo">322</span> if (GLOBAL_PROPERTY_PREFIX.equalsIgnoreCase(name)) {<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> applyGlobalProperty(objects, property, value);<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> } else {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> applySingleProperty(objects, name, property, value);<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> }<a name="line.326"></a> |
| <span class="sourceLineNo">327</span><a name="line.327"></a> |
| <span class="sourceLineNo">328</span> } else {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> throw new IllegalArgumentException("All property keys must contain a '.' character. " +<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> "(e.g. myBean.property = value) These should already be separated out by buildObjects().");<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> }<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> }<a name="line.332"></a> |
| <span class="sourceLineNo">333</span><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> protected void applyGlobalProperty(Map objects, String property, String value) {<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> for (Object instance : objects.values()) {<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> try {<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> PropertyDescriptor pd = PropertyUtils.getPropertyDescriptor(instance, property);<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> if (pd != null) {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> applyProperty(instance, property, value);<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> }<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> } catch (Exception e) {<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> String msg = "Error retrieving property descriptor for instance " +<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> "of type [" + instance.getClass().getName() + "] " +<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> "while setting property [" + property + "]";<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> throw new ConfigurationException(msg, e);<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> }<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> }<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<a name="line.348"></a> |
| <span class="sourceLineNo">349</span><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> protected void applySingleProperty(Map objects, String name, String property, String value) {<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> Object instance = objects.get(name);<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> if (property.equals("class")) {<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> throw new IllegalArgumentException("Property keys should not contain 'class' properties since these " +<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> "should already be separated out by buildObjects().");<a name="line.354"></a> |
| <span class="sourceLineNo">355</span><a name="line.355"></a> |
| <span class="sourceLineNo">356</span> } else if (instance == null) {<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> String msg = "Configuration error. Specified object [" + name + "] with property [" +<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> property + "] without first defining that object's class. Please first " +<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> "specify the class property first, e.g. myObject = fully_qualified_class_name " +<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> "and then define additional properties.";<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> throw new IllegalArgumentException(msg);<a name="line.361"></a> |
| <span class="sourceLineNo">362</span><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> } else {<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> applyProperty(instance, property, value);<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> }<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> }<a name="line.366"></a> |
| <span class="sourceLineNo">367</span><a name="line.367"></a> |
| <span class="sourceLineNo">368</span> protected boolean isReference(String value) {<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> return value != null && value.startsWith(OBJECT_REFERENCE_BEGIN_TOKEN);<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> }<a name="line.370"></a> |
| <span class="sourceLineNo">371</span><a name="line.371"></a> |
| <span class="sourceLineNo">372</span> protected String getId(String referenceToken) {<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> return referenceToken.substring(OBJECT_REFERENCE_BEGIN_TOKEN.length());<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> }<a name="line.374"></a> |
| <span class="sourceLineNo">375</span><a name="line.375"></a> |
| <span class="sourceLineNo">376</span> protected Object getReferencedObject(String id) {<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> Object o = objects != null && !objects.isEmpty() ? objects.get(id) : null;<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> if (o == null) {<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> String msg = "The object with id [" + id + "] has not yet been defined and therefore cannot be " +<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> "referenced. Please ensure objects are defined in the order in which they should be " +<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> "created and made available for future reference.";<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> throw new UnresolveableReferenceException(msg);<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> }<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> return o;<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> }<a name="line.385"></a> |
| <span class="sourceLineNo">386</span><a name="line.386"></a> |
| <span class="sourceLineNo">387</span> protected String unescapeIfNecessary(String value) {<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> if (value != null && value.startsWith(ESCAPED_OBJECT_REFERENCE_BEGIN_TOKEN)) {<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> return value.substring(ESCAPED_OBJECT_REFERENCE_BEGIN_TOKEN.length() - 1);<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> }<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> return value;<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> }<a name="line.392"></a> |
| <span class="sourceLineNo">393</span><a name="line.393"></a> |
| <span class="sourceLineNo">394</span> protected Object resolveReference(String reference) {<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> String id = getId(reference);<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> log.debug("Encountered object reference '{}'. Looking up object with id '{}'", reference, id);<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> final Object referencedObject = getReferencedObject(id);<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> if (referencedObject instanceof Factory) {<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> return ((Factory) referencedObject).getInstance();<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> }<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> return referencedObject;<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span><a name="line.403"></a> |
| <span class="sourceLineNo">404</span> protected boolean isTypedProperty(Object object, String propertyName, Class clazz) {<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> if (clazz == null) {<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> throw new NullPointerException("type (class) argument cannot be null.");<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> }<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> try {<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> PropertyDescriptor descriptor = PropertyUtils.getPropertyDescriptor(object, propertyName);<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> if (descriptor == null) {<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> String msg = "Property '" + propertyName + "' does not exist for object of " +<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> "type " + object.getClass().getName() + ".";<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> throw new ConfigurationException(msg);<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> }<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> Class propertyClazz = descriptor.getPropertyType();<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> return clazz.isAssignableFrom(propertyClazz);<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> } catch (ConfigurationException ce) {<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> //let it propagate:<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> throw ce;<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> } catch (Exception e) {<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> String msg = "Unable to determine if property [" + propertyName + "] represents a " + clazz.getName();<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> throw new ConfigurationException(msg, e);<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> }<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> }<a name="line.424"></a> |
| <span class="sourceLineNo">425</span><a name="line.425"></a> |
| <span class="sourceLineNo">426</span> protected Set<?> toSet(String sValue) {<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> String[] tokens = StringUtils.split(sValue);<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> if (tokens == null || tokens.length <= 0) {<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> return null;<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> }<a name="line.430"></a> |
| <span class="sourceLineNo">431</span><a name="line.431"></a> |
| <span class="sourceLineNo">432</span> //SHIRO-423: check to see if the value is a referenced Set already, and if so, return it immediately:<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> if (tokens.length == 1 && isReference(tokens[0])) {<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> Object reference = resolveReference(tokens[0]);<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> if (reference instanceof Set) {<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> return (Set)reference;<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> }<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> }<a name="line.438"></a> |
| <span class="sourceLineNo">439</span><a name="line.439"></a> |
| <span class="sourceLineNo">440</span> Set<String> setTokens = new LinkedHashSet<String>(Arrays.asList(tokens));<a name="line.440"></a> |
| <span class="sourceLineNo">441</span><a name="line.441"></a> |
| <span class="sourceLineNo">442</span> //now convert into correct values and/or references:<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> Set<Object> values = new LinkedHashSet<Object>(setTokens.size());<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> for (String token : setTokens) {<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> Object value = resolveValue(token);<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> values.add(value);<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> }<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> return values;<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> }<a name="line.449"></a> |
| <span class="sourceLineNo">450</span><a name="line.450"></a> |
| <span class="sourceLineNo">451</span> protected Map<?, ?> toMap(String sValue) {<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> String[] tokens = StringUtils.split(sValue, StringUtils.DEFAULT_DELIMITER_CHAR,<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> StringUtils.DEFAULT_QUOTE_CHAR, StringUtils.DEFAULT_QUOTE_CHAR, true, true);<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> if (tokens == null || tokens.length <= 0) {<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> return null;<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> }<a name="line.456"></a> |
| <span class="sourceLineNo">457</span><a name="line.457"></a> |
| <span class="sourceLineNo">458</span> //SHIRO-423: check to see if the value is a referenced Map already, and if so, return it immediately:<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> if (tokens.length == 1 && isReference(tokens[0])) {<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> Object reference = resolveReference(tokens[0]);<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> if (reference instanceof Map) {<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> return (Map)reference;<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> }<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> }<a name="line.464"></a> |
| <span class="sourceLineNo">465</span><a name="line.465"></a> |
| <span class="sourceLineNo">466</span> Map<String, String> mapTokens = new LinkedHashMap<String, String>(tokens.length);<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> for (String token : tokens) {<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> String[] kvPair = StringUtils.split(token, MAP_KEY_VALUE_DELIMITER);<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> if (kvPair == null || kvPair.length != 2) {<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> String msg = "Map property value [" + sValue + "] contained key-value pair token [" +<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> token + "] that does not properly split to a single key and pair. This must be the " +<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> "case for all map entries.";<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> throw new ConfigurationException(msg);<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> }<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> mapTokens.put(kvPair[0], kvPair[1]);<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> }<a name="line.476"></a> |
| <span class="sourceLineNo">477</span><a name="line.477"></a> |
| <span class="sourceLineNo">478</span> //now convert into correct values and/or references:<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> Map<Object, Object> map = new LinkedHashMap<Object, Object>(mapTokens.size());<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> for (Map.Entry<String, String> entry : mapTokens.entrySet()) {<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> Object key = resolveValue(entry.getKey());<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> Object value = resolveValue(entry.getValue());<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> map.put(key, value);<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> }<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> return map;<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> }<a name="line.486"></a> |
| <span class="sourceLineNo">487</span><a name="line.487"></a> |
| <span class="sourceLineNo">488</span> // @since 1.2.2<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> // TODO: make protected in 1.3+<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> private Collection<?> toCollection(String sValue) {<a name="line.490"></a> |
| <span class="sourceLineNo">491</span><a name="line.491"></a> |
| <span class="sourceLineNo">492</span> String[] tokens = StringUtils.split(sValue);<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> if (tokens == null || tokens.length <= 0) {<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> return null;<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> }<a name="line.495"></a> |
| <span class="sourceLineNo">496</span><a name="line.496"></a> |
| <span class="sourceLineNo">497</span> //SHIRO-423: check to see if the value is a referenced Collection already, and if so, return it immediately:<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> if (tokens.length == 1 && isReference(tokens[0])) {<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> Object reference = resolveReference(tokens[0]);<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> if (reference instanceof Collection) {<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> return (Collection)reference;<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> }<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> }<a name="line.503"></a> |
| <span class="sourceLineNo">504</span><a name="line.504"></a> |
| <span class="sourceLineNo">505</span> //now convert into correct values and/or references:<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> List<Object> values = new ArrayList<Object>(tokens.length);<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> for (String token : tokens) {<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> Object value = resolveValue(token);<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> values.add(value);<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> }<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> return values;<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> }<a name="line.512"></a> |
| <span class="sourceLineNo">513</span><a name="line.513"></a> |
| <span class="sourceLineNo">514</span> protected List<?> toList(String sValue) {<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> String[] tokens = StringUtils.split(sValue);<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> if (tokens == null || tokens.length <= 0) {<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> return null;<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> }<a name="line.518"></a> |
| <span class="sourceLineNo">519</span><a name="line.519"></a> |
| <span class="sourceLineNo">520</span> //SHIRO-423: check to see if the value is a referenced List already, and if so, return it immediately:<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> if (tokens.length == 1 && isReference(tokens[0])) {<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> Object reference = resolveReference(tokens[0]);<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> if (reference instanceof List) {<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> return (List)reference;<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> }<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> }<a name="line.526"></a> |
| <span class="sourceLineNo">527</span><a name="line.527"></a> |
| <span class="sourceLineNo">528</span> //now convert into correct values and/or references:<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> List<Object> values = new ArrayList<Object>(tokens.length);<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> for (String token : tokens) {<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> Object value = resolveValue(token);<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> values.add(value);<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> }<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> return values;<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> }<a name="line.535"></a> |
| <span class="sourceLineNo">536</span><a name="line.536"></a> |
| <span class="sourceLineNo">537</span> protected byte[] toBytes(String sValue) {<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> if (sValue == null) {<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> return null;<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> }<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> byte[] bytes;<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> if (sValue.startsWith(HEX_BEGIN_TOKEN)) {<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> String hex = sValue.substring(HEX_BEGIN_TOKEN.length());<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> bytes = Hex.decode(hex);<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> } else {<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> //assume base64 encoded:<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> bytes = Base64.decode(sValue);<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> }<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> return bytes;<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> }<a name="line.550"></a> |
| <span class="sourceLineNo">551</span><a name="line.551"></a> |
| <span class="sourceLineNo">552</span> protected Object resolveValue(String stringValue) {<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> Object value;<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> if (isReference(stringValue)) {<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> value = resolveReference(stringValue);<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> } else {<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> value = unescapeIfNecessary(stringValue);<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> }<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> return value;<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> }<a name="line.560"></a> |
| <span class="sourceLineNo">561</span><a name="line.561"></a> |
| <span class="sourceLineNo">562</span> protected String checkForNullOrEmptyLiteral(String stringValue) {<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> if (stringValue == null) {<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> return null;<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> }<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> //check if the value is the actual literal string 'null' (expected to be wrapped in quotes):<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> if (stringValue.equals("\"null\"")) {<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> return NULL_VALUE_TOKEN;<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> }<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> //or the actual literal string of two quotes '""' (expected to be wrapped in quotes):<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> else if (stringValue.equals("\"\"\"\"")) {<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> return EMPTY_STRING_VALUE_TOKEN;<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> } else {<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> return stringValue;<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> }<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> }<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> <a name="line.577"></a> |
| <span class="sourceLineNo">578</span> protected void applyProperty(Object object, String propertyPath, Object value) {<a name="line.578"></a> |
| <span class="sourceLineNo">579</span><a name="line.579"></a> |
| <span class="sourceLineNo">580</span> int mapBegin = propertyPath.indexOf(MAP_PROPERTY_BEGIN_TOKEN);<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> int mapEnd = -1;<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> String mapPropertyPath = null;<a name="line.582"></a> |
| <span class="sourceLineNo">583</span> String keyString = null;<a name="line.583"></a> |
| <span class="sourceLineNo">584</span><a name="line.584"></a> |
| <span class="sourceLineNo">585</span> String remaining = null;<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> <a name="line.586"></a> |
| <span class="sourceLineNo">587</span> if (mapBegin >= 0) {<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> //a map is being referenced in the overall property path. Find just the map's path:<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> mapPropertyPath = propertyPath.substring(0, mapBegin);<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> //find the end of the map reference:<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> mapEnd = propertyPath.indexOf(MAP_PROPERTY_END_TOKEN, mapBegin);<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> //find the token in between the [ and the ] (the map/array key or index):<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> keyString = propertyPath.substring(mapBegin+1, mapEnd);<a name="line.593"></a> |
| <span class="sourceLineNo">594</span><a name="line.594"></a> |
| <span class="sourceLineNo">595</span> //find out if there is more path reference to follow. If not, we're at a terminal of the OGNL expression<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> if (propertyPath.length() > (mapEnd+1)) {<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> remaining = propertyPath.substring(mapEnd+1);<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> if (remaining.startsWith(".")) {<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> remaining = StringUtils.clean(remaining.substring(1));<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> }<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> }<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> }<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> <a name="line.603"></a> |
| <span class="sourceLineNo">604</span> if (remaining == null) {<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> //we've terminated the OGNL expression. Check to see if we're assigning a property or a map entry:<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> if (keyString == null) {<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> //not a map or array value assignment - assign the property directly:<a name="line.607"></a> |
| <span class="sourceLineNo">608</span> setProperty(object, propertyPath, value);<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> } else {<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> //we're assigning a map or array entry. Check to see which we should call:<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> if (isTypedProperty(object, mapPropertyPath, Map.class)) {<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> Map map = (Map)getProperty(object, mapPropertyPath);<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> Object mapKey = resolveValue(keyString);<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> //noinspection unchecked<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> map.put(mapKey, value);<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> } else {<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> //must be an array property. Convert the key string to an index:<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> int index = Integer.valueOf(keyString);<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> setIndexedProperty(object, mapPropertyPath, index, value);<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> }<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> }<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> } else {<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> //property is being referenced as part of a nested path. Find the referenced map/array entry and<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> //recursively call this method with the remaining property path<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> Object referencedValue = null;<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> if (isTypedProperty(object, mapPropertyPath, Map.class)) {<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> Map map = (Map)getProperty(object, mapPropertyPath);<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> Object mapKey = resolveValue(keyString);<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> referencedValue = map.get(mapKey);<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> } else {<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> //must be an array property:<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> int index = Integer.valueOf(keyString);<a name="line.632"></a> |
| <span class="sourceLineNo">633</span> referencedValue = getIndexedProperty(object, mapPropertyPath, index);<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> }<a name="line.634"></a> |
| <span class="sourceLineNo">635</span><a name="line.635"></a> |
| <span class="sourceLineNo">636</span> if (referencedValue == null) {<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> throw new ConfigurationException("Referenced map/array value '" + mapPropertyPath + "[" +<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> keyString + "]' does not exist.");<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> }<a name="line.639"></a> |
| <span class="sourceLineNo">640</span><a name="line.640"></a> |
| <span class="sourceLineNo">641</span> applyProperty(referencedValue, remaining, value);<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> }<a name="line.642"></a> |
| <span class="sourceLineNo">643</span> }<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> <a name="line.644"></a> |
| <span class="sourceLineNo">645</span> private void setProperty(Object object, String propertyPath, Object value) {<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> try {<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> if (log.isTraceEnabled()) {<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> log.trace("Applying property [{}] value [{}] on object of type [{}]",<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> new Object[]{propertyPath, value, object.getClass().getName()});<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> }<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> BeanUtils.setProperty(object, propertyPath, value);<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> } catch (Exception e) {<a name="line.652"></a> |
| <span class="sourceLineNo">653</span> String msg = "Unable to set property '" + propertyPath + "' with value [" + value + "] on object " +<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> "of type " + (object != null ? object.getClass().getName() : null) + ". If " +<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> "'" + value + "' is a reference to another (previously defined) object, prefix it with " +<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> "'" + OBJECT_REFERENCE_BEGIN_TOKEN + "' to indicate that the referenced " +<a name="line.656"></a> |
| <span class="sourceLineNo">657</span> "object should be used as the actual value. " +<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> "For example, " + OBJECT_REFERENCE_BEGIN_TOKEN + value;<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> throw new ConfigurationException(msg, e);<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> }<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> }<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> <a name="line.662"></a> |
| <span class="sourceLineNo">663</span> private Object getProperty(Object object, String propertyPath) {<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> try {<a name="line.664"></a> |
| <span class="sourceLineNo">665</span> return PropertyUtils.getProperty(object, propertyPath);<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> } catch (Exception e) {<a name="line.666"></a> |
| <span class="sourceLineNo">667</span> throw new ConfigurationException("Unable to access property '" + propertyPath + "'", e);<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> }<a name="line.668"></a> |
| <span class="sourceLineNo">669</span> }<a name="line.669"></a> |
| <span class="sourceLineNo">670</span> <a name="line.670"></a> |
| <span class="sourceLineNo">671</span> private void setIndexedProperty(Object object, String propertyPath, int index, Object value) {<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> try {<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> PropertyUtils.setIndexedProperty(object, propertyPath, index, value);<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> } catch (Exception e) {<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> throw new ConfigurationException("Unable to set array property '" + propertyPath + "'", e);<a name="line.675"></a> |
| <span class="sourceLineNo">676</span> }<a name="line.676"></a> |
| <span class="sourceLineNo">677</span> }<a name="line.677"></a> |
| <span class="sourceLineNo">678</span> <a name="line.678"></a> |
| <span class="sourceLineNo">679</span> private Object getIndexedProperty(Object object, String propertyPath, int index) {<a name="line.679"></a> |
| <span class="sourceLineNo">680</span> try {<a name="line.680"></a> |
| <span class="sourceLineNo">681</span> return PropertyUtils.getIndexedProperty(object, propertyPath, index);<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> } catch (Exception e) {<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> throw new ConfigurationException("Unable to acquire array property '" + propertyPath + "'", e);<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> }<a name="line.684"></a> |
| <span class="sourceLineNo">685</span> }<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> <a name="line.686"></a> |
| <span class="sourceLineNo">687</span> protected boolean isIndexedPropertyAssignment(String propertyPath) {<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> return propertyPath.endsWith("" + MAP_PROPERTY_END_TOKEN);<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> }<a name="line.689"></a> |
| <span class="sourceLineNo">690</span><a name="line.690"></a> |
| <span class="sourceLineNo">691</span> protected void applyProperty(Object object, String propertyName, String stringValue) {<a name="line.691"></a> |
| <span class="sourceLineNo">692</span><a name="line.692"></a> |
| <span class="sourceLineNo">693</span> Object value;<a name="line.693"></a> |
| <span class="sourceLineNo">694</span><a name="line.694"></a> |
| <span class="sourceLineNo">695</span> if (NULL_VALUE_TOKEN.equals(stringValue)) {<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> value = null;<a name="line.696"></a> |
| <span class="sourceLineNo">697</span> } else if (EMPTY_STRING_VALUE_TOKEN.equals(stringValue)) {<a name="line.697"></a> |
| <span class="sourceLineNo">698</span> value = StringUtils.EMPTY_STRING;<a name="line.698"></a> |
| <span class="sourceLineNo">699</span> } else if (isIndexedPropertyAssignment(propertyName)) {<a name="line.699"></a> |
| <span class="sourceLineNo">700</span> String checked = checkForNullOrEmptyLiteral(stringValue);<a name="line.700"></a> |
| <span class="sourceLineNo">701</span> value = resolveValue(checked);<a name="line.701"></a> |
| <span class="sourceLineNo">702</span> } else if (isTypedProperty(object, propertyName, Set.class)) {<a name="line.702"></a> |
| <span class="sourceLineNo">703</span> value = toSet(stringValue);<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> } else if (isTypedProperty(object, propertyName, Map.class)) {<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> value = toMap(stringValue);<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> } else if (isTypedProperty(object, propertyName, List.class)) {<a name="line.706"></a> |
| <span class="sourceLineNo">707</span> value = toList(stringValue);<a name="line.707"></a> |
| <span class="sourceLineNo">708</span> } else if (isTypedProperty(object, propertyName, Collection.class)) {<a name="line.708"></a> |
| <span class="sourceLineNo">709</span> value = toCollection(stringValue);<a name="line.709"></a> |
| <span class="sourceLineNo">710</span> } else if (isTypedProperty(object, propertyName, byte[].class)) {<a name="line.710"></a> |
| <span class="sourceLineNo">711</span> value = toBytes(stringValue);<a name="line.711"></a> |
| <span class="sourceLineNo">712</span> } else if (isTypedProperty(object, propertyName, ByteSource.class)) {<a name="line.712"></a> |
| <span class="sourceLineNo">713</span> byte[] bytes = toBytes(stringValue);<a name="line.713"></a> |
| <span class="sourceLineNo">714</span> value = ByteSource.Util.bytes(bytes);<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> } else {<a name="line.715"></a> |
| <span class="sourceLineNo">716</span> String checked = checkForNullOrEmptyLiteral(stringValue);<a name="line.716"></a> |
| <span class="sourceLineNo">717</span> value = resolveValue(checked);<a name="line.717"></a> |
| <span class="sourceLineNo">718</span> }<a name="line.718"></a> |
| <span class="sourceLineNo">719</span><a name="line.719"></a> |
| <span class="sourceLineNo">720</span> applyProperty(object, propertyName, value);<a name="line.720"></a> |
| <span class="sourceLineNo">721</span> }<a name="line.721"></a> |
| <span class="sourceLineNo">722</span><a name="line.722"></a> |
| <span class="sourceLineNo">723</span> private class BeanConfigurationProcessor {<a name="line.723"></a> |
| <span class="sourceLineNo">724</span><a name="line.724"></a> |
| <span class="sourceLineNo">725</span> private final List<Statement> statements = new ArrayList<Statement>();<a name="line.725"></a> |
| <span class="sourceLineNo">726</span> private final List<BeanConfiguration> beanConfigurations = new ArrayList<BeanConfiguration>();<a name="line.726"></a> |
| <span class="sourceLineNo">727</span><a name="line.727"></a> |
| <span class="sourceLineNo">728</span> public void add(Statement statement) {<a name="line.728"></a> |
| <span class="sourceLineNo">729</span><a name="line.729"></a> |
| <span class="sourceLineNo">730</span> statements.add(statement); //we execute bean configuration statements in the order they are declared.<a name="line.730"></a> |
| <span class="sourceLineNo">731</span><a name="line.731"></a> |
| <span class="sourceLineNo">732</span> if (statement instanceof InstantiationStatement) {<a name="line.732"></a> |
| <span class="sourceLineNo">733</span> InstantiationStatement is = (InstantiationStatement)statement;<a name="line.733"></a> |
| <span class="sourceLineNo">734</span> beanConfigurations.add(new BeanConfiguration(is));<a name="line.734"></a> |
| <span class="sourceLineNo">735</span> } else {<a name="line.735"></a> |
| <span class="sourceLineNo">736</span> AssignmentStatement as = (AssignmentStatement)statement;<a name="line.736"></a> |
| <span class="sourceLineNo">737</span> //statements always apply to the most recently defined bean configuration with the same name, so we<a name="line.737"></a> |
| <span class="sourceLineNo">738</span> //have to traverse the configuration list starting at the end (most recent elements are appended):<a name="line.738"></a> |
| <span class="sourceLineNo">739</span> boolean addedToConfig = false;<a name="line.739"></a> |
| <span class="sourceLineNo">740</span> String beanName = as.getRootBeanName();<a name="line.740"></a> |
| <span class="sourceLineNo">741</span> for( int i = beanConfigurations.size()-1; i >= 0; i--) {<a name="line.741"></a> |
| <span class="sourceLineNo">742</span> BeanConfiguration mostRecent = beanConfigurations.get(i);<a name="line.742"></a> |
| <span class="sourceLineNo">743</span> String mostRecentBeanName = mostRecent.getBeanName();<a name="line.743"></a> |
| <span class="sourceLineNo">744</span> if (beanName.equals(mostRecentBeanName)) {<a name="line.744"></a> |
| <span class="sourceLineNo">745</span> mostRecent.add(as);<a name="line.745"></a> |
| <span class="sourceLineNo">746</span> addedToConfig = true;<a name="line.746"></a> |
| <span class="sourceLineNo">747</span> break;<a name="line.747"></a> |
| <span class="sourceLineNo">748</span> }<a name="line.748"></a> |
| <span class="sourceLineNo">749</span> }<a name="line.749"></a> |
| <span class="sourceLineNo">750</span><a name="line.750"></a> |
| <span class="sourceLineNo">751</span> if (!addedToConfig) {<a name="line.751"></a> |
| <span class="sourceLineNo">752</span> // the AssignmentStatement must be for an existing bean that does not yet have a corresponding<a name="line.752"></a> |
| <span class="sourceLineNo">753</span> // configuration object (this would happen if the bean is in the default objects map). Because<a name="line.753"></a> |
| <span class="sourceLineNo">754</span> // BeanConfiguration instances don't exist for default (already instantiated) beans,<a name="line.754"></a> |
| <span class="sourceLineNo">755</span> // we simulate a creation of one to satisfy this processors implementation:<a name="line.755"></a> |
| <span class="sourceLineNo">756</span> beanConfigurations.add(new BeanConfiguration(as));<a name="line.756"></a> |
| <span class="sourceLineNo">757</span> }<a name="line.757"></a> |
| <span class="sourceLineNo">758</span> }<a name="line.758"></a> |
| <span class="sourceLineNo">759</span> }<a name="line.759"></a> |
| <span class="sourceLineNo">760</span><a name="line.760"></a> |
| <span class="sourceLineNo">761</span> public void execute() {<a name="line.761"></a> |
| <span class="sourceLineNo">762</span><a name="line.762"></a> |
| <span class="sourceLineNo">763</span> for( Statement statement : statements) {<a name="line.763"></a> |
| <span class="sourceLineNo">764</span><a name="line.764"></a> |
| <span class="sourceLineNo">765</span> statement.execute();<a name="line.765"></a> |
| <span class="sourceLineNo">766</span><a name="line.766"></a> |
| <span class="sourceLineNo">767</span> BeanConfiguration bd = statement.getBeanConfiguration();<a name="line.767"></a> |
| <span class="sourceLineNo">768</span><a name="line.768"></a> |
| <span class="sourceLineNo">769</span> if (bd.isExecuted()) { //bean is fully configured, no more statements to execute for it:<a name="line.769"></a> |
| <span class="sourceLineNo">770</span><a name="line.770"></a> |
| <span class="sourceLineNo">771</span> //bean configured overrides the 'eventBus' bean - replace the existing eventBus with the one configured:<a name="line.771"></a> |
| <span class="sourceLineNo">772</span> if (bd.getBeanName().equals(EVENT_BUS_NAME)) {<a name="line.772"></a> |
| <span class="sourceLineNo">773</span> EventBus eventBus = (EventBus)bd.getBean();<a name="line.773"></a> |
| <span class="sourceLineNo">774</span> enableEvents(eventBus);<a name="line.774"></a> |
| <span class="sourceLineNo">775</span> }<a name="line.775"></a> |
| <span class="sourceLineNo">776</span><a name="line.776"></a> |
| <span class="sourceLineNo">777</span> //ignore global 'shiro.' shortcut mechanism:<a name="line.777"></a> |
| <span class="sourceLineNo">778</span> if (!bd.isGlobalConfig()) {<a name="line.778"></a> |
| <span class="sourceLineNo">779</span> BeanEvent event = new ConfiguredBeanEvent(bd.getBeanName(), bd.getBean(),<a name="line.779"></a> |
| <span class="sourceLineNo">780</span> Collections.unmodifiableMap(objects));<a name="line.780"></a> |
| <span class="sourceLineNo">781</span> eventBus.publish(event);<a name="line.781"></a> |
| <span class="sourceLineNo">782</span> }<a name="line.782"></a> |
| <span class="sourceLineNo">783</span><a name="line.783"></a> |
| <span class="sourceLineNo">784</span> //initialize the bean if necessary:<a name="line.784"></a> |
| <span class="sourceLineNo">785</span> LifecycleUtils.init(bd.getBean());<a name="line.785"></a> |
| <span class="sourceLineNo">786</span><a name="line.786"></a> |
| <span class="sourceLineNo">787</span> //ignore global 'shiro.' shortcut mechanism:<a name="line.787"></a> |
| <span class="sourceLineNo">788</span> if (!bd.isGlobalConfig()) {<a name="line.788"></a> |
| <span class="sourceLineNo">789</span> BeanEvent event = new InitializedBeanEvent(bd.getBeanName(), bd.getBean(),<a name="line.789"></a> |
| <span class="sourceLineNo">790</span> Collections.unmodifiableMap(objects));<a name="line.790"></a> |
| <span class="sourceLineNo">791</span> eventBus.publish(event);<a name="line.791"></a> |
| <span class="sourceLineNo">792</span> }<a name="line.792"></a> |
| <span class="sourceLineNo">793</span> }<a name="line.793"></a> |
| <span class="sourceLineNo">794</span> }<a name="line.794"></a> |
| <span class="sourceLineNo">795</span> }<a name="line.795"></a> |
| <span class="sourceLineNo">796</span> }<a name="line.796"></a> |
| <span class="sourceLineNo">797</span><a name="line.797"></a> |
| <span class="sourceLineNo">798</span> private class BeanConfiguration {<a name="line.798"></a> |
| <span class="sourceLineNo">799</span><a name="line.799"></a> |
| <span class="sourceLineNo">800</span> private final InstantiationStatement instantiationStatement;<a name="line.800"></a> |
| <span class="sourceLineNo">801</span> private final List<AssignmentStatement> assignments = new ArrayList<AssignmentStatement>();<a name="line.801"></a> |
| <span class="sourceLineNo">802</span> private final String beanName;<a name="line.802"></a> |
| <span class="sourceLineNo">803</span> private Object bean;<a name="line.803"></a> |
| <span class="sourceLineNo">804</span><a name="line.804"></a> |
| <span class="sourceLineNo">805</span> private BeanConfiguration(InstantiationStatement statement) {<a name="line.805"></a> |
| <span class="sourceLineNo">806</span> statement.setBeanConfiguration(this);<a name="line.806"></a> |
| <span class="sourceLineNo">807</span> this.instantiationStatement = statement;<a name="line.807"></a> |
| <span class="sourceLineNo">808</span> this.beanName = statement.lhs;<a name="line.808"></a> |
| <span class="sourceLineNo">809</span> }<a name="line.809"></a> |
| <span class="sourceLineNo">810</span><a name="line.810"></a> |
| <span class="sourceLineNo">811</span> private BeanConfiguration(AssignmentStatement as) {<a name="line.811"></a> |
| <span class="sourceLineNo">812</span> this.instantiationStatement = null;<a name="line.812"></a> |
| <span class="sourceLineNo">813</span> this.beanName = as.getRootBeanName();<a name="line.813"></a> |
| <span class="sourceLineNo">814</span> add(as);<a name="line.814"></a> |
| <span class="sourceLineNo">815</span> }<a name="line.815"></a> |
| <span class="sourceLineNo">816</span><a name="line.816"></a> |
| <span class="sourceLineNo">817</span> public String getBeanName() {<a name="line.817"></a> |
| <span class="sourceLineNo">818</span> return this.beanName;<a name="line.818"></a> |
| <span class="sourceLineNo">819</span> }<a name="line.819"></a> |
| <span class="sourceLineNo">820</span><a name="line.820"></a> |
| <span class="sourceLineNo">821</span> public boolean isGlobalConfig() { //BeanConfiguration instance representing the global 'shiro.' properties<a name="line.821"></a> |
| <span class="sourceLineNo">822</span> // (we should remove this concept).<a name="line.822"></a> |
| <span class="sourceLineNo">823</span> return GLOBAL_PROPERTY_PREFIX.equals(getBeanName());<a name="line.823"></a> |
| <span class="sourceLineNo">824</span> }<a name="line.824"></a> |
| <span class="sourceLineNo">825</span><a name="line.825"></a> |
| <span class="sourceLineNo">826</span> public void add(AssignmentStatement as) {<a name="line.826"></a> |
| <span class="sourceLineNo">827</span> as.setBeanConfiguration(this);<a name="line.827"></a> |
| <span class="sourceLineNo">828</span> assignments.add(as);<a name="line.828"></a> |
| <span class="sourceLineNo">829</span> }<a name="line.829"></a> |
| <span class="sourceLineNo">830</span><a name="line.830"></a> |
| <span class="sourceLineNo">831</span> /**<a name="line.831"></a> |
| <span class="sourceLineNo">832</span> * When this configuration is parsed sufficiently to create (or find) an actual bean instance, that instance<a name="line.832"></a> |
| <span class="sourceLineNo">833</span> * will be associated with its configuration by setting it via this method.<a name="line.833"></a> |
| <span class="sourceLineNo">834</span> *<a name="line.834"></a> |
| <span class="sourceLineNo">835</span> * @param bean the bean instantiated (or found) that corresponds to this BeanConfiguration instance.<a name="line.835"></a> |
| <span class="sourceLineNo">836</span> */<a name="line.836"></a> |
| <span class="sourceLineNo">837</span> public void setBean(Object bean) {<a name="line.837"></a> |
| <span class="sourceLineNo">838</span> this.bean = bean;<a name="line.838"></a> |
| <span class="sourceLineNo">839</span> }<a name="line.839"></a> |
| <span class="sourceLineNo">840</span><a name="line.840"></a> |
| <span class="sourceLineNo">841</span> public Object getBean() {<a name="line.841"></a> |
| <span class="sourceLineNo">842</span> return this.bean;<a name="line.842"></a> |
| <span class="sourceLineNo">843</span> }<a name="line.843"></a> |
| <span class="sourceLineNo">844</span><a name="line.844"></a> |
| <span class="sourceLineNo">845</span> /**<a name="line.845"></a> |
| <span class="sourceLineNo">846</span> * Returns true if all configuration statements have been executed.<a name="line.846"></a> |
| <span class="sourceLineNo">847</span> * @return true if all configuration statements have been executed.<a name="line.847"></a> |
| <span class="sourceLineNo">848</span> */<a name="line.848"></a> |
| <span class="sourceLineNo">849</span> public boolean isExecuted() {<a name="line.849"></a> |
| <span class="sourceLineNo">850</span> if (instantiationStatement != null && !instantiationStatement.isExecuted()) {<a name="line.850"></a> |
| <span class="sourceLineNo">851</span> return false;<a name="line.851"></a> |
| <span class="sourceLineNo">852</span> }<a name="line.852"></a> |
| <span class="sourceLineNo">853</span> for (AssignmentStatement as : assignments) {<a name="line.853"></a> |
| <span class="sourceLineNo">854</span> if (!as.isExecuted()) {<a name="line.854"></a> |
| <span class="sourceLineNo">855</span> return false;<a name="line.855"></a> |
| <span class="sourceLineNo">856</span> }<a name="line.856"></a> |
| <span class="sourceLineNo">857</span> }<a name="line.857"></a> |
| <span class="sourceLineNo">858</span> return true;<a name="line.858"></a> |
| <span class="sourceLineNo">859</span> }<a name="line.859"></a> |
| <span class="sourceLineNo">860</span> }<a name="line.860"></a> |
| <span class="sourceLineNo">861</span><a name="line.861"></a> |
| <span class="sourceLineNo">862</span> private abstract class Statement {<a name="line.862"></a> |
| <span class="sourceLineNo">863</span><a name="line.863"></a> |
| <span class="sourceLineNo">864</span> protected final String lhs;<a name="line.864"></a> |
| <span class="sourceLineNo">865</span> protected final String rhs;<a name="line.865"></a> |
| <span class="sourceLineNo">866</span> protected Object bean;<a name="line.866"></a> |
| <span class="sourceLineNo">867</span> private Object result;<a name="line.867"></a> |
| <span class="sourceLineNo">868</span> private boolean executed;<a name="line.868"></a> |
| <span class="sourceLineNo">869</span> private BeanConfiguration beanConfiguration;<a name="line.869"></a> |
| <span class="sourceLineNo">870</span><a name="line.870"></a> |
| <span class="sourceLineNo">871</span> private Statement(String lhs, String rhs) {<a name="line.871"></a> |
| <span class="sourceLineNo">872</span> this.lhs = lhs;<a name="line.872"></a> |
| <span class="sourceLineNo">873</span> this.rhs = rhs;<a name="line.873"></a> |
| <span class="sourceLineNo">874</span> this.executed = false;<a name="line.874"></a> |
| <span class="sourceLineNo">875</span> }<a name="line.875"></a> |
| <span class="sourceLineNo">876</span><a name="line.876"></a> |
| <span class="sourceLineNo">877</span> public void setBeanConfiguration(BeanConfiguration bd) {<a name="line.877"></a> |
| <span class="sourceLineNo">878</span> this.beanConfiguration = bd;<a name="line.878"></a> |
| <span class="sourceLineNo">879</span> }<a name="line.879"></a> |
| <span class="sourceLineNo">880</span><a name="line.880"></a> |
| <span class="sourceLineNo">881</span> public BeanConfiguration getBeanConfiguration() {<a name="line.881"></a> |
| <span class="sourceLineNo">882</span> return this.beanConfiguration;<a name="line.882"></a> |
| <span class="sourceLineNo">883</span> }<a name="line.883"></a> |
| <span class="sourceLineNo">884</span><a name="line.884"></a> |
| <span class="sourceLineNo">885</span> public Object execute() {<a name="line.885"></a> |
| <span class="sourceLineNo">886</span> if (!isExecuted()) {<a name="line.886"></a> |
| <span class="sourceLineNo">887</span> this.result = doExecute();<a name="line.887"></a> |
| <span class="sourceLineNo">888</span> this.executed = true;<a name="line.888"></a> |
| <span class="sourceLineNo">889</span> }<a name="line.889"></a> |
| <span class="sourceLineNo">890</span> if (!getBeanConfiguration().isGlobalConfig()) {<a name="line.890"></a> |
| <span class="sourceLineNo">891</span> Assert.notNull(this.bean, "Implementation must set the root bean for which it executed.");<a name="line.891"></a> |
| <span class="sourceLineNo">892</span> }<a name="line.892"></a> |
| <span class="sourceLineNo">893</span> return this.result;<a name="line.893"></a> |
| <span class="sourceLineNo">894</span> }<a name="line.894"></a> |
| <span class="sourceLineNo">895</span><a name="line.895"></a> |
| <span class="sourceLineNo">896</span> public Object getBean() {<a name="line.896"></a> |
| <span class="sourceLineNo">897</span> return this.bean;<a name="line.897"></a> |
| <span class="sourceLineNo">898</span> }<a name="line.898"></a> |
| <span class="sourceLineNo">899</span><a name="line.899"></a> |
| <span class="sourceLineNo">900</span> protected void setBean(Object bean) {<a name="line.900"></a> |
| <span class="sourceLineNo">901</span> this.bean = bean;<a name="line.901"></a> |
| <span class="sourceLineNo">902</span> if (this.beanConfiguration.getBean() == null) {<a name="line.902"></a> |
| <span class="sourceLineNo">903</span> this.beanConfiguration.setBean(bean);<a name="line.903"></a> |
| <span class="sourceLineNo">904</span> }<a name="line.904"></a> |
| <span class="sourceLineNo">905</span> }<a name="line.905"></a> |
| <span class="sourceLineNo">906</span><a name="line.906"></a> |
| <span class="sourceLineNo">907</span> public Object getResult() {<a name="line.907"></a> |
| <span class="sourceLineNo">908</span> return result;<a name="line.908"></a> |
| <span class="sourceLineNo">909</span> }<a name="line.909"></a> |
| <span class="sourceLineNo">910</span><a name="line.910"></a> |
| <span class="sourceLineNo">911</span> protected abstract Object doExecute();<a name="line.911"></a> |
| <span class="sourceLineNo">912</span><a name="line.912"></a> |
| <span class="sourceLineNo">913</span> public boolean isExecuted() {<a name="line.913"></a> |
| <span class="sourceLineNo">914</span> return executed;<a name="line.914"></a> |
| <span class="sourceLineNo">915</span> }<a name="line.915"></a> |
| <span class="sourceLineNo">916</span> }<a name="line.916"></a> |
| <span class="sourceLineNo">917</span><a name="line.917"></a> |
| <span class="sourceLineNo">918</span> private class InstantiationStatement extends Statement {<a name="line.918"></a> |
| <span class="sourceLineNo">919</span><a name="line.919"></a> |
| <span class="sourceLineNo">920</span> private InstantiationStatement(String lhs, String rhs) {<a name="line.920"></a> |
| <span class="sourceLineNo">921</span> super(lhs, rhs);<a name="line.921"></a> |
| <span class="sourceLineNo">922</span> }<a name="line.922"></a> |
| <span class="sourceLineNo">923</span><a name="line.923"></a> |
| <span class="sourceLineNo">924</span> @Override<a name="line.924"></a> |
| <span class="sourceLineNo">925</span> protected Object doExecute() {<a name="line.925"></a> |
| <span class="sourceLineNo">926</span> String beanName = this.lhs;<a name="line.926"></a> |
| <span class="sourceLineNo">927</span> createNewInstance(objects, beanName, this.rhs);<a name="line.927"></a> |
| <span class="sourceLineNo">928</span> Object instantiated = objects.get(beanName);<a name="line.928"></a> |
| <span class="sourceLineNo">929</span> setBean(instantiated);<a name="line.929"></a> |
| <span class="sourceLineNo">930</span><a name="line.930"></a> |
| <span class="sourceLineNo">931</span> //also ensure the instantiated bean has access to the event bus or is subscribed to events if necessary:<a name="line.931"></a> |
| <span class="sourceLineNo">932</span> //Note: because events are being enabled on this bean here (before the instantiated event below is<a name="line.932"></a> |
| <span class="sourceLineNo">933</span> //triggered), beans can react to their own instantiation events.<a name="line.933"></a> |
| <span class="sourceLineNo">934</span> enableEventsIfNecessary(instantiated, beanName);<a name="line.934"></a> |
| <span class="sourceLineNo">935</span><a name="line.935"></a> |
| <span class="sourceLineNo">936</span> BeanEvent event = new InstantiatedBeanEvent(beanName, instantiated, Collections.unmodifiableMap(objects));<a name="line.936"></a> |
| <span class="sourceLineNo">937</span> eventBus.publish(event);<a name="line.937"></a> |
| <span class="sourceLineNo">938</span><a name="line.938"></a> |
| <span class="sourceLineNo">939</span> return instantiated;<a name="line.939"></a> |
| <span class="sourceLineNo">940</span> }<a name="line.940"></a> |
| <span class="sourceLineNo">941</span> }<a name="line.941"></a> |
| <span class="sourceLineNo">942</span><a name="line.942"></a> |
| <span class="sourceLineNo">943</span> private class AssignmentStatement extends Statement {<a name="line.943"></a> |
| <span class="sourceLineNo">944</span><a name="line.944"></a> |
| <span class="sourceLineNo">945</span> private final String rootBeanName;<a name="line.945"></a> |
| <span class="sourceLineNo">946</span><a name="line.946"></a> |
| <span class="sourceLineNo">947</span> private AssignmentStatement(String lhs, String rhs) {<a name="line.947"></a> |
| <span class="sourceLineNo">948</span> super(lhs, rhs);<a name="line.948"></a> |
| <span class="sourceLineNo">949</span> int index = lhs.indexOf('.');<a name="line.949"></a> |
| <span class="sourceLineNo">950</span> this.rootBeanName = lhs.substring(0, index);<a name="line.950"></a> |
| <span class="sourceLineNo">951</span> }<a name="line.951"></a> |
| <span class="sourceLineNo">952</span><a name="line.952"></a> |
| <span class="sourceLineNo">953</span> @Override<a name="line.953"></a> |
| <span class="sourceLineNo">954</span> protected Object doExecute() {<a name="line.954"></a> |
| <span class="sourceLineNo">955</span> applyProperty(lhs, rhs, objects);<a name="line.955"></a> |
| <span class="sourceLineNo">956</span> Object bean = objects.get(this.rootBeanName);<a name="line.956"></a> |
| <span class="sourceLineNo">957</span> setBean(bean);<a name="line.957"></a> |
| <span class="sourceLineNo">958</span> return null;<a name="line.958"></a> |
| <span class="sourceLineNo">959</span> }<a name="line.959"></a> |
| <span class="sourceLineNo">960</span><a name="line.960"></a> |
| <span class="sourceLineNo">961</span> public String getRootBeanName() {<a name="line.961"></a> |
| <span class="sourceLineNo">962</span> return this.rootBeanName;<a name="line.962"></a> |
| <span class="sourceLineNo">963</span> }<a name="line.963"></a> |
| <span class="sourceLineNo">964</span> }<a name="line.964"></a> |
| <span class="sourceLineNo">965</span><a name="line.965"></a> |
| <span class="sourceLineNo">966</span>}<a name="line.966"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
