| <!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.async;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.Arrays;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Map;<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.Level;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.Marker;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.ThreadContext.ContextStack;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.impl.ContextDataFactory;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.impl.Log4jLogEvent;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.impl.MementoMessage;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.impl.ThrowableProxy;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.util.*;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.time.Instant;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.time.MutableInstant;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.message.*;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.util.ReadOnlyStringMap;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.util.StringBuilders;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.util.StringMap;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.util.Strings;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import com.lmax.disruptor.EventFactory;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span>/**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * When the Disruptor is started, the RingBuffer is populated with event objects. These objects are then re-used during<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * the life of the RingBuffer.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>public class RingBufferLogEvent implements LogEvent, ReusableMessage, CharSequence, ParameterVisitable {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> /** The {@code EventFactory} for {@code RingBufferLogEvent}s. */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> public static final Factory FACTORY = new Factory();<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private static final long serialVersionUID = 8462119088943934758L;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> private static final Message EMPTY = new SimpleMessage(Strings.EMPTY);<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Creates the events that will be put in the RingBuffer.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private static class Factory implements EventFactory<RingBufferLogEvent> {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> @Override<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> public RingBufferLogEvent newInstance() {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> return new RingBufferLogEvent();<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> }<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> }<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private int threadPriority;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> private long threadId;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private final MutableInstant instant = new MutableInstant();<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> private long nanoTime;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private short parameterCount;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> private boolean includeLocation;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> private boolean endOfBatch = false;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> private Level level;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private String threadName;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> private String loggerName;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> private Message message;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> private String messageFormat;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> private StringBuilder messageText;<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> private Object[] parameters;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> private transient Throwable thrown;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> private ThrowableProxy thrownProxy;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> private StringMap contextData = ContextDataFactory.createContextData();<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> private Marker marker;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> private String fqcn;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private StackTraceElement location;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> private ContextStack contextStack;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> private transient AsyncLogger asyncLogger;<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> public void setValues(final AsyncLogger anAsyncLogger, final String aLoggerName, final Marker aMarker,<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> final String theFqcn, final Level aLevel, final Message msg, final Throwable aThrowable,<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> final StringMap mutableContextData, final ContextStack aContextStack, final long threadId,<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> final String threadName, final int threadPriority, final StackTraceElement aLocation,<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> final Clock clock, final NanoClock nanoClock) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> this.threadPriority = threadPriority;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> this.threadId = threadId;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> this.level = aLevel;<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> this.threadName = threadName;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> this.loggerName = aLoggerName;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> setMessage(msg);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> initTime(clock);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> this.nanoTime = nanoClock.nanoTime();<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> this.thrown = aThrowable;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> this.thrownProxy = null;<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> this.marker = aMarker;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> this.fqcn = theFqcn;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> this.location = aLocation;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> this.contextData = mutableContextData;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> this.contextStack = aContextStack;<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> this.asyncLogger = anAsyncLogger;<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> }<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> private void initTime(final Clock clock) {<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> if (message instanceof TimestampMessage) {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> instant.initFromEpochMilli(((TimestampMessage) message).getTimestamp(), 0);<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> } else {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> instant.initFrom(clock);<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> }<a name="line.118"></a> |
| <span class="sourceLineNo">119</span><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> @Override<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> public LogEvent toImmutable() {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> return createMemento();<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> private void setMessage(final Message msg) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> if (msg instanceof ReusableMessage) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> final ReusableMessage reusable = (ReusableMessage) msg;<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> reusable.formatTo(getMessageTextForWriting());<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> messageFormat = reusable.getFormat();<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> parameters = reusable.swapParameters(parameters == null ? new Object[10] : parameters);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> parameterCount = reusable.getParameterCount();<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> } else {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> this.message = InternalAsyncUtil.makeMessageImmutable(msg);<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> private StringBuilder getMessageTextForWriting() {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> if (messageText == null) {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> // Happens the first time messageText is requested or if a user logs<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> // a custom reused message when Constants.ENABLE_THREADLOCALS is false<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> messageText = new StringBuilder(Constants.INITIAL_REUSABLE_MESSAGE_SIZE);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> messageText.setLength(0);<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> return messageText;<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> * Event processor that reads the event from the ringbuffer can call this method.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> *<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @param endOfBatch flag to indicate if this is the last event in a batch from the RingBuffer<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> */<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> public void execute(final boolean endOfBatch) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> this.endOfBatch = endOfBatch;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> asyncLogger.actualAsyncLog(this);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> /**<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * Returns {@code true} if this event is the end of a batch, {@code false} otherwise.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> *<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @return {@code true} if this event is the end of a batch, {@code false} otherwise<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> */<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> @Override<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> public boolean isEndOfBatch() {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return endOfBatch;<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> @Override<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> public void setEndOfBatch(final boolean endOfBatch) {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> this.endOfBatch = endOfBatch;<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> @Override<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> public boolean isIncludeLocation() {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> return includeLocation;<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> |
| <span class="sourceLineNo">177</span> @Override<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> public void setIncludeLocation(final boolean includeLocation) {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> this.includeLocation = includeLocation;<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> }<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> @Override<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> public String getLoggerName() {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> return loggerName;<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> }<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> @Override<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> public Marker getMarker() {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> return marker;<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span><a name="line.191"></a> |
| <span class="sourceLineNo">192</span> @Override<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> public String getLoggerFqcn() {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return fqcn;<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span><a name="line.196"></a> |
| <span class="sourceLineNo">197</span> @Override<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> public Level getLevel() {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> if (level == null) {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> level = Level.OFF; // LOG4J2-462, LOG4J2-465<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> }<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> return level;<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<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 Message getMessage() {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> if (message == null) {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> return messageText == null ? EMPTY : this;<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> }<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> return message;<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> /**<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * @see ReusableMessage#getFormattedMessage()<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> */<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> @Override<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> public String getFormattedMessage() {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> return messageText != null // LOG4J2-1527: may be null in web apps<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> ? messageText.toString() // note: please keep below "redundant" braces for readability<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> : (message == null ? null : message.getFormattedMessage());<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> /**<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * @see ReusableMessage#getFormat()<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> */<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> @Override<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> public String getFormat() {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> return messageFormat;<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> }<a name="line.229"></a> |
| <span class="sourceLineNo">230</span><a name="line.230"></a> |
| <span class="sourceLineNo">231</span> /**<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * @see ReusableMessage#getParameters()<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> */<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> @Override<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> public Object[] getParameters() {<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> return parameters == null ? null : Arrays.copyOf(parameters, parameterCount);<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> }<a name="line.237"></a> |
| <span class="sourceLineNo">238</span><a name="line.238"></a> |
| <span class="sourceLineNo">239</span> /**<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * @see ReusableMessage#getThrowable()<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> */<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> @Override<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> public Throwable getThrowable() {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> return getThrown();<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> }<a name="line.245"></a> |
| <span class="sourceLineNo">246</span><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> /**<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * @see ReusableMessage#formatTo(StringBuilder)<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> */<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> @Override<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> public void formatTo(final StringBuilder buffer) {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> buffer.append(messageText);<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> }<a name="line.253"></a> |
| <span class="sourceLineNo">254</span><a name="line.254"></a> |
| <span class="sourceLineNo">255</span> /**<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * Replaces this ReusableMessage's parameter array with the specified value and return the original array<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * @param emptyReplacement the parameter array that can be used for subsequent uses of this reusable message<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * @return the original parameter array<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * @see ReusableMessage#swapParameters(Object[])<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> */<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> @Override<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> public Object[] swapParameters(final Object[] emptyReplacement) {<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> final Object[] result = this.parameters;<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> this.parameters = emptyReplacement;<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> return result;<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> }<a name="line.266"></a> |
| <span class="sourceLineNo">267</span><a name="line.267"></a> |
| <span class="sourceLineNo">268</span> /*<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * @see ReusableMessage#getParameterCount<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> */<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> @Override<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> public short getParameterCount() {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> return parameterCount;<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> }<a name="line.274"></a> |
| <span class="sourceLineNo">275</span><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> @Override<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> public <S> void forEachParameter(final ParameterConsumer<S> action, final S state) {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> if (parameters != null) {<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> for (short i = 0; i < parameterCount; i++) {<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> action.accept(parameters[i], i, state);<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> }<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> }<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> }<a name="line.283"></a> |
| <span class="sourceLineNo">284</span><a name="line.284"></a> |
| <span class="sourceLineNo">285</span> @Override<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> public Message memento() {<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> if (message == null) {<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> message = new MementoMessage(String.valueOf(messageText), messageFormat, getParameters());<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> }<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> return message;<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> }<a name="line.291"></a> |
| <span class="sourceLineNo">292</span><a name="line.292"></a> |
| <span class="sourceLineNo">293</span> // CharSequence impl<a name="line.293"></a> |
| <span class="sourceLineNo">294</span><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> @Override<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> public int length() {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> return messageText.length();<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> }<a name="line.298"></a> |
| <span class="sourceLineNo">299</span><a name="line.299"></a> |
| <span class="sourceLineNo">300</span> @Override<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> public char charAt(final int index) {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> return messageText.charAt(index);<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> }<a name="line.303"></a> |
| <span class="sourceLineNo">304</span><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> @Override<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> public CharSequence subSequence(final int start, final int end) {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> return messageText.subSequence(start, end);<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> }<a name="line.308"></a> |
| <span class="sourceLineNo">309</span><a name="line.309"></a> |
| <span class="sourceLineNo">310</span> @Override<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> public Throwable getThrown() {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> // after deserialization, thrown is null but thrownProxy may be non-null<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> if (thrown == null) {<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> if (thrownProxy != null) {<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> thrown = thrownProxy.getThrowable();<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> }<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> return thrown;<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> }<a name="line.319"></a> |
| <span class="sourceLineNo">320</span><a name="line.320"></a> |
| <span class="sourceLineNo">321</span> @Override<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> public ThrowableProxy getThrownProxy() {<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> // lazily instantiate the (expensive) ThrowableProxy<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> if (thrownProxy == null) {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> if (thrown != null) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> thrownProxy = new ThrowableProxy(thrown);<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> }<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> }<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> return this.thrownProxy;<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> }<a name="line.330"></a> |
| <span class="sourceLineNo">331</span><a name="line.331"></a> |
| <span class="sourceLineNo">332</span> @SuppressWarnings("unchecked")<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> @Override<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> public ReadOnlyStringMap getContextData() {<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> return contextData;<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> }<a name="line.336"></a> |
| <span class="sourceLineNo">337</span><a name="line.337"></a> |
| <span class="sourceLineNo">338</span> void setContextData(final StringMap contextData) {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> this.contextData = contextData;<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> }<a name="line.340"></a> |
| <span class="sourceLineNo">341</span><a name="line.341"></a> |
| <span class="sourceLineNo">342</span> @SuppressWarnings("unchecked")<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> @Override<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> public Map<String, String> getContextMap() {<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> return contextData.toMap();<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> }<a name="line.346"></a> |
| <span class="sourceLineNo">347</span><a name="line.347"></a> |
| <span class="sourceLineNo">348</span> @Override<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> public ContextStack getContextStack() {<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> return contextStack;<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> }<a name="line.351"></a> |
| <span class="sourceLineNo">352</span><a name="line.352"></a> |
| <span class="sourceLineNo">353</span> @Override<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> public long getThreadId() {<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> return threadId;<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> }<a name="line.356"></a> |
| <span class="sourceLineNo">357</span><a name="line.357"></a> |
| <span class="sourceLineNo">358</span> @Override<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> public String getThreadName() {<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> return threadName;<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> }<a name="line.361"></a> |
| <span class="sourceLineNo">362</span><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> @Override<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> public int getThreadPriority() {<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> return threadPriority;<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> }<a name="line.366"></a> |
| <span class="sourceLineNo">367</span><a name="line.367"></a> |
| <span class="sourceLineNo">368</span> @Override<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> public StackTraceElement getSource() {<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> return location;<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> }<a name="line.371"></a> |
| <span class="sourceLineNo">372</span><a name="line.372"></a> |
| <span class="sourceLineNo">373</span> @Override<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> public long getTimeMillis() {<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> return message instanceof TimestampMessage ? ((TimestampMessage) message).getTimestamp() : instant.getEpochMillisecond();<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> }<a name="line.376"></a> |
| <span class="sourceLineNo">377</span><a name="line.377"></a> |
| <span class="sourceLineNo">378</span> @Override<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> public Instant getInstant() {<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> return instant;<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> }<a name="line.381"></a> |
| <span class="sourceLineNo">382</span><a name="line.382"></a> |
| <span class="sourceLineNo">383</span> @Override<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> public long getNanoTime() {<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> return nanoTime;<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> }<a name="line.386"></a> |
| <span class="sourceLineNo">387</span><a name="line.387"></a> |
| <span class="sourceLineNo">388</span> /**<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> * Release references held by ring buffer to allow objects to be garbage-collected.<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> */<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> public void clear() {<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> this.asyncLogger = null;<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> this.loggerName = null;<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> this.marker = null;<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> this.fqcn = null;<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> this.level = null;<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> this.message = null;<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> this.messageFormat = null;<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> this.thrown = null;<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> this.thrownProxy = null;<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> this.contextStack = null;<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> this.location = null;<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> if (contextData != null) {<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> if (contextData.isFrozen()) { // came from CopyOnWrite thread context<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> contextData = null;<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> } else {<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> contextData.clear();<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> }<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> }<a name="line.409"></a> |
| <span class="sourceLineNo">410</span><a name="line.410"></a> |
| <span class="sourceLineNo">411</span> // ensure that excessively long char[] arrays are not kept in memory forever<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> if (Constants.ENABLE_THREADLOCALS) {<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> StringBuilders.trimToMaxSize(messageText, Constants.MAX_REUSABLE_MESSAGE_SIZE);<a name="line.413"></a> |
| <span class="sourceLineNo">414</span><a name="line.414"></a> |
| <span class="sourceLineNo">415</span> if (parameters != null) {<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> Arrays.fill(parameters, null);<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> }<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> } else {<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> // A user may have manually logged a ReusableMessage implementation, when thread locals are<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> // disabled we remove the reference in order to avoid permanently holding references to these<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> // buffers.<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> messageText = null;<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> parameters = null;<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> }<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> }<a name="line.425"></a> |
| <span class="sourceLineNo">426</span><a name="line.426"></a> |
| <span class="sourceLineNo">427</span> private void writeObject(final java.io.ObjectOutputStream out) throws IOException {<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> getThrownProxy(); // initialize the ThrowableProxy before serializing<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> out.defaultWriteObject();<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> }<a name="line.430"></a> |
| <span class="sourceLineNo">431</span><a name="line.431"></a> |
| <span class="sourceLineNo">432</span> /**<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> * Creates and returns a new immutable copy of this {@code RingBufferLogEvent}.<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> *<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> * @return a new immutable copy of the data in this {@code RingBufferLogEvent}<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> */<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> public LogEvent createMemento() {<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> return new Log4jLogEvent.Builder(this).build();<a name="line.438"></a> |
| <span class="sourceLineNo">439</span><a name="line.439"></a> |
| <span class="sourceLineNo">440</span> }<a name="line.440"></a> |
| <span class="sourceLineNo">441</span><a name="line.441"></a> |
| <span class="sourceLineNo">442</span> /**<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> * Initializes the specified {@code Log4jLogEvent.Builder} from this {@code RingBufferLogEvent}.<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * @param builder the builder whose fields to populate<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> */<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> public void initializeBuilder(final Log4jLogEvent.Builder builder) {<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> builder.setContextData(contextData) //<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> .setContextStack(contextStack) //<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> .setEndOfBatch(endOfBatch) //<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> .setIncludeLocation(includeLocation) //<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> .setLevel(getLevel()) // ensure non-null<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> .setLoggerFqcn(fqcn) //<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> .setLoggerName(loggerName) //<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> .setMarker(marker) //<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> .setMessage(memento()) // ensure non-null & immutable<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> .setNanoTime(nanoTime) //<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> .setSource(location) //<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> .setThreadId(threadId) //<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> .setThreadName(threadName) //<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> .setThreadPriority(threadPriority) //<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> .setThrown(getThrown()) // may deserialize from thrownProxy<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> .setThrownProxy(thrownProxy) // avoid unnecessarily creating thrownProxy<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> .setInstant(instant) //<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> ;<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> }<a name="line.465"></a> |
| <span class="sourceLineNo">466</span><a name="line.466"></a> |
| <span class="sourceLineNo">467</span>}<a name="line.467"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
