| <!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 java.lang.reflect.Constructor;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.Map;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Map.Entry;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.ContextDataInjector;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.util.Loader;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.util.IndexedStringMap;<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>import org.apache.logging.log4j.util.SortedArrayStringMap;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.util.StringMap;<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> * Factory for creating the StringMap instances used to initialize LogEvents' {@linkplain LogEvent#getContextData()<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * context data}. When context data is {@linkplain ContextDataInjector injected} into the log event, these StringMap<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * instances may be either populated with key-value pairs from the context, or completely replaced altogether.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <p><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * By default returns {@code SortedArrayStringMap} objects. Can be configured by setting system property<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * {@code "log4j2.ContextData"} to the fully qualified class name of a class implementing the {@code StringMap}<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * interface. The class must have a public default constructor, and if possible should also have a public constructor<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * that takes a single {@code int} argument for the initial capacity.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * </p><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> *<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @see LogEvent#getContextData()<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @see ContextDataInjector<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @see SortedArrayStringMap<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @since 2.7<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> */<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>public class ContextDataFactory {<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private static final String CLASS_NAME = PropertiesUtil.getProperties().getStringProperty("log4j2.ContextData");<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private static final Class<? extends StringMap> CACHED_CLASS = createCachedClass(CLASS_NAME);<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> * In LOG4J2-2649 (https://issues.apache.org/jira/browse/LOG4J2-2649),<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * the reporter said some reason about using graalvm to static compile.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * In graalvm doc (https://github.com/oracle/graal/blob/master/substratevm/LIMITATIONS.md),<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * graalvm is not support MethodHandle now, so the Constructor need not to return MethodHandle.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private static final Constructor<?> DEFAULT_CONSTRUCTOR = createDefaultConstructor(CACHED_CLASS);<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private static final Constructor<?> INITIAL_CAPACITY_CONSTRUCTOR = createInitialCapacityConstructor(CACHED_CLASS);<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private static final StringMap EMPTY_STRING_MAP = createContextData(0);<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> static {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> EMPTY_STRING_MAP.freeze();<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private static Class<? extends StringMap> createCachedClass(final String className) {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> if (className == null) {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> return null;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> }<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> try {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> return Loader.loadClass(className).asSubclass(IndexedStringMap.class);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> } catch (final Exception any) {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> return null;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> }<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> private static Constructor<?> createDefaultConstructor(final Class<? extends StringMap> cachedClass){<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> if (cachedClass == null) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> return null;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> }<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> try {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> return cachedClass.getConstructor();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> } catch (final NoSuchMethodException | IllegalAccessError ignored) {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> return null;<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> private static Constructor<?> createInitialCapacityConstructor(final Class<? extends StringMap> cachedClass){<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> if (cachedClass == null) {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> return null;<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> try {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> return cachedClass.getConstructor(int.class);<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> } catch (final NoSuchMethodException | IllegalAccessError ignored) {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> return null;<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> }<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> public static StringMap createContextData() {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> if (DEFAULT_CONSTRUCTOR == null) {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> return new SortedArrayStringMap();<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> try {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> return (IndexedStringMap) DEFAULT_CONSTRUCTOR.newInstance();<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> } catch (final Throwable ignored) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return new SortedArrayStringMap();<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> }<a name="line.109"></a> |
| <span class="sourceLineNo">110</span><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> public static StringMap createContextData(final int initialCapacity) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> if (INITIAL_CAPACITY_CONSTRUCTOR == null) {<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> return new SortedArrayStringMap(initialCapacity);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> try {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return (IndexedStringMap) INITIAL_CAPACITY_CONSTRUCTOR.newInstance(initialCapacity);<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> } catch (final Throwable ignored) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> return new SortedArrayStringMap(initialCapacity);<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> public static StringMap createContextData(final Map<String, String> context) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> final StringMap contextData = createContextData(context.size());<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> for (final Entry<String, String> entry : context.entrySet()) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> contextData.putValue(entry.getKey(), entry.getValue());<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> return contextData;<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> public static StringMap createContextData(final ReadOnlyStringMap readOnlyStringMap) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> final StringMap contextData = createContextData(readOnlyStringMap.size());<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> contextData.putAll(readOnlyStringMap);<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> return contextData;<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> }<a name="line.134"></a> |
| <span class="sourceLineNo">135</span><a name="line.135"></a> |
| <span class="sourceLineNo">136</span> /**<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * An empty pre-frozen IndexedStringMap. The returned object may be shared.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> *<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @return an empty pre-frozen IndexedStringMap<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> public static StringMap emptyFrozenContextData() {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> return EMPTY_STRING_MAP;<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>}<a name="line.145"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
