| <!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.impl;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import org.apache.logging.log4j.ThreadContext;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.logging.log4j.core.ContextDataInjector;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.util.Loader;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.spi.CopyOnWrite;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.spi.DefaultThreadContextMap;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.spi.ReadOnlyThreadContextMap;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.util.ReadOnlyStringMap;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Factory for ContextDataInjectors. Returns a new {@code ContextDataInjector} instance based on the value of system<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * property {@code log4j2.ContextDataInjector}. Users may use this system property to specify the fully qualified class<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * name of a class that implements the {@code ContextDataInjector} interface.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * If no value was specified this factory method returns one of the injectors defined in<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * {@code ThreadContextDataInjector}.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> *<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * @see ContextDataInjector<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @see ReadOnlyStringMap<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @see ThreadContextDataInjector<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * @see LogEvent#getContextData()<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @since 2.7<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>public class ContextDataInjectorFactory {<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> /**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Returns a new {@code ContextDataInjector} instance based on the value of system property<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * {@code log4j2.ContextDataInjector}. If no value was specified this factory method returns one of the<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * {@code ContextDataInjector} classes defined in {@link ThreadContextDataInjector} which is most appropriate for<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * the ThreadContext implementation.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <p><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * Users may use this system property to specify the fully qualified class name of a class that implements the<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * {@code ContextDataInjector} interface.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * </p><p><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * When providing a custom {@code ContextDataInjector}, be aware that this method may be invoked multiple times by<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * the various components in Log4j that need access to context data.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * This includes the object(s) that populate log events, but also various lookups and filters that look at<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * context data to determine whether an event should be logged.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * </p><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> *<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @return a ContextDataInjector that populates the {@code ReadOnlyStringMap} of all {@code LogEvent} objects<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @see LogEvent#getContextData()<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @see ContextDataInjector<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> public static ContextDataInjector createInjector() {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> final String className = PropertiesUtil.getProperties().getStringProperty("log4j2.ContextDataInjector");<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> if (className == null) {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> return createDefaultInjector();<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> try {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> final Class<? extends ContextDataInjector> cls = Loader.loadClass(className).asSubclass(<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> ContextDataInjector.class);<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> return cls.newInstance();<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> } catch (final Exception dynamicFailed) {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> final ContextDataInjector result = createDefaultInjector();<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> StatusLogger.getLogger().warn(<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> "Could not create ContextDataInjector for '{}', using default {}: {}",<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> className, result.getClass().getName(), dynamicFailed);<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> return result;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> }<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> private static ContextDataInjector createDefaultInjector() {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> final ReadOnlyThreadContextMap threadContextMap = ThreadContext.getThreadContextMap();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> // note: map may be null (if legacy custom ThreadContextMap was installed by user)<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> if (threadContextMap instanceof DefaultThreadContextMap || threadContextMap == null) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> return new ThreadContextDataInjector.ForDefaultThreadContextMap(); // for non StringMap-based context maps<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> }<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> if (threadContextMap instanceof CopyOnWrite) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> return new ThreadContextDataInjector.ForCopyOnWriteThreadContextMap();<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> return new ThreadContextDataInjector.ForGarbageFreeThreadContextMap();<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
