| <!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.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.net.URI;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.net.URL;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.text.DecimalFormat;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.ArrayList;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Collections;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Enumeration;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.HashMap;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.List;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.Map;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.concurrent.ConcurrentMap;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.concurrent.atomic.AtomicReference;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.Logger;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<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.processor.PluginCache;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.config.plugins.processor.PluginEntry;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.config.plugins.processor.PluginProcessor;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.util.Loader;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.util.Strings;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span>/**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Registry singleton for PluginType maps partitioned by source type and then by category names.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>public class PluginRegistry {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private static volatile PluginRegistry INSTANCE;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> private static final Object INSTANCE_LOCK = new Object();<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Contains plugins found in Log4j2Plugins.dat cache files in the main CLASSPATH.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private final AtomicReference<Map<String, List<PluginType<?>>>> pluginsByCategoryRef =<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> new AtomicReference<>();<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /**<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * Contains plugins found in Log4j2Plugins.dat cache files in OSGi Bundles.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> */<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private final ConcurrentMap<Long, Map<String, List<PluginType<?>>>> pluginsByCategoryByBundleId =<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> new ConcurrentHashMap<>();<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Contains plugins found by searching for annotated classes at runtime.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private final ConcurrentMap<String, Map<String, List<PluginType<?>>>> pluginsByCategoryByPackage =<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> new ConcurrentHashMap<>();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> private PluginRegistry() {<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> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Returns the global PluginRegistry instance.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @return the global PluginRegistry instance.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @since 2.1<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public static PluginRegistry getInstance() {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> PluginRegistry result = INSTANCE;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> if (result == null) {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> synchronized (INSTANCE_LOCK) {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> result = INSTANCE;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> if (result == null) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> INSTANCE = result = new PluginRegistry();<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> }<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> }<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> return result;<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> /**<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * Resets the registry to an empty state.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> public void clear() {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> pluginsByCategoryRef.set(null);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> pluginsByCategoryByPackage.clear();<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> pluginsByCategoryByBundleId.clear();<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @since 2.1<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> public Map<Long, Map<String, List<PluginType<?>>>> getPluginsByCategoryByBundleId() {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return pluginsByCategoryByBundleId;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @since 2.1<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> public Map<String, List<PluginType<?>>> loadFromMainClassLoader() {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> final Map<String, List<PluginType<?>>> existing = pluginsByCategoryRef.get();<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> if (existing != null) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> // already loaded<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> return existing;<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> }<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> final Map<String, List<PluginType<?>>> newPluginsByCategory = decodeCacheFiles(Loader.getClassLoader());<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> // Note multiple threads could be calling this method concurrently. Both will do the work,<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> // but only one will be allowed to store the result in the AtomicReference.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> // Return the map produced by whichever thread won the race, so all callers will get the same result.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> if (pluginsByCategoryRef.compareAndSet(null, newPluginsByCategory)) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> return newPluginsByCategory;<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> return pluginsByCategoryRef.get();<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<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> * @since 2.1<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> */<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> public void clearBundlePlugins(final long bundleId) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> pluginsByCategoryByBundleId.remove(bundleId);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> /**<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @since 2.1<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> */<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> public Map<String, List<PluginType<?>>> loadFromBundle(final long bundleId, final ClassLoader loader) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> Map<String, List<PluginType<?>>> existing = pluginsByCategoryByBundleId.get(bundleId);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> if (existing != null) {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> // already loaded from this classloader<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> return existing;<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> final Map<String, List<PluginType<?>>> newPluginsByCategory = decodeCacheFiles(loader);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> // Note multiple threads could be calling this method concurrently. Both will do the work,<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> // but only one will be allowed to store the result in the outer map.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> // Return the inner map produced by whichever thread won the race, so all callers will get the same result.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> existing = pluginsByCategoryByBundleId.putIfAbsent(bundleId, newPluginsByCategory);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> if (existing != null) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> return existing;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> return newPluginsByCategory;<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> private Map<String, List<PluginType<?>>> decodeCacheFiles(final ClassLoader loader) {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> final long startTime = System.nanoTime();<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> final PluginCache cache = new PluginCache();<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> try {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> final Enumeration<URL> resources = loader.getResources(PluginProcessor.PLUGIN_CACHE_FILE);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> if (resources == null) {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> LOGGER.info("Plugin preloads not available from class loader {}", loader);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> } else {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> cache.loadCacheFiles(resources);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> } catch (final IOException ioe) {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> LOGGER.warn("Unable to preload plugins", ioe);<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> final Map<String, List<PluginType<?>>> newPluginsByCategory = new HashMap<>();<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> int pluginCount = 0;<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> for (final Map.Entry<String, Map<String, PluginEntry>> outer : cache.getAllCategories().entrySet()) {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> final String categoryLowerCase = outer.getKey();<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> final List<PluginType<?>> types = new ArrayList<>(outer.getValue().size());<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> newPluginsByCategory.put(categoryLowerCase, types);<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> for (final Map.Entry<String, PluginEntry> inner : outer.getValue().entrySet()) {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> final PluginEntry entry = inner.getValue();<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> final String className = entry.getClassName();<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> try {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> final Class<?> clazz = loader.loadClass(className);<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> final PluginType<?> type = new PluginType<>(entry, clazz, entry.getName());<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> types.add(type);<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> ++pluginCount;<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> } catch (final ClassNotFoundException e) {<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> LOGGER.info("Plugin [{}] could not be loaded due to missing classes.", className, e);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> } catch (final LinkageError e) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> LOGGER.info("Plugin [{}] could not be loaded due to linkage error.", className, e);<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 int numPlugins = pluginCount;<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> LOGGER.debug(() -> {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> final long endTime = System.nanoTime();<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> StringBuilder sb = new StringBuilder("Took ");<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> final DecimalFormat numFormat = new DecimalFormat("#0.000000");<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> sb.append(numFormat.format((endTime - startTime) * 1e-9));<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> sb.append(" seconds to load ").append(numPlugins);<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> sb.append(" plugins from ").append(loader);<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> return sb.toString();<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> });<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> return newPluginsByCategory;<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> /**<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * @since 2.1<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> */<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> public Map<String, List<PluginType<?>>> loadFromPackage(final String pkg) {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> if (Strings.isBlank(pkg)) {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> // happens when splitting an empty string<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> return Collections.emptyMap();<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> }<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> Map<String, List<PluginType<?>>> existing = pluginsByCategoryByPackage.get(pkg);<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> if (existing != null) {<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> // already loaded this package<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> return existing;<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> }<a name="line.217"></a> |
| <span class="sourceLineNo">218</span><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> final long startTime = System.nanoTime();<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> final ResolverUtil resolver = new ResolverUtil();<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> final ClassLoader classLoader = Loader.getClassLoader();<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> if (classLoader != null) {<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> resolver.setClassLoader(classLoader);<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> resolver.findInPackage(new PluginTest(), pkg);<a name="line.225"></a> |
| <span class="sourceLineNo">226</span><a name="line.226"></a> |
| <span class="sourceLineNo">227</span> final Map<String, List<PluginType<?>>> newPluginsByCategory = new HashMap<>();<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> for (final Class<?> clazz : resolver.getClasses()) {<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> final Plugin plugin = clazz.getAnnotation(Plugin.class);<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> final String categoryLowerCase = plugin.category().toLowerCase();<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> List<PluginType<?>> list = newPluginsByCategory.get(categoryLowerCase);<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> if (list == null) {<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> newPluginsByCategory.put(categoryLowerCase, list = new ArrayList<>());<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> }<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> final PluginEntry mainEntry = new PluginEntry();<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> final String mainElementName = plugin.elementType().equals(<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> Plugin.EMPTY) ? plugin.name() : plugin.elementType();<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> mainEntry.setKey(plugin.name().toLowerCase());<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> mainEntry.setName(plugin.name());<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> mainEntry.setCategory(plugin.category());<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> mainEntry.setClassName(clazz.getName());<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> mainEntry.setPrintable(plugin.printObject());<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> mainEntry.setDefer(plugin.deferChildren());<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> final PluginType<?> mainType = new PluginType<>(mainEntry, clazz, mainElementName);<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> list.add(mainType);<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> final PluginAliases pluginAliases = clazz.getAnnotation(PluginAliases.class);<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> if (pluginAliases != null) {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> for (final String alias : pluginAliases.value()) {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> final PluginEntry aliasEntry = new PluginEntry();<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> final String aliasElementName = plugin.elementType().equals(<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> Plugin.EMPTY) ? alias.trim() : plugin.elementType();<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> aliasEntry.setKey(alias.trim().toLowerCase());<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> aliasEntry.setName(plugin.name());<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> aliasEntry.setCategory(plugin.category());<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> aliasEntry.setClassName(clazz.getName());<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> aliasEntry.setPrintable(plugin.printObject());<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> aliasEntry.setDefer(plugin.deferChildren());<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> final PluginType<?> aliasType = new PluginType<>(aliasEntry, clazz, aliasElementName);<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> list.add(aliasType);<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> }<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> LOGGER.debug(() -> {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> final long endTime = System.nanoTime();<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> StringBuilder sb = new StringBuilder("Took ");<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> final DecimalFormat numFormat = new DecimalFormat("#0.000000");<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> sb.append(numFormat.format((endTime - startTime) * 1e-9));<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> sb.append(" seconds to load ").append(resolver.getClasses().size());<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> sb.append(" plugins from package ").append(pkg);<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> return sb.toString();<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> });<a name="line.271"></a> |
| <span class="sourceLineNo">272</span><a name="line.272"></a> |
| <span class="sourceLineNo">273</span> // Note multiple threads could be calling this method concurrently. Both will do the work,<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> // but only one will be allowed to store the result in the outer map.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> // Return the inner map produced by whichever thread won the race, so all callers will get the same result.<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> existing = pluginsByCategoryByPackage.putIfAbsent(pkg, newPluginsByCategory);<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> if (existing != null) {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> return existing;<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> return newPluginsByCategory;<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> }<a name="line.281"></a> |
| <span class="sourceLineNo">282</span><a name="line.282"></a> |
| <span class="sourceLineNo">283</span> /**<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * A Test that checks to see if each class is annotated with the 'Plugin' annotation. If it<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * is, then the test returns true, otherwise false.<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> *<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * @since 2.1<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> */<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> public static class PluginTest implements ResolverUtil.Test {<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> @Override<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> public boolean matches(final Class<?> type) {<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> return type != null && type.isAnnotationPresent(Plugin.class);<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> @Override<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> public String toString() {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> return "annotated with @" + Plugin.class.getSimpleName();<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> @Override<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> public boolean matches(final URI resource) {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> throw new UnsupportedOperationException();<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> }<a name="line.303"></a> |
| <span class="sourceLineNo">304</span><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> @Override<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> public boolean doesMatchClass() {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> return true;<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> }<a name="line.308"></a> |
| <span class="sourceLineNo">309</span><a name="line.309"></a> |
| <span class="sourceLineNo">310</span> @Override<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> public boolean doesMatchResource() {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> return false;<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> }<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
