| <!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><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.logging.log4j.core.appender.db;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.Flushable;<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.util.ArrayList;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.concurrent.TimeUnit;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.Layout;<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.appender.AbstractManager;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.appender.ManagerFactory;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Manager that allows database appenders to have their configuration reloaded without losing events.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> */<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>public abstract class AbstractDatabaseManager extends AbstractManager implements Flushable {<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> <a name="line.34"></a> |
| <span class="sourceLineNo">035</span> /**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Implementations should extend this class for passing data between the getManager method and the manager factory<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * class.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> protected abstract static class AbstractFactoryData {<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> private final int bufferSize;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> private final Layout<? extends Serializable> layout;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> /**<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * Constructs the base factory data.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> *<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @param bufferSize The size of the buffer.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @param bufferSize The appender-level layout<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> protected AbstractFactoryData(final int bufferSize, final Layout<? extends Serializable> layout) {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> this.bufferSize = bufferSize;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> this.layout = layout;<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> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Gets the buffer size.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> *<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @return the buffer size.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> public int getBufferSize() {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> return bufferSize;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<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> * Gets the layout.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> *<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @return the layout.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> public Layout<? extends Serializable> getLayout() {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> return layout;<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> /**<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * Implementations should define their own getManager method and call this method from that to create or get<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * existing managers.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> *<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param name The manager name, which should include any configuration details that one might want to be able to<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * reconfigure at runtime, such as database name, username, (hashed) password, etc.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param data The concrete instance of {@link AbstractFactoryData} appropriate for the given manager.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param factory A factory instance for creating the appropriate manager.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @param <M> The concrete manager type.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @param <T> The concrete {@link AbstractFactoryData} type.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @return a new or existing manager of the specified type and name.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> protected static <M extends AbstractDatabaseManager, T extends AbstractFactoryData> M getManager(<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> final String name, final T data, final ManagerFactory<M, T> factory<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> ) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> return AbstractManager.getManager(name, factory, data);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> }<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> private final ArrayList<LogEvent> buffer;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> private final int bufferSize;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> private final Layout<? extends Serializable> layout;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> private boolean running;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Instantiates the base manager.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> *<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @param name The manager name, which should include any configuration details that one might want to be able to<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * reconfigure at runtime, such as database name, username, (hashed) password, etc.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param bufferSize The size of the log event buffer.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> */<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> protected AbstractDatabaseManager(final String name, final int bufferSize) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> this(name, bufferSize, null);<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> }<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> * Instantiates the base manager.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param name The manager name, which should include any configuration details that one might want to be able to<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * reconfigure at runtime, such as database name, username, (hashed) password, etc.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @param layout the Appender-level layout.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param bufferSize The size of the log event buffer.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> */<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> protected AbstractDatabaseManager(final String name, final int bufferSize, final Layout<? extends Serializable> layout) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> super(null, name);<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> this.bufferSize = bufferSize;<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> this.buffer = new ArrayList<>(bufferSize + 1);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> this.layout = layout;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> protected void buffer(final LogEvent event) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> this.buffer.add(event.toImmutable());<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> if (this.buffer.size() >= this.bufferSize || event.isEndOfBatch()) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> this.flush();<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> /**<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * Commits any active transaction (if applicable) and disconnects from the database (returns the connection to the<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * connection pool). With buffering enabled, this is called when flushing the buffer completes, after the last call<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * to {@link #writeInternal}. With buffering disabled, this is called immediately after every invocation of<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * {@link #writeInternal}.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @return true if all resources were closed normally, false otherwise.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> */<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> protected abstract boolean commitAndClose();<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> * Connects to the database and starts a transaction (if applicable). With buffering enabled, this is called when<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * flushing the buffer begins, before the first call to {@link #writeInternal}. With buffering disabled, this is<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * called immediately before every invocation of {@link #writeInternal}.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> protected abstract void connectAndStart();<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> /**<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * This method is called automatically when the buffer size reaches its maximum or at the beginning of a call to<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * {@link #shutdown()}. It can also be called manually to flush events to the database.<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 final synchronized void flush() {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> if (this.isRunning() && isBuffered()) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> this.connectAndStart();<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> try {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> for (final LogEvent event : this.buffer) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> this.writeInternal(event, layout != null ? layout.toSerializable(event) : null);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> } finally {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> this.commitAndClose();<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> // not sure if this should be done when writing the events failed<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> this.buffer.clear();<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> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> protected boolean isBuffered() {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> return this.bufferSize > 0;<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<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> * Indicates whether the manager is currently connected {@link #startup()} has been called and {@link #shutdown()}<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * has not been called).<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> *<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @return {@code true} if the manager is connected.<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> */<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> public final boolean isRunning() {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> return this.running;<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> @Override<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> public final boolean releaseSub(final long timeout, final TimeUnit timeUnit) {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> return this.shutdown();<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> /**<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * This method is called from the {@link #close()} method when the appender is stopped or the appender's manager<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * is replaced. If it has not already been called, it calls {@link #shutdownInternal()} and catches any exceptions<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * it might throw.<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @return true if all resources were closed normally, false otherwise.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> */<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> public final synchronized boolean shutdown() {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> boolean closed = true;<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> this.flush();<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> if (this.isRunning()) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> try {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> closed &= this.shutdownInternal();<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> } catch (final Exception e) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> logWarn("Caught exception while performing database shutdown operations", e);<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> closed = false;<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> } finally {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> this.running = false;<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> }<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> }<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> return closed;<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> /**<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * Implementations should implement this method to perform any proprietary disconnection / shutdown operations. This<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * method will never be called twice on the same instance, and it will only be called <em>after</em><a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * {@link #startupInternal()}. It is safe to throw any exceptions from this method. This method does not<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * necessarily disconnect from the database for the same reasons outlined in {@link #startupInternal()}.<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @return true if all resources were closed normally, false otherwise.<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> */<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> protected abstract boolean shutdownInternal() throws Exception;<a name="line.213"></a> |
| <span class="sourceLineNo">214</span><a name="line.214"></a> |
| <span class="sourceLineNo">215</span> /**<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * This method is called within the appender when the appender is started. If it has not already been called, it<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * calls {@link #startupInternal()} and catches any exceptions it might throw.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> */<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> public final synchronized void startup() {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> if (!this.isRunning()) {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> try {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> this.startupInternal();<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> this.running = true;<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> } catch (final Exception e) {<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> logError("Could not perform database startup operations", e);<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> }<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> }<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> * Implementations should implement this method to perform any proprietary startup operations. This method will<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * never be called twice on the same instance. It is safe to throw any exceptions from this method. This method<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * does not necessarily connect to the database, as it is generally unreliable to connect once and use the same<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * connection for hours.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> */<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> protected abstract void startupInternal() throws Exception;<a name="line.236"></a> |
| <span class="sourceLineNo">237</span><a name="line.237"></a> |
| <span class="sourceLineNo">238</span> @Override<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> public final String toString() {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> return this.getName();<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> }<a name="line.241"></a> |
| <span class="sourceLineNo">242</span><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> /**<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * This method manages buffering and writing of events.<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> *<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * @param event The event to write to the database.<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @deprecated since 2.11.0 Use {@link #write(LogEvent, Serializable)}.<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> */<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> @Deprecated<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> public final synchronized void write(final LogEvent event) {<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> write(event, null);<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> }<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> * This method manages buffering and writing of events.<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> *<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * @param event The event to write to the database.<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * @param serializable Serializable event<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> */<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> public final synchronized void write(final LogEvent event, final Serializable serializable) {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> if (isBuffered()) {<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> buffer(event);<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> } else {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> writeThrough(event, serializable);<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> }<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> * Performs the actual writing of the event in an implementation-specific way. This method is called immediately<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * from {@link #write(LogEvent, Serializable)} if buffering is off, or from {@link #flush()} if the buffer has reached its limit.<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> *<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * @param event The event to write to the database.<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * @deprecated Use {@link #writeInternal(LogEvent, Serializable)}.<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> */<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> @Deprecated<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> protected void writeInternal(final LogEvent event) {<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> writeInternal(event, null);<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> }<a name="line.278"></a> |
| <span class="sourceLineNo">279</span><a name="line.279"></a> |
| <span class="sourceLineNo">280</span> /**<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * Performs the actual writing of the event in an implementation-specific way. This method is called immediately<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * from {@link #write(LogEvent, Serializable)} if buffering is off, or from {@link #flush()} if the buffer has reached its limit.<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> *<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * @param event The event to write to the database.<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> */<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> protected abstract void writeInternal(LogEvent event, Serializable serializable);<a name="line.286"></a> |
| <span class="sourceLineNo">287</span><a name="line.287"></a> |
| <span class="sourceLineNo">288</span> protected void writeThrough(final LogEvent event, final Serializable serializable) {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> this.connectAndStart();<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> try {<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> this.writeInternal(event, serializable);<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> } finally {<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> this.commitAndClose();<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> }<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> }<a name="line.295"></a> |
| <span class="sourceLineNo">296</span>}<a name="line.296"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |