| <!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.processor;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.BufferedInputStream;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.BufferedOutputStream;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.DataInputStream;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.DataOutputStream;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.io.IOException;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.io.OutputStream;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.net.URL;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.Enumeration;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.LinkedHashMap;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.Map;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>/**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> *<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>public class PluginCache {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> private final Map<String, Map<String, PluginEntry>> categories =<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> new LinkedHashMap<>();<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> /**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Returns all categories of plugins in this cache.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> *<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @return all categories of plugins in this cache.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @since 2.1<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> public Map<String, Map<String, PluginEntry>> getAllCategories() {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> return categories;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> }<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> /**<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * Gets or creates a category of plugins.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> *<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @param category name of category to look up.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * @return plugin mapping of names to plugin entries.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> */<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public Map<String, PluginEntry> getCategory(final String category) {<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> final String key = category.toLowerCase();<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> if (!categories.containsKey(key)) {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> categories.put(key, new LinkedHashMap<String, PluginEntry>());<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> }<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> return categories.get(key);<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> }<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Stores the plugin cache to a given OutputStream.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> *<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @param os destination to save cache to.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @throws IOException if an I/O exception occurs.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> // NOTE: if this file format is to be changed, the filename should change and this format should still be readable<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public void writeCache(final OutputStream os) throws IOException {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> try (final DataOutputStream out = new DataOutputStream(new BufferedOutputStream(os))) {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> // See PluginManager.readFromCacheFiles for the corresponding decoder. Format may not be changed<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> // without breaking existing Log4j2Plugins.dat files.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> out.writeInt(categories.size());<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> for (final Map.Entry<String, Map<String, PluginEntry>> category : categories.entrySet()) {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> out.writeUTF(category.getKey());<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> final Map<String, PluginEntry> m = category.getValue();<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> out.writeInt(m.size());<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> for (final Map.Entry<String, PluginEntry> entry : m.entrySet()) {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> final PluginEntry plugin = entry.getValue();<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> out.writeUTF(plugin.getKey());<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> out.writeUTF(plugin.getClassName());<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> out.writeUTF(plugin.getName());<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> out.writeBoolean(plugin.isPrintable());<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> out.writeBoolean(plugin.isDefer());<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> }<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> * Loads and merges all the Log4j plugin cache files specified. Usually, this is obtained via a ClassLoader.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> *<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param resources URLs to all the desired plugin cache files to load.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @throws IOException if an I/O exception occurs.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public void loadCacheFiles(final Enumeration<URL> resources) throws IOException {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> categories.clear();<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> while (resources.hasMoreElements()) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> final URL url = resources.nextElement();<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> try (final DataInputStream in = new DataInputStream(new BufferedInputStream(url.openStream()))) {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> final int count = in.readInt();<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> for (int i = 0; i < count; i++) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> final String category = in.readUTF();<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> final Map<String, PluginEntry> m = getCategory(category);<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> final int entries = in.readInt();<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> for (int j = 0; j < entries; j++) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> final PluginEntry entry = new PluginEntry();<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> entry.setKey(in.readUTF());<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> entry.setClassName(in.readUTF());<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> entry.setName(in.readUTF());<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> entry.setPrintable(in.readBoolean());<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> entry.setDefer(in.readBoolean());<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> entry.setCategory(category);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> if (!m.containsKey(entry.getKey())) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> m.put(entry.getKey(), entry);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> }<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> /**<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * Gets the number of plugin categories registered.<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> *<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * @return number of plugin categories in cache.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> */<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> public int size() {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> return categories.size();<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span>}<a name="line.131"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
