| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| <title>PluginRegistry xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../../../apidocs/org/apache/logging/log4j/core/config/plugins/util/PluginRegistry.html">View Javadoc</a></div><pre> |
| <a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the license.</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.config.plugins.util; |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.net.URI; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.net.URL; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.text.DecimalFormat; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Collections; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Enumeration; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentHashMap; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentMap; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.atomic.AtomicReference; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.Logger; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin; |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAliases; |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.processor.PluginCache; |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.processor.PluginEntry; |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.processor.PluginProcessor; |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.util.Loader; |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.status.StatusLogger; |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.util.Strings; |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * Registry singleton for PluginType maps partitioned by source type and then by category names.</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/util/PluginRegistry.html">PluginRegistry</a> { |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = StatusLogger.getLogger(); |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">volatile</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/util/PluginRegistry.html">PluginRegistry</a> INSTANCE; |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Object INSTANCE_LOCK = <strong class="jxr_keyword">new</strong> Object(); |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Contains plugins found in Log4j2Plugins.dat cache files in the main CLASSPATH.</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> AtomicReference<Map<String, List<PluginType<?>>>> pluginsByCategoryRef = |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">new</strong> AtomicReference<>(); |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Contains plugins found in Log4j2Plugins.dat cache files in OSGi Bundles.</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ConcurrentMap<Long, Map<String, List<PluginType<?>>>> pluginsByCategoryByBundleId = |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">new</strong> ConcurrentHashMap<>(); |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * Contains plugins found by searching for annotated classes at runtime.</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ConcurrentMap<String, Map<String, List<PluginType<?>>>> pluginsByCategoryByPackage = |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">new</strong> ConcurrentHashMap<>(); |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/util/PluginRegistry.html">PluginRegistry</a>() { |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> } |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * Returns the global PluginRegistry instance.</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @return the global PluginRegistry instance.</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @since 2.1</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/util/PluginRegistry.html">PluginRegistry</a> getInstance() { |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/util/PluginRegistry.html">PluginRegistry</a> result = INSTANCE; |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">if</strong> (result == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">synchronized</strong> (INSTANCE_LOCK) { |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> result = INSTANCE; |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">if</strong> (result == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> INSTANCE = result = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/util/PluginRegistry.html">PluginRegistry</a>(); |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> } |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> } |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> } |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">return</strong> result; |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> } |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * Resets the registry to an empty state.</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clear() { |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> pluginsByCategoryRef.set(<strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> pluginsByCategoryByPackage.clear(); |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> pluginsByCategoryByBundleId.clear(); |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> } |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @since 2.1</em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">public</strong> Map<Long, Map<String, List<PluginType<?>>>> getPluginsByCategoryByBundleId() { |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">return</strong> pluginsByCategoryByBundleId; |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> } |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * @since 2.1</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> Map<String, List<PluginType<?>>> loadFromMainClassLoader() { |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">final</strong> Map<String, List<PluginType<?>>> existing = pluginsByCategoryRef.get(); |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">if</strong> (existing != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_comment">// already loaded</em> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">return</strong> existing; |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> } |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">final</strong> Map<String, List<PluginType<?>>> newPluginsByCategory = decodeCacheFiles(Loader.getClassLoader()); |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_comment">// Note multiple threads could be calling this method concurrently. Both will do the work,</em> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_comment">// but only one will be allowed to store the result in the AtomicReference.</em> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_comment">// Return the map produced by whichever thread won the race, so all callers will get the same result.</em> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">if</strong> (pluginsByCategoryRef.compareAndSet(<strong class="jxr_keyword">null</strong>, newPluginsByCategory)) { |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">return</strong> newPluginsByCategory; |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> } |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">return</strong> pluginsByCategoryRef.get(); |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> } |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @since 2.1</em> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clearBundlePlugins(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> bundleId) { |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> pluginsByCategoryByBundleId.remove(bundleId); |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> } |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @since 2.1</em> |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">public</strong> Map<String, List<PluginType<?>>> loadFromBundle(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> bundleId, <strong class="jxr_keyword">final</strong> ClassLoader loader) { |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> Map<String, List<PluginType<?>>> existing = pluginsByCategoryByBundleId.get(bundleId); |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">if</strong> (existing != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_comment">// already loaded from this classloader</em> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">return</strong> existing; |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> } |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">final</strong> Map<String, List<PluginType<?>>> newPluginsByCategory = decodeCacheFiles(loader); |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_comment">// Note multiple threads could be calling this method concurrently. Both will do the work,</em> |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_comment">// but only one will be allowed to store the result in the outer map.</em> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_comment">// Return the inner map produced by whichever thread won the race, so all callers will get the same result.</em> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> existing = pluginsByCategoryByBundleId.putIfAbsent(bundleId, newPluginsByCategory); |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (existing != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">return</strong> existing; |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> } |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">return</strong> newPluginsByCategory; |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> } |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">private</strong> Map<String, List<PluginType<?>>> decodeCacheFiles(<strong class="jxr_keyword">final</strong> ClassLoader loader) { |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> startTime = System.nanoTime(); |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/processor/PluginCache.html">PluginCache</a> cache = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/processor/PluginCache.html">PluginCache</a>(); |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">final</strong> Enumeration<URL> resources = loader.getResources(PluginProcessor.PLUGIN_CACHE_FILE); |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">if</strong> (resources == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> LOGGER.info(<span class="jxr_string">"Plugin preloads not available from class loader {}"</span>, loader); |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> cache.loadCacheFiles(resources); |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> } |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException ioe) { |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> LOGGER.warn(<span class="jxr_string">"Unable to preload plugins"</span>, ioe); |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> } |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">final</strong> Map<String, List<PluginType<?>>> newPluginsByCategory = <strong class="jxr_keyword">new</strong> HashMap<>(); |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">int</strong> pluginCount = 0; |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Map.Entry<String, Map<String, PluginEntry>> <strong class="jxr_keyword">outer</strong> : cache.getAllCategories().entrySet()) { |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">final</strong> String categoryLowerCase = <strong class="jxr_keyword">outer</strong>.getKey(); |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">final</strong> List<PluginType<?>> types = <strong class="jxr_keyword">new</strong> ArrayList<>(<strong class="jxr_keyword">outer</strong>.getValue().size()); |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> newPluginsByCategory.put(categoryLowerCase, types); |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Map.Entry<String, PluginEntry> <strong class="jxr_keyword">inner</strong> : <strong class="jxr_keyword">outer</strong>.getValue().entrySet()) { |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/processor/PluginEntry.html">PluginEntry</a> entry = <strong class="jxr_keyword">inner</strong>.getValue(); |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">final</strong> String className = entry.getClassName(); |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">final</strong> Class<?> clazz = loader.loadClass(className); |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">final</strong> PluginType<?> type = <strong class="jxr_keyword">new</strong> PluginType<>(entry, clazz, entry.getName()); |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> types.add(type); |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> ++pluginCount; |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> ClassNotFoundException e) { |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> LOGGER.info(<span class="jxr_string">"Plugin [{}] could not be loaded due to missing classes."</span>, className, e); |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> LinkageError e) { |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> LOGGER.info(<span class="jxr_string">"Plugin [{}] could not be loaded due to linkage error."</span>, className, e); |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> } |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> } |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> } |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> endTime = System.nanoTime(); |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">final</strong> DecimalFormat numFormat = <strong class="jxr_keyword">new</strong> DecimalFormat(<span class="jxr_string">"#0.000000"</span>); |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">double</strong> seconds = (endTime - startTime) * 1e-9; |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> LOGGER.debug(<span class="jxr_string">"Took {} seconds to load {} plugins from {}"</span>, |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> numFormat.format(seconds), pluginCount, loader); |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">return</strong> newPluginsByCategory; |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> } |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @since 2.1</em> |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">public</strong> Map<String, List<PluginType<?>>> loadFromPackage(<strong class="jxr_keyword">final</strong> String pkg) { |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">if</strong> (Strings.isBlank(pkg)) { |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_comment">// happens when splitting an empty string</em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">return</strong> Collections.emptyMap(); |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> } |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> Map<String, List<PluginType<?>>> existing = pluginsByCategoryByPackage.get(pkg); |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">if</strong> (existing != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_comment">// already loaded this package</em> |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">return</strong> existing; |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> } |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> startTime = System.nanoTime(); |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/util/ResolverUtil.html">ResolverUtil</a> resolver = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/util/ResolverUtil.html">ResolverUtil</a>(); |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">final</strong> ClassLoader classLoader = Loader.getClassLoader(); |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">if</strong> (classLoader != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> resolver.setClassLoader(classLoader); |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> } |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> resolver.findInPackage(<strong class="jxr_keyword">new</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/util/PluginRegistry.html">PluginTest</a>(), pkg); |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">final</strong> Map<String, List<PluginType<?>>> newPluginsByCategory = <strong class="jxr_keyword">new</strong> HashMap<>(); |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Class<?> clazz : resolver.getClasses()) { |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html">Plugin</a> plugin = clazz.getAnnotation(Plugin.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">final</strong> String categoryLowerCase = plugin.category().toLowerCase(); |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> List<PluginType<?>> list = newPluginsByCategory.get(categoryLowerCase); |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">if</strong> (list == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> newPluginsByCategory.put(categoryLowerCase, list = <strong class="jxr_keyword">new</strong> ArrayList<>()); |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> } |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/processor/PluginEntry.html">PluginEntry</a> mainEntry = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/processor/PluginEntry.html">PluginEntry</a>(); |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">final</strong> String mainElementName = plugin.elementType().equals( |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> Plugin.EMPTY) ? plugin.name() : plugin.elementType(); |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> mainEntry.setKey(plugin.name().toLowerCase()); |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> mainEntry.setName(plugin.name()); |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> mainEntry.setCategory(plugin.category()); |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> mainEntry.setClassName(clazz.getName()); |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> mainEntry.setPrintable(plugin.printObject()); |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> mainEntry.setDefer(plugin.deferChildren()); |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">final</strong> PluginType<?> mainType = <strong class="jxr_keyword">new</strong> PluginType<>(mainEntry, clazz, mainElementName); |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> list.add(mainType); |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAliases.html">PluginAliases</a> pluginAliases = clazz.getAnnotation(PluginAliases.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">if</strong> (pluginAliases != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> String alias : pluginAliases.value()) { |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/processor/PluginEntry.html">PluginEntry</a> aliasEntry = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/processor/PluginEntry.html">PluginEntry</a>(); |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">final</strong> String aliasElementName = plugin.elementType().equals( |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> Plugin.EMPTY) ? alias.trim() : plugin.elementType(); |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> aliasEntry.setKey(alias.trim().toLowerCase()); |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> aliasEntry.setName(plugin.name()); |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> aliasEntry.setCategory(plugin.category()); |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> aliasEntry.setClassName(clazz.getName()); |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> aliasEntry.setPrintable(plugin.printObject()); |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> aliasEntry.setDefer(plugin.deferChildren()); |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">final</strong> PluginType<?> aliasType = <strong class="jxr_keyword">new</strong> PluginType<>(aliasEntry, clazz, aliasElementName); |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> list.add(aliasType); |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> } |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> } |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> } |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> endTime = System.nanoTime(); |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">final</strong> DecimalFormat numFormat = <strong class="jxr_keyword">new</strong> DecimalFormat(<span class="jxr_string">"#0.000000"</span>); |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">double</strong> seconds = (endTime - startTime) * 1e-9; |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> LOGGER.debug(<span class="jxr_string">"Took {} seconds to load {} plugins from package {}"</span>, |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> numFormat.format(seconds), resolver.getClasses().size(), pkg); |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_comment">// Note multiple threads could be calling this method concurrently. Both will do the work,</em> |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_comment">// but only one will be allowed to store the result in the outer map.</em> |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_comment">// Return the inner map produced by whichever thread won the race, so all callers will get the same result.</em> |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> existing = pluginsByCategoryByPackage.putIfAbsent(pkg, newPluginsByCategory); |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">if</strong> (existing != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">return</strong> existing; |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> } |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">return</strong> newPluginsByCategory; |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> } |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * A Test that checks to see if each class is annotated with the 'Plugin' annotation. If it</em> |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * is, then the test returns true, otherwise false.</em> |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> * @since 2.1</em> |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/util/PluginRegistry.html">PluginTest</a> <strong class="jxr_keyword">implements</strong> ResolverUtil.Test { |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> @Override |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matches(<strong class="jxr_keyword">final</strong> Class<?> type) { |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">return</strong> type != <strong class="jxr_keyword">null</strong> && type.isAnnotationPresent(Plugin.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> } |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> @Override |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">public</strong> String toString() { |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"annotated with @"</span> + Plugin.<strong class="jxr_keyword">class</strong>.getSimpleName(); |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> } |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> @Override |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matches(<strong class="jxr_keyword">final</strong> URI resource) { |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnsupportedOperationException(); |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> } |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> @Override |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> doesMatchClass() { |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> } |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> @Override |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> doesMatchResource() { |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">return</strong> false; |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> } |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> } |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 1999–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
