Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4j / 2.13.0 / log4j-core / xref / org / apache / logging / log4j / core / config / plugins / processor / PluginCache.html
blob: ec2e1cc6975ec7ad13f215990d256ef28f039d71 [file] [log] [blame]
<!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>PluginCache 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/processor/PluginCache.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.processor;
<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.BufferedInputStream;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.BufferedOutputStream;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.DataInputStream;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.DataOutputStream;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.OutputStream;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.net.URL;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Enumeration;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashMap;
<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>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/processor/PluginCache.html">PluginCache</a> {
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map&lt;String, Map&lt;String, PluginEntry&gt;&gt; categories =
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">new</strong> LinkedHashMap&lt;&gt;();
<a class="jxr_linenumber" name="L37" href="#L37">37</a>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * Returns all categories of plugins in this cache.</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @return all categories of plugins in this cache.</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @since 2.1</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">public</strong> Map&lt;String, Map&lt;String, PluginEntry&gt;&gt; getAllCategories() {
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">return</strong> categories;
<a class="jxr_linenumber" name="L46" href="#L46">46</a> }
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * Gets or creates a category of plugins.</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @param category name of category to look up.</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @return plugin mapping of names to plugin entries.</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">public</strong> Map&lt;String, PluginEntry&gt; getCategory(<strong class="jxr_keyword">final</strong> String category) {
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">final</strong> String key = category.toLowerCase();
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">if</strong> (!categories.containsKey(key)) {
<a class="jxr_linenumber" name="L57" href="#L57">57</a> categories.put(key, <strong class="jxr_keyword">new</strong> LinkedHashMap&lt;String, PluginEntry&gt;());
<a class="jxr_linenumber" name="L58" href="#L58">58</a> }
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">return</strong> categories.get(key);
<a class="jxr_linenumber" name="L60" href="#L60">60</a> }
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
<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> <em class="jxr_javadoccomment"> * Stores the plugin cache to a given OutputStream.</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @param os destination to save cache to.</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @throws IOException if an I/O exception occurs.</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_comment">// NOTE: if this file format is to be changed, the filename should change and this format should still be readable</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> writeCache(<strong class="jxr_keyword">final</strong> OutputStream os) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">try</strong> (<strong class="jxr_keyword">final</strong> DataOutputStream out = <strong class="jxr_keyword">new</strong> DataOutputStream(<strong class="jxr_keyword">new</strong> BufferedOutputStream(os))) {
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_comment">// See PluginManager.readFromCacheFiles for the corresponding decoder. Format may not be changed</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_comment">// without breaking existing Log4j2Plugins.dat files.</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> out.writeInt(categories.size());
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Map.Entry&lt;String, Map&lt;String, PluginEntry&gt;&gt; category : categories.entrySet()) {
<a class="jxr_linenumber" name="L75" href="#L75">75</a> out.writeUTF(category.getKey());
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">final</strong> Map&lt;String, PluginEntry&gt; m = category.getValue();
<a class="jxr_linenumber" name="L77" href="#L77">77</a> out.writeInt(m.size());
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Map.Entry&lt;String, PluginEntry&gt; entry : m.entrySet()) {
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/processor/PluginEntry.html">PluginEntry</a> plugin = entry.getValue();
<a class="jxr_linenumber" name="L80" href="#L80">80</a> out.writeUTF(plugin.getKey());
<a class="jxr_linenumber" name="L81" href="#L81">81</a> out.writeUTF(plugin.getClassName());
<a class="jxr_linenumber" name="L82" href="#L82">82</a> out.writeUTF(plugin.getName());
<a class="jxr_linenumber" name="L83" href="#L83">83</a> out.writeBoolean(plugin.isPrintable());
<a class="jxr_linenumber" name="L84" href="#L84">84</a> out.writeBoolean(plugin.isDefer());
<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Loads and merges all the Log4j plugin cache files specified. Usually, this is obtained via a ClassLoader.</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @param resources URLs to all the desired plugin cache files to load.</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @throws IOException if an I/O exception occurs.</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> loadCacheFiles(<strong class="jxr_keyword">final</strong> Enumeration&lt;URL&gt; resources) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> categories.clear();
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">while</strong> (resources.hasMoreElements()) {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">final</strong> URL url = resources.nextElement();
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">try</strong> (<strong class="jxr_keyword">final</strong> DataInputStream in = <strong class="jxr_keyword">new</strong> DataInputStream(<strong class="jxr_keyword">new</strong> BufferedInputStream(url.openStream()))) {
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count = in.readInt();
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; count; i++) {
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">final</strong> String category = in.readUTF();
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">final</strong> Map&lt;String, PluginEntry&gt; m = getCategory(category);
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> entries = in.readInt();
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = 0; j &lt; entries; j++) {
<a class="jxr_linenumber" name="L107" href="#L107">107</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">new</strong> <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/processor/PluginEntry.html">PluginEntry</a>();
<a class="jxr_linenumber" name="L108" href="#L108">108</a> entry.setKey(in.readUTF());
<a class="jxr_linenumber" name="L109" href="#L109">109</a> entry.setClassName(in.readUTF());
<a class="jxr_linenumber" name="L110" href="#L110">110</a> entry.setName(in.readUTF());
<a class="jxr_linenumber" name="L111" href="#L111">111</a> entry.setPrintable(in.readBoolean());
<a class="jxr_linenumber" name="L112" href="#L112">112</a> entry.setDefer(in.readBoolean());
<a class="jxr_linenumber" name="L113" href="#L113">113</a> entry.setCategory(category);
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">if</strong> (!m.containsKey(entry.getKey())) {
<a class="jxr_linenumber" name="L115" href="#L115">115</a> m.put(entry.getKey(), entry);
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * Gets the number of plugin categories registered.</em>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @return number of plugin categories in cache.</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> size() {
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">return</strong> categories.size();
<a class="jxr_linenumber" name="L130" href="#L130">130</a> }
<a class="jxr_linenumber" name="L131" href="#L131">131</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 1999&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>