| <!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.layout;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.Serializable;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.HashMap;<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.Logger;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.Layout;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.LogEvent;<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.plugins.PluginBuilderAttribute;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>/**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * Abstract base class for Layouts.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> *<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * @param <T><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * The Class that the Layout will format the LogEvent into.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>public abstract class AbstractLayout<T extends Serializable> implements Layout<T> {<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Subclasses can extend this abstract Builder.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @param <B> The type to build.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> public abstract static class Builder<B extends Builder<B>> {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> @PluginConfiguration<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private Configuration configuration;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> @PluginBuilderAttribute<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private byte[] footer;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> @PluginBuilderAttribute<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private byte[] header;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> @SuppressWarnings("unchecked")<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public B asBuilder() {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> return (B) this;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> }<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> public Configuration getConfiguration() {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> return configuration;<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> public byte[] getFooter() {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> return footer;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> }<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> public byte[] getHeader() {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> return header;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> }<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public B setConfiguration(final Configuration configuration) {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> this.configuration = configuration;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> return asBuilder();<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> public B setFooter(final byte[] footer) {<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> this.footer = footer;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> return asBuilder();<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> public B setHeader(final byte[] header) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> this.header = header;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> return asBuilder();<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><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> /**<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * Allow subclasses access to the status logger without creating another instance.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> protected static final Logger LOGGER = StatusLogger.getLogger();<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> |
| <span class="sourceLineNo">095</span> * The current Configuration.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> protected final Configuration configuration;<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> * The number of events successfully processed by this layout.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> */<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> protected long eventCount;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> /**<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * The footer to add when the stream is closed. May be null.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> */<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> protected final byte[] footer;<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> * The header to include when the stream is opened. May be null.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> protected final byte[] header;<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> /**<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * Constructs a layout with an optional header and footer.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> *<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param header<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * The header to include when the stream is opened. May be null.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param footer<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * The footer to add when the stream is closed. May be null.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @deprecated Use {@link #AbstractLayout(Configuration, byte[], byte[])}<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> @Deprecated<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> public AbstractLayout(final byte[] header, final byte[] footer) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> this(null, header, footer);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> /**<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * Constructs a layout with an optional header and footer.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> *<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @param configuration<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * The configuration<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @param header<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * The header to include when the stream is opened. May be null.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * @param footer<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * The footer to add when the stream is closed. May be null.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> */<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> public AbstractLayout(final Configuration configuration, final byte[] header, final byte[] footer) {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> super();<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> this.configuration = configuration;<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> this.header = header;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> this.footer = footer;<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> public Configuration getConfiguration() {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> return configuration;<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> @Override<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> public Map<String, String> getContentFormat() {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> return new HashMap<>();<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<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> * Returns the footer, if one is available.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> *<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @return A byte array containing the footer.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> */<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> @Override<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> public byte[] getFooter() {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> return footer;<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> /**<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * Returns the header, if one is available.<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> *<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @return A byte array containing the header.<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> */<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> @Override<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> public byte[] getHeader() {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> return header;<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> protected void markEvent() {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> eventCount++;<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> /**<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * Encodes the specified source LogEvent to some binary representation and writes the result to the specified<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * destination.<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * <p><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * The default implementation of this method delegates to the {@link #toByteArray(LogEvent)} method which allocates<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * temporary objects.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * </p><p><a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * Subclasses can override this method to provide a garbage-free implementation. For text-based layouts,<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * {@code AbstractStringLayout} provides various convenience methods to help with this:<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * </p><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * <pre>@Plugin(name = "MyLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * public final class MyLayout extends AbstractStringLayout {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * @Override<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * public void encode(LogEvent event, ByteBufferDestination destination) {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * StringBuilder text = getStringBuilder();<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * convertLogEventToText(event, text);<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * getStringBuilderEncoder().encode(text, destination);<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> * private void convertLogEventToText(LogEvent event, StringBuilder destination) {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * ... // append a text representation of the log event to the StringBuilder<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * }<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * </pre><a name="line.201"></a> |
| <span class="sourceLineNo">202</span> *<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * @param event the LogEvent to encode.<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * @param destination holds the ByteBuffer to write into.<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * @see AbstractStringLayout#getStringBuilder()<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * @see AbstractStringLayout#getStringBuilderEncoder()<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> */<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> @Override<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> public void encode(final LogEvent event, final ByteBufferDestination destination) {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> final byte[] data = toByteArray(event);<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> destination.writeBytes(data, 0, data.length);<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |