| <!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 or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.logging.log4j.core.config.plugins.util;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.lang.annotation.Annotation;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.lang.reflect.AccessibleObject;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.lang.reflect.Field;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.lang.reflect.InvocationTargetException;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.lang.reflect.Method;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.lang.reflect.Modifier;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Collection;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.Map;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.Objects;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.Logger;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.ConfigurationException;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.config.Node;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.config.plugins.PluginAliases;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.config.plugins.validation.ConstraintValidator;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.config.plugins.validation.ConstraintValidators;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.config.plugins.visitors.PluginVisitor;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.config.plugins.visitors.PluginVisitors;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.util.Builder;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.util.ReflectionUtil;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.logging.log4j.core.util.TypeUtil;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.logging.log4j.util.StringBuilders;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span>/**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * Builder class to instantiate and configure a Plugin object using a PluginFactory method or PluginBuilderFactory<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * builder class.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>public class PluginBuilder implements Builder<Object> {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private final PluginType<?> pluginType;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private final Class<?> clazz;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private Configuration configuration;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private Node node;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> private LogEvent event;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> /**<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * Constructs a PluginBuilder for a given PluginType.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> *<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @param pluginType type of plugin to configure<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public PluginBuilder(final PluginType<?> pluginType) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> this.pluginType = pluginType;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> this.clazz = pluginType.getPluginClass();<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> /**<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * Specifies the Configuration to use for constructing the plugin instance.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> *<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @param configuration the configuration to use.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @return {@code this}<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public PluginBuilder withConfiguration(final Configuration configuration) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> this.configuration = configuration;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> return this;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * Specifies the Node corresponding to the plugin object that will be created.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> *<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @param node the plugin configuration node to use.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @return {@code this}<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public PluginBuilder withConfigurationNode(final Node node) {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> this.node = node;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> return this;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Specifies the LogEvent that may be used to provide extra context for string substitutions.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> *<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @param event the event to use for extra information.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @return {@code this}<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> */<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> public PluginBuilder forLogEvent(final LogEvent event) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> this.event = event;<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> return this;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> }<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> * Builds the plugin object.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @return the plugin object or {@code null} if there was a problem creating it.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> @Override<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> public Object build() {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> verify();<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> // first try to use a builder class if one is available<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> try {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> LOGGER.debug("Building Plugin[name={}, class={}].", pluginType.getElementName(),<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> pluginType.getPluginClass().getName());<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> final Builder<?> builder = createBuilder(this.clazz);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> if (builder != null) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> injectFields(builder);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> return builder.build();<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> } catch (final ConfigurationException e) { // LOG4J2-1908<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> LOGGER.error("Could not create plugin of type {} for element {}", this.clazz, node.getName(), e);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> return null; // no point in trying the factory method<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> } catch (final Exception e) {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> LOGGER.error("Could not create plugin of type {} for element {}: {}",<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> this.clazz, node.getName(),<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> (e instanceof InvocationTargetException ? ((InvocationTargetException) e).getCause() : e).toString(), e);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> }<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> // or fall back to factory method if no builder class is available<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> try {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> final Method factory = findFactoryMethod(this.clazz);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> final Object[] params = generateParameters(factory);<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> return factory.invoke(null, params);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> } catch (final Exception e) {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> LOGGER.error("Unable to invoke factory method in {} for element {}: {}",<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> this.clazz, this.node.getName(),<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> (e instanceof InvocationTargetException ? ((InvocationTargetException) e).getCause() : e).toString(), e);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> return null;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> private void verify() {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> Objects.requireNonNull(this.configuration, "No Configuration object was set.");<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> Objects.requireNonNull(this.node, "No Node object was set.");<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> private static Builder<?> createBuilder(final Class<?> clazz)<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> throws InvocationTargetException, IllegalAccessException {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> for (final Method method : clazz.getDeclaredMethods()) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> if (method.isAnnotationPresent(PluginBuilderFactory.class) &&<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> Modifier.isStatic(method.getModifiers()) &&<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> TypeUtil.isAssignable(Builder.class, method.getReturnType())) {<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> ReflectionUtil.makeAccessible(method);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> return (Builder<?>) method.invoke(null);<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> }<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> return null;<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> private void injectFields(final Builder<?> builder) throws IllegalAccessException {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> final List<Field> fields = TypeUtil.getAllDeclaredFields(builder.getClass());<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> AccessibleObject.setAccessible(fields.toArray(new Field[] {}), true);<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> final StringBuilder log = new StringBuilder();<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> boolean invalid = false;<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> String reason = "";<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> for (final Field field : fields) {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> log.append(log.length() == 0 ? simpleName(builder) + "(" : ", ");<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> final Annotation[] annotations = field.getDeclaredAnnotations();<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> final String[] aliases = extractPluginAliases(annotations);<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> for (final Annotation a : annotations) {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> if (a instanceof PluginAliases) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> continue; // already processed<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> final PluginVisitor<? extends Annotation> visitor =<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> PluginVisitors.findVisitor(a.annotationType());<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> if (visitor != null) {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> final Object value = visitor.setAliases(aliases)<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> .setAnnotation(a)<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> .setConversionType(field.getType())<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> .setStrSubstitutor(configuration.getStrSubstitutor())<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> .setMember(field)<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> .visit(configuration, node, event, log);<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> // don't overwrite default values if the visitor gives us no value to inject<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> if (value != null) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> field.set(builder, value);<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> }<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> final Collection<ConstraintValidator<?>> validators =<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> ConstraintValidators.findValidators(annotations);<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> final Object value = field.get(builder);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> for (final ConstraintValidator<?> validator : validators) {<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> if (!validator.isValid(field.getName(), value)) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> invalid = true;<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> if (!reason.isEmpty()) {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> reason += ", ";<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> reason += "field '" + field.getName() + "' has invalid value '" + value + "'";<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> }<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> log.append(log.length() == 0 ? builder.getClass().getSimpleName() + "()" : ")");<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> LOGGER.debug(log.toString());<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> if (invalid) {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> throw new ConfigurationException("Arguments given for element " + node.getName() + " are invalid: " + reason);<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> }<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> checkForRemainingAttributes();<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> verifyNodeChildrenUsed();<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> /**<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * {@code object.getClass().getSimpleName()} returns {@code Builder}, when we want {@code PatternLayout$Builder}.<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> */<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> private static String simpleName(final Object object) {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> if (object == null) {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> return "null";<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> }<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> final String cls = object.getClass().getName();<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> final int index = cls.lastIndexOf('.');<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> return index < 0 ? cls : cls.substring(index + 1);<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<a name="line.224"></a> |
| <span class="sourceLineNo">225</span><a name="line.225"></a> |
| <span class="sourceLineNo">226</span> private static Method findFactoryMethod(final Class<?> clazz) {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> for (final Method method : clazz.getDeclaredMethods()) {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> if (method.isAnnotationPresent(PluginFactory.class) &&<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> Modifier.isStatic(method.getModifiers())) {<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> ReflectionUtil.makeAccessible(method);<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> return method;<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> }<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> }<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> throw new IllegalStateException("No factory method found for class " + clazz.getName());<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> }<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> private Object[] generateParameters(final Method factory) {<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> final StringBuilder log = new StringBuilder();<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> final Class<?>[] types = factory.getParameterTypes();<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> final Annotation[][] annotations = factory.getParameterAnnotations();<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> final Object[] args = new Object[annotations.length];<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> boolean invalid = false;<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> for (int i = 0; i < annotations.length; i++) {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> log.append(log.length() == 0 ? factory.getName() + "(" : ", ");<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> final String[] aliases = extractPluginAliases(annotations[i]);<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> for (final Annotation a : annotations[i]) {<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> if (a instanceof PluginAliases) {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> continue; // already processed<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> }<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> final PluginVisitor<? extends Annotation> visitor = PluginVisitors.findVisitor(<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> a.annotationType());<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> if (visitor != null) {<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> final Object value = visitor.setAliases(aliases)<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> .setAnnotation(a)<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> .setConversionType(types[i])<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> .setStrSubstitutor(configuration.getStrSubstitutor())<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> .setMember(factory)<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> .visit(configuration, node, event, log);<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> // don't overwrite existing values if the visitor gives us no value to inject<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> if (value != null) {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> args[i] = value;<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> }<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> }<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> }<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> final Collection<ConstraintValidator<?>> validators =<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> ConstraintValidators.findValidators(annotations[i]);<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> final Object value = args[i];<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> final String argName = "arg[" + i + "](" + simpleName(value) + ")";<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> for (final ConstraintValidator<?> validator : validators) {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> if (!validator.isValid(argName, value)) {<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> invalid = true;<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> }<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> }<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> }<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> log.append(log.length() == 0 ? factory.getName() + "()" : ")");<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> checkForRemainingAttributes();<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> verifyNodeChildrenUsed();<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> LOGGER.debug(log.toString());<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> if (invalid) {<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> throw new ConfigurationException("Arguments given for element " + node.getName() + " are invalid");<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> }<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> return args;<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> }<a name="line.283"></a> |
| <span class="sourceLineNo">284</span><a name="line.284"></a> |
| <span class="sourceLineNo">285</span> private static String[] extractPluginAliases(final Annotation... parmTypes) {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> String[] aliases = null;<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> for (final Annotation a : parmTypes) {<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> if (a instanceof PluginAliases) {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> aliases = ((PluginAliases) a).value();<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> return aliases;<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> }<a name="line.293"></a> |
| <span class="sourceLineNo">294</span><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> private void checkForRemainingAttributes() {<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> final Map<String, String> attrs = node.getAttributes();<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> if (!attrs.isEmpty()) {<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> final StringBuilder sb = new StringBuilder();<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> for (final String key : attrs.keySet()) {<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> if (sb.length() == 0) {<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> sb.append(node.getName());<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> sb.append(" contains ");<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> if (attrs.size() == 1) {<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> sb.append("an invalid element or attribute ");<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> } else {<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> sb.append("invalid attributes ");<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> }<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> } else {<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> sb.append(", ");<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> }<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> StringBuilders.appendDqValue(sb, key);<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> }<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> LOGGER.error(sb.toString());<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> }<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> }<a name="line.315"></a> |
| <span class="sourceLineNo">316</span><a name="line.316"></a> |
| <span class="sourceLineNo">317</span> private void verifyNodeChildrenUsed() {<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> final List<Node> children = node.getChildren();<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> if (!(pluginType.isDeferChildren() || children.isEmpty())) {<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> for (final Node child : children) {<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> final String nodeType = node.getType().getElementName();<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> final String start = nodeType.equals(node.getName()) ? node.getName() : nodeType + ' ' + node.getName();<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> LOGGER.error("{} has no parameter that matches element {}", start, child.getName());<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> }<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> }<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
