| <!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.jpa;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.lang.reflect.Constructor;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.core.Appender;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.Core;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.Filter;<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.appender.AbstractAppender;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.appender.db.AbstractDatabaseAppender;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.Property;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.util.Booleans;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.util.LoaderUtil;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.util.Strings;<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> * This Appender writes logging events to a relational database using the Java Persistence API. It requires a<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * pre-configured JPA persistence unit and a concrete implementation of the abstract<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * {@link AbstractLogEventWrapperEntity} class decorated with JPA annotations.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> *<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @see AbstractLogEventWrapperEntity<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>@Plugin(name = "JPA", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>public final class JpaAppender extends AbstractDatabaseAppender<JpaDatabaseManager> {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> private final String description;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> private JpaAppender(final String name, final Filter filter, final boolean ignoreExceptions,<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> final Property[] properties, final JpaDatabaseManager manager) {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> super(name, filter, null, ignoreExceptions, properties, manager);<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> this.description = this.getName() + "{ manager=" + this.getManager() + " }";<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> @Override<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> public String toString() {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> return this.description;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> }<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> * Factory method for creating a JPA appender within the plugin manager.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> *<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @param name The name of the appender.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * they are propagated to the caller.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @param filter The filter, if any, to use.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param bufferSize If an integer greater than 0, this causes the appender to buffer log events and flush whenever<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * the buffer reaches this size.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @param entityClassName The fully qualified name of the concrete {@link AbstractLogEventWrapperEntity}<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * implementation that has JPA annotations mapping it to a database table.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param persistenceUnitName The name of the JPA persistence unit that should be used for persisting log events.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @return a new JPA appender.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> @PluginFactory<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public static JpaAppender createAppender(<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> @PluginAttribute("name") final String name,<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> @PluginAttribute("ignoreExceptions") final String ignore,<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> @PluginElement("Filter") final Filter filter,<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> @PluginAttribute("bufferSize") final String bufferSize,<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> @PluginAttribute("entityClassName") final String entityClassName,<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> @PluginAttribute("persistenceUnitName") final String persistenceUnitName) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> if (Strings.isEmpty(entityClassName) || Strings.isEmpty(persistenceUnitName)) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> LOGGER.error("Attributes entityClassName and persistenceUnitName are required for JPA Appender.");<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> return null;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> final int bufferSizeInt = AbstractAppender.parseInt(bufferSize, 0);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> try {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> final Class<? extends AbstractLogEventWrapperEntity> entityClass =<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> LoaderUtil.loadClass(entityClassName).asSubclass(AbstractLogEventWrapperEntity.class);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> try {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> entityClass.getConstructor();<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> } catch (final NoSuchMethodException e) {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> LOGGER.error("Entity class [{}] does not have a no-arg constructor. The JPA provider will reject it.",<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> entityClassName);<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> return null;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> final Constructor<? extends AbstractLogEventWrapperEntity> entityConstructor =<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> entityClass.getConstructor(LogEvent.class);<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> final String managerName = "jpaManager{ description=" + name + ", bufferSize=" + bufferSizeInt<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> + ", persistenceUnitName=" + persistenceUnitName + ", entityClass=" + entityClass.getName() + '}';<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> final JpaDatabaseManager manager = JpaDatabaseManager.getJPADatabaseManager(<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> managerName, bufferSizeInt, entityClass, entityConstructor, persistenceUnitName<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> );<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> if (manager == null) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> return null;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> return new JpaAppender(name, filter, ignoreExceptions, null, manager);<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> } catch (final ClassNotFoundException e) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> LOGGER.error("Could not load entity class [{}].", entityClassName, e);<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> return null;<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> } catch (final NoSuchMethodException e) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> LOGGER.error("Entity class [{}] does not have a constructor with a single argument of type LogEvent.",<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> entityClassName);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> return null;<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> } catch (final ClassCastException e) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> LOGGER.error("Entity class [{}] does not extend AbstractLogEventWrapperEntity.", entityClassName);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return null;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
