Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / appender / db / AbstractDatabaseAppender.html
blob: fe8a8b2f32d34b3d7d258375a79902ca475dbc91 [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.db;<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>import java.util.concurrent.locks.Lock;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.locks.ReadWriteLock;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.locks.ReentrantReadWriteLock;<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.LoggingException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Filter;<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.LogEvent;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.appender.AbstractAppender;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.appender.AppenderLoggingException;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.Property;<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> * An abstract Appender for writing events to a database of some type, be it relational or NoSQL. All database appenders<a name="line.34"></a>
<span class="sourceLineNo">035</span> * should inherit from this base appender. Three implementations are currently provided:<a name="line.35"></a>
<span class="sourceLineNo">036</span> * {@link org.apache.logging.log4j.core.appender.db.jdbc JDBC}, {@link org.apache.logging.log4j.core.appender.db.jpa<a name="line.36"></a>
<span class="sourceLineNo">037</span> * JPA}, and {@link org.apache.logging.log4j.core.appender.nosql NoSQL}.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @param &lt;T&gt; Specifies which type of {@link AbstractDatabaseManager} this Appender requires.<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>public abstract class AbstractDatabaseAppender&lt;T extends AbstractDatabaseManager&gt; extends AbstractAppender {<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> public static class Builder&lt;B extends Builder&lt;B&gt;&gt; extends AbstractAppender.Builder&lt;B&gt; {<a name="line.43"></a>
<span class="sourceLineNo">044</span> // empty for now.<a name="line.44"></a>
<span class="sourceLineNo">045</span> }<a name="line.45"></a>
<span class="sourceLineNo">046</span> <a name="line.46"></a>
<span class="sourceLineNo">047</span> public static final int DEFAULT_RECONNECT_INTERVAL_MILLIS = 5000;<a name="line.47"></a>
<span class="sourceLineNo">048</span> <a name="line.48"></a>
<span class="sourceLineNo">049</span> private final ReadWriteLock lock = new ReentrantReadWriteLock();<a name="line.49"></a>
<span class="sourceLineNo">050</span> private final Lock readLock = lock.readLock();<a name="line.50"></a>
<span class="sourceLineNo">051</span> private final Lock writeLock = lock.writeLock();<a name="line.51"></a>
<span class="sourceLineNo">052</span> private T manager;<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> * Instantiates the base appender.<a name="line.55"></a>
<span class="sourceLineNo">056</span> *<a name="line.56"></a>
<span class="sourceLineNo">057</span> * @param name The appender name.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * @param filter The filter, if any, to use.<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @param ignoreExceptions If {@code true} exceptions encountered when appending events are logged; otherwise<a name="line.59"></a>
<span class="sourceLineNo">060</span> * they are propagated to the caller.<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param manager The matching {@link AbstractDatabaseManager} implementation.<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @deprecated Use {@link #AbstractDatabaseAppender(String, Filter, Layout, boolean, Property[], AbstractDatabaseManager)}.<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> @Deprecated<a name="line.64"></a>
<span class="sourceLineNo">065</span> protected AbstractDatabaseAppender(final String name, final Filter filter, final boolean ignoreExceptions,<a name="line.65"></a>
<span class="sourceLineNo">066</span> final T manager) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> super(name, filter, null, ignoreExceptions, Property.EMPTY_ARRAY);<a name="line.67"></a>
<span class="sourceLineNo">068</span> this.manager = manager;<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<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> * Instantiates the base appender.<a name="line.72"></a>
<span class="sourceLineNo">073</span> *<a name="line.73"></a>
<span class="sourceLineNo">074</span> * @param name The appender name.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @param filter The filter, if any, to use.<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @param layout The layout to use to format the event.<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @param ignoreExceptions If {@code true} exceptions encountered when appending events are logged; otherwise<a name="line.77"></a>
<span class="sourceLineNo">078</span> * they are propagated to the caller.<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param manager The matching {@link AbstractDatabaseManager} implementation.<a name="line.79"></a>
<span class="sourceLineNo">080</span> */<a name="line.80"></a>
<span class="sourceLineNo">081</span> protected AbstractDatabaseAppender(final String name, final Filter filter,<a name="line.81"></a>
<span class="sourceLineNo">082</span> final Layout&lt;? extends Serializable&gt; layout, final boolean ignoreExceptions,<a name="line.82"></a>
<span class="sourceLineNo">083</span> final Property[] properties, final T manager) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> super(name, filter, layout, ignoreExceptions, properties);<a name="line.84"></a>
<span class="sourceLineNo">085</span> this.manager = manager;<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> * Instantiates the base appender.<a name="line.89"></a>
<span class="sourceLineNo">090</span> *<a name="line.90"></a>
<span class="sourceLineNo">091</span> * @param name The appender name.<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @param filter The filter, if any, to use.<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @param layout The layout to use to format the event.<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param ignoreExceptions If {@code true} exceptions encountered when appending events are logged; otherwise<a name="line.94"></a>
<span class="sourceLineNo">095</span> * they are propagated to the caller.<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @param manager The matching {@link AbstractDatabaseManager} implementation.<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @deprecated Use {@link #AbstractDatabaseAppender(String, Filter, Layout, boolean, Property[], AbstractDatabaseManager)}<a name="line.97"></a>
<span class="sourceLineNo">098</span> */<a name="line.98"></a>
<span class="sourceLineNo">099</span> @Deprecated<a name="line.99"></a>
<span class="sourceLineNo">100</span> protected AbstractDatabaseAppender(final String name, final Filter filter,<a name="line.100"></a>
<span class="sourceLineNo">101</span> final Layout&lt;? extends Serializable&gt; layout, final boolean ignoreExceptions, final T manager) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> super(name, filter, layout, ignoreExceptions, Property.EMPTY_ARRAY);<a name="line.102"></a>
<span class="sourceLineNo">103</span> this.manager = manager;<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> @Override<a name="line.106"></a>
<span class="sourceLineNo">107</span> public final void append(final LogEvent event) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> this.readLock.lock();<a name="line.108"></a>
<span class="sourceLineNo">109</span> try {<a name="line.109"></a>
<span class="sourceLineNo">110</span> this.getManager().write(event, toSerializable(event));<a name="line.110"></a>
<span class="sourceLineNo">111</span> } catch (final LoggingException e) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> LOGGER.error("Unable to write to database [{}] for appender [{}].", this.getManager().getName(),<a name="line.112"></a>
<span class="sourceLineNo">113</span> this.getName(), e);<a name="line.113"></a>
<span class="sourceLineNo">114</span> throw e;<a name="line.114"></a>
<span class="sourceLineNo">115</span> } catch (final Exception e) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> LOGGER.error("Unable to write to database [{}] for appender [{}].", this.getManager().getName(),<a name="line.116"></a>
<span class="sourceLineNo">117</span> this.getName(), e);<a name="line.117"></a>
<span class="sourceLineNo">118</span> throw new AppenderLoggingException("Unable to write to database in appender: " + e.getMessage(), e);<a name="line.118"></a>
<span class="sourceLineNo">119</span> } finally {<a name="line.119"></a>
<span class="sourceLineNo">120</span> this.readLock.unlock();<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<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> * This always returns {@code null}, as database appenders do not use a single layout. The JPA and NoSQL appenders<a name="line.125"></a>
<span class="sourceLineNo">126</span> * do not use a layout at all. The JDBC appender has a layout-per-column pattern.<a name="line.126"></a>
<span class="sourceLineNo">127</span> *<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @return {@code null}.<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> @Override<a name="line.130"></a>
<span class="sourceLineNo">131</span> public final Layout&lt;LogEvent&gt; getLayout() {<a name="line.131"></a>
<span class="sourceLineNo">132</span> return null;<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> * Returns the underlying manager in use within this appender.<a name="line.136"></a>
<span class="sourceLineNo">137</span> *<a name="line.137"></a>
<span class="sourceLineNo">138</span> * @return the manager.<a name="line.138"></a>
<span class="sourceLineNo">139</span> */<a name="line.139"></a>
<span class="sourceLineNo">140</span> public final T getManager() {<a name="line.140"></a>
<span class="sourceLineNo">141</span> return this.manager;<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<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> * Replaces the underlying manager in use within this appender. This can be useful for manually changing the way log<a name="line.145"></a>
<span class="sourceLineNo">146</span> * events are written to the database without losing buffered or in-progress events. The existing manager is<a name="line.146"></a>
<span class="sourceLineNo">147</span> * released only after the new manager has been installed. This method is thread-safe.<a name="line.147"></a>
<span class="sourceLineNo">148</span> *<a name="line.148"></a>
<span class="sourceLineNo">149</span> * @param manager The new manager to install.<a name="line.149"></a>
<span class="sourceLineNo">150</span> */<a name="line.150"></a>
<span class="sourceLineNo">151</span> protected final void replaceManager(final T manager) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> this.writeLock.lock();<a name="line.152"></a>
<span class="sourceLineNo">153</span> try {<a name="line.153"></a>
<span class="sourceLineNo">154</span> final T old = this.getManager();<a name="line.154"></a>
<span class="sourceLineNo">155</span> if (!manager.isRunning()) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> manager.startup();<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span> this.manager = manager;<a name="line.158"></a>
<span class="sourceLineNo">159</span> old.close();<a name="line.159"></a>
<span class="sourceLineNo">160</span> } finally {<a name="line.160"></a>
<span class="sourceLineNo">161</span> this.writeLock.unlock();<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> @Override<a name="line.165"></a>
<span class="sourceLineNo">166</span> public final void start() {<a name="line.166"></a>
<span class="sourceLineNo">167</span> if (this.getManager() == null) {<a name="line.167"></a>
<span class="sourceLineNo">168</span> LOGGER.error("No AbstractDatabaseManager set for the appender named [{}].", this.getName());<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span> super.start();<a name="line.170"></a>
<span class="sourceLineNo">171</span> if (this.getManager() != null) {<a name="line.171"></a>
<span class="sourceLineNo">172</span> this.getManager().startup();<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><a name="line.175"></a>
<span class="sourceLineNo">176</span> @Override<a name="line.176"></a>
<span class="sourceLineNo">177</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.177"></a>
<span class="sourceLineNo">178</span> setStopping();<a name="line.178"></a>
<span class="sourceLineNo">179</span> boolean stopped = super.stop(timeout, timeUnit, false);<a name="line.179"></a>
<span class="sourceLineNo">180</span> if (this.getManager() != null) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> stopped &amp;= this.getManager().stop(timeout, timeUnit);<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span> setStopped();<a name="line.183"></a>
<span class="sourceLineNo">184</span> return stopped;<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>
</pre>
</div>
</body>
</html>