Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / appender / AbstractOutputStreamAppender.html
blob: a3753d320fb97b69e2018f304032a8734dca1d84 [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.logging.log4j.core.appender;<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.concurrent.TimeUnit;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.Filter;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.Layout;<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.config.Property;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.util.Constants;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Appends log events as bytes to a byte output stream. The stream encoding is defined in the layout.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * @param &lt;M&gt; The kind of {@link OutputStreamManager} under management<a name="line.32"></a>
<span class="sourceLineNo">033</span> */<a name="line.33"></a>
<span class="sourceLineNo">034</span>public abstract class AbstractOutputStreamAppender&lt;M extends OutputStreamManager&gt; extends AbstractAppender {<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span> /**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Subclasses can extend this abstract Builder.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @param &lt;B&gt; The type to build.<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span> public abstract static class Builder&lt;B extends Builder&lt;B&gt;&gt; extends AbstractAppender.Builder&lt;B&gt; {<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> @PluginBuilderAttribute<a name="line.43"></a>
<span class="sourceLineNo">044</span> private boolean bufferedIo = true;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> @PluginBuilderAttribute<a name="line.46"></a>
<span class="sourceLineNo">047</span> private int bufferSize = Constants.ENCODER_BYTE_BUFFER_SIZE;<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 boolean immediateFlush = true;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> public int getBufferSize() {<a name="line.52"></a>
<span class="sourceLineNo">053</span> return bufferSize;<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> public boolean isBufferedIo() {<a name="line.56"></a>
<span class="sourceLineNo">057</span> return bufferedIo;<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 boolean isImmediateFlush() {<a name="line.60"></a>
<span class="sourceLineNo">061</span> return immediateFlush;<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 B withImmediateFlush(final boolean immediateFlush) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> this.immediateFlush = immediateFlush;<a name="line.65"></a>
<span class="sourceLineNo">066</span> return asBuilder();<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> public B withBufferedIo(final boolean bufferedIo) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> this.bufferedIo = bufferedIo;<a name="line.70"></a>
<span class="sourceLineNo">071</span> return asBuilder();<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> public B withBufferSize(final int bufferSize) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> this.bufferSize = bufferSize;<a name="line.75"></a>
<span class="sourceLineNo">076</span> return asBuilder();<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
<span class="sourceLineNo">082</span> * Immediate flush means that the underlying writer or output stream will be flushed at the end of each append<a name="line.82"></a>
<span class="sourceLineNo">083</span> * operation. Immediate flush is slower but ensures that each append request is actually written. If<a name="line.83"></a>
<span class="sourceLineNo">084</span> * &lt;code&gt;immediateFlush&lt;/code&gt; is set to {@code false}, then there is a good chance that the last few logs events<a name="line.84"></a>
<span class="sourceLineNo">085</span> * are not actually written to persistent media if and when the application crashes.<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> private final boolean immediateFlush;<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> private final M manager;<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
<span class="sourceLineNo">092</span> * Instantiates a WriterAppender and set the output destination to a new {@link java.io.OutputStreamWriter}<a name="line.92"></a>
<span class="sourceLineNo">093</span> * initialized with &lt;code&gt;os&lt;/code&gt; as its {@link java.io.OutputStream}.<a name="line.93"></a>
<span class="sourceLineNo">094</span> *<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @param name The name of the Appender.<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @param layout The layout to format the message.<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @param manager The OutputStreamManager.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @deprecated Use {@link #AbstractOutputStreamAppender(String, Layout, Filter, boolean, boolean, Property[], OutputStreamManager)}<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> @Deprecated<a name="line.100"></a>
<span class="sourceLineNo">101</span> protected AbstractOutputStreamAppender(final String name, final Layout&lt;? extends Serializable&gt; layout,<a name="line.101"></a>
<span class="sourceLineNo">102</span> final Filter filter, final boolean ignoreExceptions, final boolean immediateFlush, final M manager) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> super(name, filter, layout, ignoreExceptions, Property.EMPTY_ARRAY);<a name="line.103"></a>
<span class="sourceLineNo">104</span> this.manager = manager;<a name="line.104"></a>
<span class="sourceLineNo">105</span> this.immediateFlush = immediateFlush;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
<span class="sourceLineNo">109</span> * Instantiates a WriterAppender and set the output destination to a new {@link java.io.OutputStreamWriter}<a name="line.109"></a>
<span class="sourceLineNo">110</span> * initialized with &lt;code&gt;os&lt;/code&gt; as its {@link java.io.OutputStream}.<a name="line.110"></a>
<span class="sourceLineNo">111</span> *<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @param name The name of the Appender.<a name="line.112"></a>
<span class="sourceLineNo">113</span> * @param layout The layout to format the message.<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @param properties optional properties<a name="line.114"></a>
<span class="sourceLineNo">115</span> * @param manager The OutputStreamManager.<a name="line.115"></a>
<span class="sourceLineNo">116</span> */<a name="line.116"></a>
<span class="sourceLineNo">117</span> protected AbstractOutputStreamAppender(final String name, final Layout&lt;? extends Serializable&gt; layout,<a name="line.117"></a>
<span class="sourceLineNo">118</span> final Filter filter, final boolean ignoreExceptions, final boolean immediateFlush,<a name="line.118"></a>
<span class="sourceLineNo">119</span> final Property[] properties, final M manager) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> super(name, filter, layout, ignoreExceptions, properties);<a name="line.120"></a>
<span class="sourceLineNo">121</span> this.manager = manager;<a name="line.121"></a>
<span class="sourceLineNo">122</span> this.immediateFlush = immediateFlush;<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> /**<a name="line.125"></a>
<span class="sourceLineNo">126</span> * Gets the immediate flush setting.<a name="line.126"></a>
<span class="sourceLineNo">127</span> *<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @return immediate flush.<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> public boolean getImmediateFlush() {<a name="line.130"></a>
<span class="sourceLineNo">131</span> return immediateFlush;<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> /**<a name="line.134"></a>
<span class="sourceLineNo">135</span> * Gets the manager.<a name="line.135"></a>
<span class="sourceLineNo">136</span> *<a name="line.136"></a>
<span class="sourceLineNo">137</span> * @return the manager.<a name="line.137"></a>
<span class="sourceLineNo">138</span> */<a name="line.138"></a>
<span class="sourceLineNo">139</span> public M getManager() {<a name="line.139"></a>
<span class="sourceLineNo">140</span> return manager;<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> @Override<a name="line.143"></a>
<span class="sourceLineNo">144</span> public void start() {<a name="line.144"></a>
<span class="sourceLineNo">145</span> if (getLayout() == null) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> LOGGER.error("No layout set for the appender named [" + getName() + "].");<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span> if (manager == null) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> LOGGER.error("No OutputStreamManager set for the appender named [" + getName() + "].");<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> super.start();<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> @Override<a name="line.154"></a>
<span class="sourceLineNo">155</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> return stop(timeout, timeUnit, true);<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<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> protected boolean stop(final long timeout, final TimeUnit timeUnit, final boolean changeLifeCycleState) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> boolean stopped = super.stop(timeout, timeUnit, changeLifeCycleState);<a name="line.161"></a>
<span class="sourceLineNo">162</span> stopped &amp;= manager.stop(timeout, timeUnit);<a name="line.162"></a>
<span class="sourceLineNo">163</span> if (changeLifeCycleState) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> setStopped();<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span> LOGGER.debug("Appender {} stopped with status {}", getName(), stopped);<a name="line.166"></a>
<span class="sourceLineNo">167</span> return stopped;<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> /**<a name="line.170"></a>
<span class="sourceLineNo">171</span> * Actual writing occurs here.<a name="line.171"></a>
<span class="sourceLineNo">172</span> * &lt;p&gt;<a name="line.172"></a>
<span class="sourceLineNo">173</span> * Most subclasses of &lt;code&gt;AbstractOutputStreamAppender&lt;/code&gt; will need to override this method.<a name="line.173"></a>
<span class="sourceLineNo">174</span> * &lt;/p&gt;<a name="line.174"></a>
<span class="sourceLineNo">175</span> *<a name="line.175"></a>
<span class="sourceLineNo">176</span> * @param event The LogEvent.<a name="line.176"></a>
<span class="sourceLineNo">177</span> */<a name="line.177"></a>
<span class="sourceLineNo">178</span> @Override<a name="line.178"></a>
<span class="sourceLineNo">179</span> public void append(final LogEvent event) {<a name="line.179"></a>
<span class="sourceLineNo">180</span> try {<a name="line.180"></a>
<span class="sourceLineNo">181</span> tryAppend(event);<a name="line.181"></a>
<span class="sourceLineNo">182</span> } catch (final AppenderLoggingException ex) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> error("Unable to write to stream " + manager.getName() + " for appender " + getName(), event, ex);<a name="line.183"></a>
<span class="sourceLineNo">184</span> throw ex;<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><a name="line.187"></a>
<span class="sourceLineNo">188</span> private void tryAppend(final LogEvent event) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> if (Constants.ENABLE_DIRECT_ENCODERS) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> directEncodeEvent(event);<a name="line.190"></a>
<span class="sourceLineNo">191</span> } else {<a name="line.191"></a>
<span class="sourceLineNo">192</span> writeByteArrayToManager(event);<a name="line.192"></a>
<span class="sourceLineNo">193</span> }<a name="line.193"></a>
<span class="sourceLineNo">194</span> }<a name="line.194"></a>
<span class="sourceLineNo">195</span><a name="line.195"></a>
<span class="sourceLineNo">196</span> protected void directEncodeEvent(final LogEvent event) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> getLayout().encode(event, manager);<a name="line.197"></a>
<span class="sourceLineNo">198</span> if (this.immediateFlush || event.isEndOfBatch()) {<a name="line.198"></a>
<span class="sourceLineNo">199</span> manager.flush();<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> protected void writeByteArrayToManager(final LogEvent event) {<a name="line.203"></a>
<span class="sourceLineNo">204</span> final byte[] bytes = getLayout().toByteArray(event);<a name="line.204"></a>
<span class="sourceLineNo">205</span> if (bytes != null &amp;&amp; bytes.length &gt; 0) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> manager.write(bytes, this.immediateFlush || event.isEndOfBatch());<a name="line.206"></a>
<span class="sourceLineNo">207</span> }<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span>}<a name="line.209"></a>
</pre>
</div>
</body>
</html>