2.13.2/log4j-core/apidocs/src-html/org/apache/logging/log4j/core/util/WatcherFactory.html - logging-log4j-site - Git at Google

 <!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>package org.apache.logging.log4j.core.util;<a name="line.17"></a>
 <span class="sourceLineNo">018</span><a name="line.18"></a>
 <span class="sourceLineNo">019</span>import java.lang.reflect.Constructor;<a name="line.19"></a>
 <span class="sourceLineNo">020</span>import java.lang.reflect.InvocationTargetException;<a name="line.20"></a>
 <span class="sourceLineNo">021</span>import java.util.List;<a name="line.21"></a>
 <span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a>
 <span class="sourceLineNo">023</span>import java.util.Objects;<a name="line.23"></a>
 <span class="sourceLineNo">024</span><a name="line.24"></a>
 <span class="sourceLineNo">025</span>import org.apache.logging.log4j.Logger;<a name="line.25"></a>
 <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.26"></a>
 <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.ConfigurationFileWatcher;<a name="line.27"></a>
 <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.ConfigurationListener;<a name="line.28"></a>
 <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.Reconfigurable;<a name="line.29"></a>
 <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.util.PluginManager;<a name="line.30"></a>
 <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.util.PluginType;<a name="line.31"></a>
 <span class="sourceLineNo">032</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.32"></a>
 <span class="sourceLineNo">033</span><a name="line.33"></a>
 <span class="sourceLineNo">034</span>/**<a name="line.34"></a>
 <span class="sourceLineNo">035</span> * Creates Watchers of various types.<a name="line.35"></a>
 <span class="sourceLineNo">036</span> */<a name="line.36"></a>
 <span class="sourceLineNo">037</span>public class WatcherFactory {<a name="line.37"></a>
 <span class="sourceLineNo">038</span><a name="line.38"></a>
 <span class="sourceLineNo">039</span>    private static Logger LOGGER = StatusLogger.getLogger();<a name="line.39"></a>
 <span class="sourceLineNo">040</span>    private static PluginManager pluginManager = new PluginManager(Watcher.CATEGORY);<a name="line.40"></a>
 <span class="sourceLineNo">041</span><a name="line.41"></a>
 <span class="sourceLineNo">042</span>    private static volatile WatcherFactory factory = null;<a name="line.42"></a>
 <span class="sourceLineNo">043</span><a name="line.43"></a>
 <span class="sourceLineNo">044</span>    private final Map&lt;String, PluginType&lt;?&gt;&gt; plugins;<a name="line.44"></a>
 <span class="sourceLineNo">045</span><a name="line.45"></a>
 <span class="sourceLineNo">046</span>    private WatcherFactory(List&lt;String&gt; packages) {<a name="line.46"></a>
 <span class="sourceLineNo">047</span>        pluginManager.collectPlugins(packages);<a name="line.47"></a>
 <span class="sourceLineNo">048</span>        plugins = pluginManager.getPlugins();<a name="line.48"></a>
 <span class="sourceLineNo">049</span>    }<a name="line.49"></a>
 <span class="sourceLineNo">050</span><a name="line.50"></a>
 <span class="sourceLineNo">051</span>    public static WatcherFactory getInstance(List&lt;String&gt; packages) {<a name="line.51"></a>
 <span class="sourceLineNo">052</span>        if (factory == null) {<a name="line.52"></a>
 <span class="sourceLineNo">053</span>            synchronized (pluginManager) {<a name="line.53"></a>
 <span class="sourceLineNo">054</span>                if (factory == null) {<a name="line.54"></a>
 <span class="sourceLineNo">055</span>                    factory = new WatcherFactory(packages);<a name="line.55"></a>
 <span class="sourceLineNo">056</span>                }<a name="line.56"></a>
 <span class="sourceLineNo">057</span>            }<a name="line.57"></a>
 <span class="sourceLineNo">058</span>        }<a name="line.58"></a>
 <span class="sourceLineNo">059</span>        return factory;<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>    @SuppressWarnings("unchecked")<a name="line.62"></a>
 <span class="sourceLineNo">063</span>    public Watcher newWatcher(Source source, final Configuration configuration, final Reconfigurable reconfigurable,<a name="line.63"></a>
 <span class="sourceLineNo">064</span>        final List&lt;ConfigurationListener&gt; configurationListeners, long lastModifiedMillis) {<a name="line.64"></a>
 <span class="sourceLineNo">065</span>        if (source.getFile() != null) {<a name="line.65"></a>
 <span class="sourceLineNo">066</span>            return new ConfigurationFileWatcher(configuration, reconfigurable, configurationListeners,<a name="line.66"></a>
 <span class="sourceLineNo">067</span>                lastModifiedMillis);<a name="line.67"></a>
 <span class="sourceLineNo">068</span>        } else {<a name="line.68"></a>
 <span class="sourceLineNo">069</span>            String name = source.getURI().getScheme();<a name="line.69"></a>
 <span class="sourceLineNo">070</span>            PluginType&lt;?&gt; pluginType = plugins.get(name);<a name="line.70"></a>
 <span class="sourceLineNo">071</span>            if (pluginType != null) {<a name="line.71"></a>
 <span class="sourceLineNo">072</span>                return instantiate(name, (Class&lt;? extends Watcher&gt;) pluginType.getPluginClass(), configuration,<a name="line.72"></a>
 <span class="sourceLineNo">073</span>                    reconfigurable, configurationListeners, lastModifiedMillis);<a name="line.73"></a>
 <span class="sourceLineNo">074</span>            }<a name="line.74"></a>
 <span class="sourceLineNo">075</span>            LOGGER.info("No Watcher plugin is available for protocol '{}'", name);<a name="line.75"></a>
 <span class="sourceLineNo">076</span>            return null;<a name="line.76"></a>
 <span class="sourceLineNo">077</span>        }<a name="line.77"></a>
 <span class="sourceLineNo">078</span>    }<a name="line.78"></a>
 <span class="sourceLineNo">079</span><a name="line.79"></a>
 <span class="sourceLineNo">080</span>    public static &lt;T extends Watcher&gt; T instantiate(String name, final Class&lt;T&gt; clazz,<a name="line.80"></a>
 <span class="sourceLineNo">081</span>        final Configuration configuration, final Reconfigurable reconfigurable,<a name="line.81"></a>
 <span class="sourceLineNo">082</span>        final List&lt;ConfigurationListener&gt; listeners, long lastModifiedMillis) {<a name="line.82"></a>
 <span class="sourceLineNo">083</span>        Objects.requireNonNull(clazz, "No class provided");<a name="line.83"></a>
 <span class="sourceLineNo">084</span>        try {<a name="line.84"></a>
 <span class="sourceLineNo">085</span>            Constructor&lt;T&gt; constructor = clazz<a name="line.85"></a>
 <span class="sourceLineNo">086</span>                .getConstructor(Configuration.class, Reconfigurable.class, List.class, long.class);<a name="line.86"></a>
 <span class="sourceLineNo">087</span>            return constructor.newInstance(configuration, reconfigurable, listeners, lastModifiedMillis);<a name="line.87"></a>
 <span class="sourceLineNo">088</span>        } catch (NoSuchMethodException ex) {<a name="line.88"></a>
 <span class="sourceLineNo">089</span>            throw new IllegalArgumentException("No valid constructor for Watcher plugin " + name, ex);<a name="line.89"></a>
 <span class="sourceLineNo">090</span>        } catch (final LinkageError | InstantiationException e) {<a name="line.90"></a>
 <span class="sourceLineNo">091</span>            // LOG4J2-1051<a name="line.91"></a>
 <span class="sourceLineNo">092</span>            // On platforms like Google App Engine and Android, some JRE classes are not supported: JMX, JNDI, etc.<a name="line.92"></a>
 <span class="sourceLineNo">093</span>            throw new IllegalArgumentException(e);<a name="line.93"></a>
 <span class="sourceLineNo">094</span>        } catch (final IllegalAccessException e) {<a name="line.94"></a>
 <span class="sourceLineNo">095</span>            throw new IllegalStateException(e);<a name="line.95"></a>
 <span class="sourceLineNo">096</span>        } catch (final InvocationTargetException e) {<a name="line.96"></a>
 <span class="sourceLineNo">097</span>            Throwables.rethrow(e.getCause());<a name="line.97"></a>
 <span class="sourceLineNo">098</span>            throw new InternalError("Unreachable");<a name="line.98"></a>
 <span class="sourceLineNo">099</span>        }<a name="line.99"></a>
 <span class="sourceLineNo">100</span>    }<a name="line.100"></a>
 <span class="sourceLineNo">101</span>}<a name="line.101"></a>


 </pre>
 </div>
 </body>
 </html>
	<!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>package org.apache.logging.log4j.core.util;<a name="line.17"></a>
	<span class="sourceLineNo">018</span><a name="line.18"></a>
	<span class="sourceLineNo">019</span>import java.lang.reflect.Constructor;<a name="line.19"></a>
	<span class="sourceLineNo">020</span>import java.lang.reflect.InvocationTargetException;<a name="line.20"></a>
	<span class="sourceLineNo">021</span>import java.util.List;<a name="line.21"></a>
	<span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a>
	<span class="sourceLineNo">023</span>import java.util.Objects;<a name="line.23"></a>
	<span class="sourceLineNo">024</span><a name="line.24"></a>
	<span class="sourceLineNo">025</span>import org.apache.logging.log4j.Logger;<a name="line.25"></a>
	<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.26"></a>
	<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.ConfigurationFileWatcher;<a name="line.27"></a>
	<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.ConfigurationListener;<a name="line.28"></a>
	<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.Reconfigurable;<a name="line.29"></a>
	<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.util.PluginManager;<a name="line.30"></a>
	<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.util.PluginType;<a name="line.31"></a>
	<span class="sourceLineNo">032</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.32"></a>
	<span class="sourceLineNo">033</span><a name="line.33"></a>
	<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
	<span class="sourceLineNo">035</span> * Creates Watchers of various types.<a name="line.35"></a>
	<span class="sourceLineNo">036</span> */<a name="line.36"></a>
	<span class="sourceLineNo">037</span>public class WatcherFactory {<a name="line.37"></a>
	<span class="sourceLineNo">038</span><a name="line.38"></a>
	<span class="sourceLineNo">039</span> private static Logger LOGGER = StatusLogger.getLogger();<a name="line.39"></a>
	<span class="sourceLineNo">040</span> private static PluginManager pluginManager = new PluginManager(Watcher.CATEGORY);<a name="line.40"></a>
	<span class="sourceLineNo">041</span><a name="line.41"></a>
	<span class="sourceLineNo">042</span> private static volatile WatcherFactory factory = null;<a name="line.42"></a>
	<span class="sourceLineNo">043</span><a name="line.43"></a>
	<span class="sourceLineNo">044</span> private final Map<String, PluginType<?>> plugins;<a name="line.44"></a>
	<span class="sourceLineNo">045</span><a name="line.45"></a>
	<span class="sourceLineNo">046</span> private WatcherFactory(List<String> packages) {<a name="line.46"></a>
	<span class="sourceLineNo">047</span> pluginManager.collectPlugins(packages);<a name="line.47"></a>
	<span class="sourceLineNo">048</span> plugins = pluginManager.getPlugins();<a name="line.48"></a>
	<span class="sourceLineNo">049</span> }<a name="line.49"></a>
	<span class="sourceLineNo">050</span><a name="line.50"></a>
	<span class="sourceLineNo">051</span> public static WatcherFactory getInstance(List<String> packages) {<a name="line.51"></a>
	<span class="sourceLineNo">052</span> if (factory == null) {<a name="line.52"></a>
	<span class="sourceLineNo">053</span> synchronized (pluginManager) {<a name="line.53"></a>
	<span class="sourceLineNo">054</span> if (factory == null) {<a name="line.54"></a>
	<span class="sourceLineNo">055</span> factory = new WatcherFactory(packages);<a name="line.55"></a>
	<span class="sourceLineNo">056</span> }<a name="line.56"></a>
	<span class="sourceLineNo">057</span> }<a name="line.57"></a>
	<span class="sourceLineNo">058</span> }<a name="line.58"></a>
	<span class="sourceLineNo">059</span> return factory;<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> @SuppressWarnings("unchecked")<a name="line.62"></a>
	<span class="sourceLineNo">063</span> public Watcher newWatcher(Source source, final Configuration configuration, final Reconfigurable reconfigurable,<a name="line.63"></a>
	<span class="sourceLineNo">064</span> final List<ConfigurationListener> configurationListeners, long lastModifiedMillis) {<a name="line.64"></a>
	<span class="sourceLineNo">065</span> if (source.getFile() != null) {<a name="line.65"></a>
	<span class="sourceLineNo">066</span> return new ConfigurationFileWatcher(configuration, reconfigurable, configurationListeners,<a name="line.66"></a>
	<span class="sourceLineNo">067</span> lastModifiedMillis);<a name="line.67"></a>
	<span class="sourceLineNo">068</span> } else {<a name="line.68"></a>
	<span class="sourceLineNo">069</span> String name = source.getURI().getScheme();<a name="line.69"></a>
	<span class="sourceLineNo">070</span> PluginType<?> pluginType = plugins.get(name);<a name="line.70"></a>
	<span class="sourceLineNo">071</span> if (pluginType != null) {<a name="line.71"></a>
	<span class="sourceLineNo">072</span> return instantiate(name, (Class<? extends Watcher>) pluginType.getPluginClass(), configuration,<a name="line.72"></a>
	<span class="sourceLineNo">073</span> reconfigurable, configurationListeners, lastModifiedMillis);<a name="line.73"></a>
	<span class="sourceLineNo">074</span> }<a name="line.74"></a>
	<span class="sourceLineNo">075</span> LOGGER.info("No Watcher plugin is available for protocol '{}'", name);<a name="line.75"></a>
	<span class="sourceLineNo">076</span> return null;<a name="line.76"></a>
	<span class="sourceLineNo">077</span> }<a name="line.77"></a>
	<span class="sourceLineNo">078</span> }<a name="line.78"></a>
	<span class="sourceLineNo">079</span><a name="line.79"></a>
	<span class="sourceLineNo">080</span> public static <T extends Watcher> T instantiate(String name, final Class<T> clazz,<a name="line.80"></a>
	<span class="sourceLineNo">081</span> final Configuration configuration, final Reconfigurable reconfigurable,<a name="line.81"></a>
	<span class="sourceLineNo">082</span> final List<ConfigurationListener> listeners, long lastModifiedMillis) {<a name="line.82"></a>
	<span class="sourceLineNo">083</span> Objects.requireNonNull(clazz, "No class provided");<a name="line.83"></a>
	<span class="sourceLineNo">084</span> try {<a name="line.84"></a>
	<span class="sourceLineNo">085</span> Constructor<T> constructor = clazz<a name="line.85"></a>
	<span class="sourceLineNo">086</span> .getConstructor(Configuration.class, Reconfigurable.class, List.class, long.class);<a name="line.86"></a>
	<span class="sourceLineNo">087</span> return constructor.newInstance(configuration, reconfigurable, listeners, lastModifiedMillis);<a name="line.87"></a>
	<span class="sourceLineNo">088</span> } catch (NoSuchMethodException ex) {<a name="line.88"></a>
	<span class="sourceLineNo">089</span> throw new IllegalArgumentException("No valid constructor for Watcher plugin " + name, ex);<a name="line.89"></a>
	<span class="sourceLineNo">090</span> } catch (final LinkageError \| InstantiationException e) {<a name="line.90"></a>
	<span class="sourceLineNo">091</span> // LOG4J2-1051<a name="line.91"></a>
	<span class="sourceLineNo">092</span> // On platforms like Google App Engine and Android, some JRE classes are not supported: JMX, JNDI, etc.<a name="line.92"></a>
	<span class="sourceLineNo">093</span> throw new IllegalArgumentException(e);<a name="line.93"></a>
	<span class="sourceLineNo">094</span> } catch (final IllegalAccessException e) {<a name="line.94"></a>
	<span class="sourceLineNo">095</span> throw new IllegalStateException(e);<a name="line.95"></a>
	<span class="sourceLineNo">096</span> } catch (final InvocationTargetException e) {<a name="line.96"></a>
	<span class="sourceLineNo">097</span> Throwables.rethrow(e.getCause());<a name="line.97"></a>
	<span class="sourceLineNo">098</span> throw new InternalError("Unreachable");<a name="line.98"></a>
	<span class="sourceLineNo">099</span> }<a name="line.99"></a>
	<span class="sourceLineNo">100</span> }<a name="line.100"></a>
	<span class="sourceLineNo">101</span>}<a name="line.101"></a>




























































	</pre>
	</div>
	</body>
	</html>