Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.2 / log4j-1.2-api / apidocs / src-html / org / apache / log4j / bridge / LogEventAdapter.html
blob: feb539c16aa889b409aa67732e7386b0fa4747cb [file] [log] [blame]
<!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.log4j.bridge;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.log4j.Category;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.log4j.Level;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.log4j.spi.LocationInfo;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.log4j.spi.LoggingEvent;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.log4j.spi.ThrowableInformation;<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.core.util.Throwables;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.spi.StandardLevel;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.lang.reflect.Method;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.Map;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.Set;<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> * Converts a Log4j 2 LogEvent into the components needed by a Log4j 1.x LoggingEvent.<a name="line.35"></a>
<span class="sourceLineNo">036</span> * This class requires Log4j 2.<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>public class LogEventAdapter extends LoggingEvent {<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> private static final long JVM_START_TIME = initStartTime();<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private final LogEvent event;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> public LogEventAdapter(LogEvent event) {<a name="line.44"></a>
<span class="sourceLineNo">045</span> this.event = event;<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> * Returns the time when the application started, in milliseconds<a name="line.49"></a>
<span class="sourceLineNo">050</span> * elapsed since 01.01.1970.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @return the time when the JVM started.<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public static long getStartTime() {<a name="line.53"></a>
<span class="sourceLineNo">054</span> return JVM_START_TIME;<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<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> * Returns the result of {@code ManagementFactory.getRuntimeMXBean().getStartTime()},<a name="line.58"></a>
<span class="sourceLineNo">059</span> * or the current system time if JMX is not available.<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> private static long initStartTime() {<a name="line.61"></a>
<span class="sourceLineNo">062</span> // We'd like to call ManagementFactory.getRuntimeMXBean().getStartTime(),<a name="line.62"></a>
<span class="sourceLineNo">063</span> // but Google App Engine throws a java.lang.NoClassDefFoundError<a name="line.63"></a>
<span class="sourceLineNo">064</span> // "java.lang.management.ManagementFactory is a restricted class".<a name="line.64"></a>
<span class="sourceLineNo">065</span> // The reflection is necessary because without it, Google App Engine<a name="line.65"></a>
<span class="sourceLineNo">066</span> // will refuse to initialize this class.<a name="line.66"></a>
<span class="sourceLineNo">067</span> try {<a name="line.67"></a>
<span class="sourceLineNo">068</span> final Class&lt;?&gt; factoryClass = Loader.loadSystemClass("java.lang.management.ManagementFactory");<a name="line.68"></a>
<span class="sourceLineNo">069</span> final Method getRuntimeMXBean = factoryClass.getMethod("getRuntimeMXBean");<a name="line.69"></a>
<span class="sourceLineNo">070</span> final Object runtimeMXBean = getRuntimeMXBean.invoke(null);<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> final Class&lt;?&gt; runtimeMXBeanClass = Loader.loadSystemClass("java.lang.management.RuntimeMXBean");<a name="line.72"></a>
<span class="sourceLineNo">073</span> final Method getStartTime = runtimeMXBeanClass.getMethod("getStartTime");<a name="line.73"></a>
<span class="sourceLineNo">074</span> return (Long) getStartTime.invoke(runtimeMXBean);<a name="line.74"></a>
<span class="sourceLineNo">075</span> } catch (final Throwable t) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> StatusLogger.getLogger().error("Unable to call ManagementFactory.getRuntimeMXBean().getStartTime(), "<a name="line.76"></a>
<span class="sourceLineNo">077</span> + "using system time for OnStartupTriggeringPolicy", t);<a name="line.77"></a>
<span class="sourceLineNo">078</span> // We have little option but to declare "now" as the beginning of time.<a name="line.78"></a>
<span class="sourceLineNo">079</span> return System.currentTimeMillis();<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> public LogEvent getEvent() {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return this.event;<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> * Set the location information for this logging event. The collected<a name="line.88"></a>
<span class="sourceLineNo">089</span> * information is cached for future use.<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> @Override<a name="line.91"></a>
<span class="sourceLineNo">092</span> public LocationInfo getLocationInformation() {<a name="line.92"></a>
<span class="sourceLineNo">093</span> return new LocationInfo(event.getSource());<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> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Return the level of this event. Use this form instead of directly<a name="line.97"></a>
<span class="sourceLineNo">098</span> * accessing the &lt;code&gt;level&lt;/code&gt; field.<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> @Override<a name="line.100"></a>
<span class="sourceLineNo">101</span> public Level getLevel() {<a name="line.101"></a>
<span class="sourceLineNo">102</span> switch (StandardLevel.getStandardLevel(event.getLevel().intLevel())) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> case TRACE:<a name="line.103"></a>
<span class="sourceLineNo">104</span> return Level.TRACE;<a name="line.104"></a>
<span class="sourceLineNo">105</span> case DEBUG:<a name="line.105"></a>
<span class="sourceLineNo">106</span> return Level.DEBUG;<a name="line.106"></a>
<span class="sourceLineNo">107</span> case INFO:<a name="line.107"></a>
<span class="sourceLineNo">108</span> return Level.INFO;<a name="line.108"></a>
<span class="sourceLineNo">109</span> case WARN:<a name="line.109"></a>
<span class="sourceLineNo">110</span> return Level.WARN;<a name="line.110"></a>
<span class="sourceLineNo">111</span> case FATAL:<a name="line.111"></a>
<span class="sourceLineNo">112</span> return Level.FATAL;<a name="line.112"></a>
<span class="sourceLineNo">113</span> case OFF:<a name="line.113"></a>
<span class="sourceLineNo">114</span> return Level.OFF;<a name="line.114"></a>
<span class="sourceLineNo">115</span> case ALL:<a name="line.115"></a>
<span class="sourceLineNo">116</span> return Level.ALL;<a name="line.116"></a>
<span class="sourceLineNo">117</span> default:<a name="line.117"></a>
<span class="sourceLineNo">118</span> return Level.ERROR;<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> * Return the name of the logger. Use this form instead of directly<a name="line.123"></a>
<span class="sourceLineNo">124</span> * accessing the &lt;code&gt;categoryName&lt;/code&gt; field.<a name="line.124"></a>
<span class="sourceLineNo">125</span> */<a name="line.125"></a>
<span class="sourceLineNo">126</span> @Override<a name="line.126"></a>
<span class="sourceLineNo">127</span> public String getLoggerName() {<a name="line.127"></a>
<span class="sourceLineNo">128</span> return event.getLoggerName();<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<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>
<span class="sourceLineNo">132</span> * Gets the logger of the event.<a name="line.132"></a>
<span class="sourceLineNo">133</span> */<a name="line.133"></a>
<span class="sourceLineNo">134</span> @Override<a name="line.134"></a>
<span class="sourceLineNo">135</span> public Category getLogger() {<a name="line.135"></a>
<span class="sourceLineNo">136</span> return Category.getInstance(event.getLoggerName());<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> /*<a name="line.139"></a>
<span class="sourceLineNo">140</span> Return the message for this logging event.<a name="line.140"></a>
<span class="sourceLineNo">141</span> */<a name="line.141"></a>
<span class="sourceLineNo">142</span> @Override<a name="line.142"></a>
<span class="sourceLineNo">143</span> public Object getMessage() {<a name="line.143"></a>
<span class="sourceLineNo">144</span> return event.getMessage();<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> /*<a name="line.147"></a>
<span class="sourceLineNo">148</span> * This method returns the NDC for this event.<a name="line.148"></a>
<span class="sourceLineNo">149</span> */<a name="line.149"></a>
<span class="sourceLineNo">150</span> @Override<a name="line.150"></a>
<span class="sourceLineNo">151</span> public String getNDC() {<a name="line.151"></a>
<span class="sourceLineNo">152</span> return event.getContextStack().toString();<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> Returns the the context corresponding to the &lt;code&gt;key&lt;/code&gt; parameter.<a name="line.156"></a>
<span class="sourceLineNo">157</span> */<a name="line.157"></a>
<span class="sourceLineNo">158</span> @Override<a name="line.158"></a>
<span class="sourceLineNo">159</span> public Object getMDC(String key) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> if (event.getContextData() != null) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> return event.getContextData().getValue(key);<a name="line.161"></a>
<span class="sourceLineNo">162</span> } else {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return null;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> /**<a name="line.167"></a>
<span class="sourceLineNo">168</span> * Obtain a copy of this thread's MDC prior to serialization or<a name="line.168"></a>
<span class="sourceLineNo">169</span> * asynchronous logging.<a name="line.169"></a>
<span class="sourceLineNo">170</span> */<a name="line.170"></a>
<span class="sourceLineNo">171</span> @Override<a name="line.171"></a>
<span class="sourceLineNo">172</span> public void getMDCCopy() {<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> @Override<a name="line.175"></a>
<span class="sourceLineNo">176</span> public String getRenderedMessage() {<a name="line.176"></a>
<span class="sourceLineNo">177</span> return event.getMessage().getFormattedMessage();<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> @Override<a name="line.180"></a>
<span class="sourceLineNo">181</span> public String getThreadName() {<a name="line.181"></a>
<span class="sourceLineNo">182</span> return event.getThreadName();<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span> /**<a name="line.185"></a>
<span class="sourceLineNo">186</span> * Returns the throwable information contained within this<a name="line.186"></a>
<span class="sourceLineNo">187</span> * event. May be &lt;code&gt;null&lt;/code&gt; if there is no such information.<a name="line.187"></a>
<span class="sourceLineNo">188</span> *<a name="line.188"></a>
<span class="sourceLineNo">189</span> * &lt;p&gt;Note that the {@link Throwable} object contained within a<a name="line.189"></a>
<span class="sourceLineNo">190</span> * {@link ThrowableInformation} does not survive serialization.<a name="line.190"></a>
<span class="sourceLineNo">191</span> *<a name="line.191"></a>
<span class="sourceLineNo">192</span> * @since 1.1<a name="line.192"></a>
<span class="sourceLineNo">193</span> */<a name="line.193"></a>
<span class="sourceLineNo">194</span> @Override<a name="line.194"></a>
<span class="sourceLineNo">195</span> public ThrowableInformation getThrowableInformation() {<a name="line.195"></a>
<span class="sourceLineNo">196</span> if (event.getThrown() != null) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> return new ThrowableInformation(event.getThrown());<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span> return null;<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> /**<a name="line.202"></a>
<span class="sourceLineNo">203</span> * Return this event's throwable's string[] representaion.<a name="line.203"></a>
<span class="sourceLineNo">204</span> */<a name="line.204"></a>
<span class="sourceLineNo">205</span> @Override<a name="line.205"></a>
<span class="sourceLineNo">206</span> public String[] getThrowableStrRep() {<a name="line.206"></a>
<span class="sourceLineNo">207</span> if (event.getThrown() != null) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> return Throwables.toStringList(event.getThrown()).toArray(new String[0]);<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<a name="line.209"></a>
<span class="sourceLineNo">210</span> return null;<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> @Override<a name="line.213"></a>
<span class="sourceLineNo">214</span> public String getProperty(final String key) {<a name="line.214"></a>
<span class="sourceLineNo">215</span> return event.getContextData().getValue(key);<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> @Override<a name="line.218"></a>
<span class="sourceLineNo">219</span> public Set getPropertyKeySet() {<a name="line.219"></a>
<span class="sourceLineNo">220</span> return event.getContextData().toMap().keySet();<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span><a name="line.222"></a>
<span class="sourceLineNo">223</span> @Override<a name="line.223"></a>
<span class="sourceLineNo">224</span> public Map getProperties() {<a name="line.224"></a>
<span class="sourceLineNo">225</span> return event.getContextData().toMap();<a name="line.225"></a>
<span class="sourceLineNo">226</span> }<a name="line.226"></a>
<span class="sourceLineNo">227</span>}<a name="line.227"></a>
</pre>
</div>
</body>
</html>