| <!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.IOException;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.OutputStream;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.Serializable;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.nio.Buffer;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.nio.ByteBuffer;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Objects;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.concurrent.TimeUnit;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.Layout;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.LoggerContext;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.layout.ByteBufferDestination;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.layout.ByteBufferDestinationHelper;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.util.Constants;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span>/**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * Manages an OutputStream so that it can be shared by multiple Appenders and will<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * allow appenders to reconfigure without requiring a new stream.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>public class OutputStreamManager extends AbstractManager implements ByteBufferDestination {<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> protected final Layout<?> layout;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> protected ByteBuffer byteBuffer;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> private volatile OutputStream outputStream;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> private boolean skipFooter;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> protected OutputStreamManager(final OutputStream os, final String streamName, final Layout<?> layout,<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> final boolean writeHeader) {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> this(os, streamName, layout, writeHeader, Constants.ENCODER_BYTE_BUFFER_SIZE);<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> protected OutputStreamManager(final OutputStream os, final String streamName, final Layout<?> layout,<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> final boolean writeHeader, final int bufferSize) {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> this(os, streamName, layout, writeHeader, ByteBuffer.wrap(new byte[bufferSize]));<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> }<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @since 2.6<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @deprecated<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> @Deprecated<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> protected OutputStreamManager(final OutputStream os, final String streamName, final Layout<?> layout,<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> final boolean writeHeader, final ByteBuffer byteBuffer) {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> super(null, streamName);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> this.outputStream = os;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> this.layout = layout;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> if (writeHeader) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> writeHeader(os);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> this.byteBuffer = Objects.requireNonNull(byteBuffer, "byteBuffer");<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> /**<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @since 2.7<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> protected OutputStreamManager(final LoggerContext loggerContext, final OutputStream os, final String streamName,<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> final boolean createOnDemand, final Layout<? extends Serializable> layout, final boolean writeHeader,<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> final ByteBuffer byteBuffer) {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> super(loggerContext, streamName);<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> if (createOnDemand && os != null) {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> LOGGER.error(<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> "Invalid OutputStreamManager configuration for '{}': You cannot both set the OutputStream and request on-demand.",<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> streamName);<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> this.layout = layout;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> this.byteBuffer = Objects.requireNonNull(byteBuffer, "byteBuffer");<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> this.outputStream = os;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> if (writeHeader) {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> writeHeader(os);<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> * Creates a Manager.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> *<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param name The name of the stream to manage.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param data The data to pass to the Manager.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param factory The factory to use to create the Manager.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @param <T> The type of the OutputStreamManager.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @return An OutputStreamManager.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> */<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> public static <T> OutputStreamManager getManager(final String name, final T data,<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> final ManagerFactory<? extends OutputStreamManager, T> factory) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> return AbstractManager.getManager(name, factory, data);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> @SuppressWarnings("unused")<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> protected OutputStream createOutputStream() throws IOException {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> throw new IllegalStateException(getClass().getCanonicalName() + " must implement createOutputStream()");<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> * Indicate whether the footer should be skipped or not.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param skipFooter true if the footer should be skipped.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> public void skipFooter(final boolean skipFooter) {<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> this.skipFooter = skipFooter;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> /**<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * Default hook to write footer during close.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> */<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> @Override<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> public boolean releaseSub(final long timeout, final TimeUnit timeUnit) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> writeFooter();<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> return closeOutputStream();<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> protected void writeHeader(OutputStream os) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> if (layout != null && os != null) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> final byte[] header = layout.getHeader();<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> if (header != null) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> try {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> os.write(header, 0, header.length);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> } catch (final IOException e) {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> logError("Unable to write header", e);<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> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> }<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> * Writes the footer.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> protected void writeFooter() {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> if (layout == null || skipFooter) {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> return;<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> }<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> final byte[] footer = layout.getFooter();<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> if (footer != null) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> write(footer);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> /**<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * Returns the status of the stream.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * @return true if the stream is open, false if it is not.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> */<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> public boolean isOpen() {<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> return getCount() > 0;<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> public boolean hasOutputStream() {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> return outputStream != null;<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> protected OutputStream getOutputStream() throws IOException {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> if (outputStream == null) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> outputStream = createOutputStream();<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> return outputStream;<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> protected void setOutputStream(final OutputStream os) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> this.outputStream = os;<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> /**<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * Some output streams synchronize writes while others do not.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @param bytes The serialized Log event.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @throws AppenderLoggingException if an error occurs.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> */<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> protected void write(final byte[] bytes) {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> write(bytes, 0, bytes.length, false);<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> }<a name="line.181"></a> |
| <span class="sourceLineNo">182</span><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> /**<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * Some output streams synchronize writes while others do not.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * @param bytes The serialized Log event.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * @param immediateFlush If true, flushes after writing.<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * @throws AppenderLoggingException if an error occurs.<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> */<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> protected void write(final byte[] bytes, final boolean immediateFlush) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> write(bytes, 0, bytes.length, immediateFlush);<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> }<a name="line.191"></a> |
| <span class="sourceLineNo">192</span><a name="line.192"></a> |
| <span class="sourceLineNo">193</span> @Override<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> public void writeBytes(final byte[] data, final int offset, final int length) {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> write(data, offset, length, false);<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span><a name="line.197"></a> |
| <span class="sourceLineNo">198</span> /**<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * Some output streams synchronize writes while others do not. Synchronizing here insures that<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * log events won't be intertwined.<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * @param bytes The serialized Log event.<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * @param offset The offset into the byte array.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * @param length The number of bytes to write.<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * @throws AppenderLoggingException if an error occurs.<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> */<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> protected void write(final byte[] bytes, final int offset, final int length) {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> writeBytes(bytes, offset, length);<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> |
| <span class="sourceLineNo">210</span> /**<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * Some output streams synchronize writes while others do not. Synchronizing here insures that<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * log events won't be intertwined.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * @param bytes The serialized Log event.<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * @param offset The offset into the byte array.<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * @param length The number of bytes to write.<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * @param immediateFlush flushes immediately after writing.<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * @throws AppenderLoggingException if an error occurs.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> */<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> protected synchronized void write(final byte[] bytes, final int offset, final int length, final boolean immediateFlush) {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> if (immediateFlush && byteBuffer.position() == 0) {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> writeToDestination(bytes, offset, length);<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> flushDestination();<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> return;<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> if (length >= byteBuffer.capacity()) {<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> // if request length exceeds buffer capacity, flush the buffer and write the data directly<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> flush();<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> writeToDestination(bytes, offset, length);<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> } else {<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> if (length > byteBuffer.remaining()) {<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> flush();<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> }<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> byteBuffer.put(bytes, offset, length);<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> }<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> if (immediateFlush) {<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> flush();<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> /**<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * Writes the specified section of the specified byte array to the stream.<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> *<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * @param bytes the array containing data<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * @param offset from where to write<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @param length how many bytes to write<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * @since 2.6<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> */<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> protected synchronized void writeToDestination(final byte[] bytes, final int offset, final int length) {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> try {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> getOutputStream().write(bytes, offset, length);<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> } catch (final IOException ex) {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> throw new AppenderLoggingException("Error writing to stream " + getName(), ex);<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> /**<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * Calls {@code flush()} on the underlying output stream.<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * @since 2.6<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> */<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> protected synchronized void flushDestination() {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> final OutputStream stream = outputStream; // access volatile field only once per method<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> if (stream != null) {<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> try {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> stream.flush();<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> } catch (final IOException ex) {<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> throw new AppenderLoggingException("Error flushing stream " + getName(), ex);<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> }<a name="line.269"></a> |
| <span class="sourceLineNo">270</span><a name="line.270"></a> |
| <span class="sourceLineNo">271</span> /**<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * Drains the ByteBufferDestination's buffer into the destination. By default this calls<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * {@link OutputStreamManager#write(byte[], int, int, boolean)} with the buffer contents.<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * The underlying stream is not {@linkplain OutputStream#flush() flushed}.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> *<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * @see #flushDestination()<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * @since 2.6<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> */<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> protected synchronized void flushBuffer(final ByteBuffer buf) {<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> ((Buffer) buf).flip();<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> if (buf.remaining() > 0) {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> writeToDestination(buf.array(), buf.arrayOffset() + buf.position(), buf.remaining());<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> }<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> buf.clear();<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> }<a name="line.285"></a> |
| <span class="sourceLineNo">286</span><a name="line.286"></a> |
| <span class="sourceLineNo">287</span> /**<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * Flushes any buffers.<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> */<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> public synchronized void flush() {<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> flushBuffer(byteBuffer);<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> flushDestination();<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> }<a name="line.293"></a> |
| <span class="sourceLineNo">294</span><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> protected synchronized boolean closeOutputStream() {<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> flush();<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> final OutputStream stream = outputStream; // access volatile field only once per method<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> if (stream == null || stream == System.out || stream == System.err) {<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> return true;<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> }<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> try {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> stream.close();<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> LOGGER.debug("OutputStream closed");<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> } catch (final IOException ex) {<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> logError("Unable to close stream", ex);<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> return false;<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> }<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> return true;<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> /**<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * Returns this {@code ByteBufferDestination}'s buffer.<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * @return the buffer<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * @since 2.6<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> */<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> @Override<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> public ByteBuffer getByteBuffer() {<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> return byteBuffer;<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> /**<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * Drains the ByteBufferDestination's buffer into the destination. By default this calls<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * {@link #flushBuffer(ByteBuffer)} with the specified buffer. Subclasses may override.<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * <p><a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * Do not call this method lightly! For some subclasses this is a very expensive operation. For example,<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * {@link MemoryMappedFileManager} will assume this method was called because the end of the mapped region<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * was reached during a text encoding operation and will {@linkplain MemoryMappedFileManager#remap() remap} its<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * buffer.<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * </p><p><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * To just flush the buffered contents to the underlying stream, call<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * {@link #flushBuffer(ByteBuffer)} directly instead.<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * </p><a name="line.332"></a> |
| <span class="sourceLineNo">333</span> *<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * @param buf the buffer whose contents to write the the destination<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * @return the specified buffer<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * @since 2.6<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> */<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> @Override<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> public ByteBuffer drain(final ByteBuffer buf) {<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> flushBuffer(buf);<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> return buf;<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> @Override<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> public void writeBytes(final ByteBuffer data) {<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> if (data.remaining() == 0) {<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> return;<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> synchronized (this) {<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> ByteBufferDestinationHelper.writeToUnsynchronized(data, this);<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>}<a name="line.353"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
