| <!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 org.apache.logging.log4j.Logger;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.util.Strings;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Collection;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.HashMap;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.LinkedHashMap;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.Map;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.concurrent.CopyOnWriteArrayList;<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> * Loads and manages all the plugins.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>public class PluginManager {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> private static final CopyOnWriteArrayList<String> PACKAGES = new CopyOnWriteArrayList<>();<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> private static final String LOG4J_PACKAGES = "org.apache.logging.log4j.core";<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> private Map<String, PluginType<?>> plugins = new HashMap<>();<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private final String category;<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> * Constructs a PluginManager for the plugin category name given.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> *<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @param category The plugin category name.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> public PluginManager(final String category) {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> this.category = category;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> }<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Process annotated plugins.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> *<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @deprecated Use {@link org.apache.logging.log4j.core.config.plugins.processor.PluginProcessor} instead. To do so,<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * simply include {@code log4j-core} in your dependencies and make sure annotation processing is not<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * disabled. By default, supported Java compilers will automatically use that plugin processor provided<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * {@code log4j-core} is on the classpath.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> @Deprecated<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> // use PluginProcessor instead<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public static void main(final String[] args) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> System.err.println("ERROR: this tool is superseded by the annotation processor included in log4j-core.");<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> System.err.println("If the annotation processor does not work for you, please see the manual page:");<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> System.err.println("http://logging.apache.org/log4j/2.x/manual/configuration.html#ConfigurationSyntax");<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> System.exit(-1);<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * Adds a package name to be scanned for plugins. Must be invoked prior to plugins being collected.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> *<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @param p The package name. Ignored if {@code null} or empty.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> public static void addPackage(final String p) {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> if (Strings.isBlank(p)) {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> return;<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> }<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> PACKAGES.addIfAbsent(p);<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Adds a list of package names to be scanned for plugins. Convenience method for {@link #addPackage(String)}.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> *<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * @param packages collection of package names to add. Empty and null package names are ignored.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> */<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> public static void addPackages(final Collection<String> packages) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> for (final String pkg : packages) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> if (Strings.isNotBlank(pkg)) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> PACKAGES.addIfAbsent(pkg);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<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> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Returns the type of a specified plugin.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> *<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @param name The name of the plugin.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @return The plugin's type.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> */<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> public PluginType<?> getPluginType(final String name) {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> return plugins.get(name.toLowerCase());<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Returns all the matching plugins.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> *<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @return A Map containing the name of the plugin and its type.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> public Map<String, PluginType<?>> getPlugins() {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> return plugins;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> /**<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * Locates all the plugins.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> public void collectPlugins() {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> collectPlugins(null);<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> * Locates all the plugins including search of specific packages. Warns about name collisions.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> *<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @param packages the list of packages to scan for plugins<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @since 2.1<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> */<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> public void collectPlugins(final List<String> packages) {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> final String categoryLowerCase = category.toLowerCase();<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> final Map<String, PluginType<?>> newPlugins = new LinkedHashMap<>();<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> // First, iterate the Log4j2Plugin.dat files found in the main CLASSPATH<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> Map<String, List<PluginType<?>>> builtInPlugins = PluginRegistry.getInstance().loadFromMainClassLoader();<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> if (builtInPlugins.isEmpty()) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> // If we didn't find any plugins above, someone must have messed with the log4j-core.jar.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> // Search the standard package in the hopes we can find our core plugins.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> builtInPlugins = PluginRegistry.getInstance().loadFromPackage(LOG4J_PACKAGES);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> mergeByName(newPlugins, builtInPlugins.get(categoryLowerCase));<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> // Next, iterate any Log4j2Plugin.dat files from OSGi Bundles<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> for (final Map<String, List<PluginType<?>>> pluginsByCategory : PluginRegistry.getInstance().getPluginsByCategoryByBundleId().values()) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> mergeByName(newPlugins, pluginsByCategory.get(categoryLowerCase));<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> // Next iterate any packages passed to the static addPackage method.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> for (final String pkg : PACKAGES) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> mergeByName(newPlugins, PluginRegistry.getInstance().loadFromPackage(pkg).get(categoryLowerCase));<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> // Finally iterate any packages provided in the configuration (note these can be changed at runtime).<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> if (packages != null) {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> for (final String pkg : packages) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> mergeByName(newPlugins, PluginRegistry.getInstance().loadFromPackage(pkg).get(categoryLowerCase));<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> }<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> LOGGER.debug("PluginManager '{}' found {} plugins", category, newPlugins.size());<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> plugins = newPlugins;<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<a name="line.159"></a> |
| <span class="sourceLineNo">160</span><a name="line.160"></a> |
| <span class="sourceLineNo">161</span> private static void mergeByName(final Map<String, PluginType<?>> newPlugins, final List<PluginType<?>> plugins) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> if (plugins == null) {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> return;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> for (final PluginType<?> pluginType : plugins) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> final String key = pluginType.getKey();<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> final PluginType<?> existing = newPlugins.get(key);<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> if (existing == null) {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> newPlugins.put(key, pluginType);<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> } else if (!existing.getPluginClass().equals(pluginType.getPluginClass())) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> LOGGER.warn("Plugin [{}] is already mapped to {}, ignoring {}",<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> key, existing.getPluginClass(), pluginType.getPluginClass());<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span>}<a name="line.176"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
