Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4j / 2.13.0 / log4j-jpa / apidocs / src-html / org / apache / logging / log4j / core / appender / db / jpa / converter / ThrowableAttributeConverter.html
blob: 035f59ef6f59d0e28c57aa7858202bb880816330 [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.jpa.converter;<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>import java.lang.reflect.Field;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Arrays;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.ListIterator;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import javax.persistence.AttributeConverter;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.persistence.Converter;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.util.LoaderUtil;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.util.Strings;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * A JPA 2.1 attribute converter for {@link Throwable}s in {@link org.apache.logging.log4j.core.LogEvent}s. This<a name="line.33"></a>
<span class="sourceLineNo">034</span> * converter is capable of converting both to and from {@link String}s.<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span>@Converter(autoApply = false)<a name="line.36"></a>
<span class="sourceLineNo">037</span>public class ThrowableAttributeConverter implements AttributeConverter&lt;Throwable, String&gt; {<a name="line.37"></a>
<span class="sourceLineNo">038</span> private static final int CAUSED_BY_STRING_LENGTH = 10;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> private static final Field THROWABLE_CAUSE;<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private static final Field THROWABLE_MESSAGE;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> static {<a name="line.44"></a>
<span class="sourceLineNo">045</span> try {<a name="line.45"></a>
<span class="sourceLineNo">046</span> THROWABLE_CAUSE = Throwable.class.getDeclaredField("cause");<a name="line.46"></a>
<span class="sourceLineNo">047</span> THROWABLE_CAUSE.setAccessible(true);<a name="line.47"></a>
<span class="sourceLineNo">048</span> THROWABLE_MESSAGE = Throwable.class.getDeclaredField("detailMessage");<a name="line.48"></a>
<span class="sourceLineNo">049</span> THROWABLE_MESSAGE.setAccessible(true);<a name="line.49"></a>
<span class="sourceLineNo">050</span> } catch (final NoSuchFieldException e) {<a name="line.50"></a>
<span class="sourceLineNo">051</span> throw new IllegalStateException("Something is wrong with java.lang.Throwable.", e);<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> @Override<a name="line.55"></a>
<span class="sourceLineNo">056</span> public String convertToDatabaseColumn(final Throwable throwable) {<a name="line.56"></a>
<span class="sourceLineNo">057</span> if (throwable == null) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> return null;<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> final StringBuilder builder = new StringBuilder();<a name="line.61"></a>
<span class="sourceLineNo">062</span> this.convertThrowable(builder, throwable);<a name="line.62"></a>
<span class="sourceLineNo">063</span> return builder.toString();<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> private void convertThrowable(final StringBuilder builder, final Throwable throwable) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> builder.append(throwable.toString()).append('\n');<a name="line.67"></a>
<span class="sourceLineNo">068</span> for (final StackTraceElement element : throwable.getStackTrace()) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> builder.append("\tat ").append(element).append('\n');<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span> if (throwable.getCause() != null) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> builder.append("Caused by ");<a name="line.72"></a>
<span class="sourceLineNo">073</span> this.convertThrowable(builder, throwable.getCause());<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> @Override<a name="line.77"></a>
<span class="sourceLineNo">078</span> public Throwable convertToEntityAttribute(final String s) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> if (Strings.isEmpty(s)) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> return null;<a name="line.80"></a>
<span class="sourceLineNo">081</span> }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> final List&lt;String&gt; lines = Arrays.asList(s.split("(\n|\r\n)"));<a name="line.83"></a>
<span class="sourceLineNo">084</span> return this.convertString(lines.listIterator(), false);<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> private Throwable convertString(final ListIterator&lt;String&gt; lines, final boolean removeCausedBy) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> String firstLine = lines.next();<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (removeCausedBy) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> firstLine = firstLine.substring(CAUSED_BY_STRING_LENGTH);<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span> final int colon = firstLine.indexOf(":");<a name="line.92"></a>
<span class="sourceLineNo">093</span> String throwableClassName;<a name="line.93"></a>
<span class="sourceLineNo">094</span> String message = null;<a name="line.94"></a>
<span class="sourceLineNo">095</span> if (colon &gt; 1) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> throwableClassName = firstLine.substring(0, colon);<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (firstLine.length() &gt; colon + 1) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> message = firstLine.substring(colon + 1).trim();<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> } else {<a name="line.100"></a>
<span class="sourceLineNo">101</span> throwableClassName = firstLine;<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> final List&lt;StackTraceElement&gt; stackTrace = new ArrayList&lt;&gt;();<a name="line.104"></a>
<span class="sourceLineNo">105</span> Throwable cause = null;<a name="line.105"></a>
<span class="sourceLineNo">106</span> while (lines.hasNext()) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> final String line = lines.next();<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> if (line.startsWith("Caused by ")) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> lines.previous();<a name="line.110"></a>
<span class="sourceLineNo">111</span> cause = convertString(lines, true);<a name="line.111"></a>
<span class="sourceLineNo">112</span> break;<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> stackTrace.add(<a name="line.115"></a>
<span class="sourceLineNo">116</span> StackTraceElementAttributeConverter.convertString(line.trim().substring(3).trim())<a name="line.116"></a>
<span class="sourceLineNo">117</span> );<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> return this.getThrowable(throwableClassName, message, cause,<a name="line.120"></a>
<span class="sourceLineNo">121</span> stackTrace.toArray(new StackTraceElement[stackTrace.size()]));<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> private Throwable getThrowable(final String throwableClassName, final String message, final Throwable cause,<a name="line.124"></a>
<span class="sourceLineNo">125</span> final StackTraceElement[] stackTrace) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> try {<a name="line.126"></a>
<span class="sourceLineNo">127</span> @SuppressWarnings("unchecked")<a name="line.127"></a>
<span class="sourceLineNo">128</span> final Class&lt;Throwable&gt; throwableClass = (Class&lt;Throwable&gt;) LoaderUtil.loadClass(throwableClassName);<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> if (!Throwable.class.isAssignableFrom(throwableClass)) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> return null;<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> Throwable throwable;<a name="line.134"></a>
<span class="sourceLineNo">135</span> if (message != null &amp;&amp; cause != null) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> throwable = this.getThrowable(throwableClass, message, cause);<a name="line.136"></a>
<span class="sourceLineNo">137</span> if (throwable == null) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> throwable = this.getThrowable(throwableClass, cause);<a name="line.138"></a>
<span class="sourceLineNo">139</span> if (throwable == null) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> throwable = this.getThrowable(throwableClass, message);<a name="line.140"></a>
<span class="sourceLineNo">141</span> if (throwable == null) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> throwable = this.getThrowable(throwableClass);<a name="line.142"></a>
<span class="sourceLineNo">143</span> if (throwable != null) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> THROWABLE_MESSAGE.set(throwable, message);<a name="line.144"></a>
<span class="sourceLineNo">145</span> THROWABLE_CAUSE.set(throwable, cause);<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> } else {<a name="line.147"></a>
<span class="sourceLineNo">148</span> THROWABLE_CAUSE.set(throwable, cause);<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span> } else {<a name="line.150"></a>
<span class="sourceLineNo">151</span> THROWABLE_MESSAGE.set(throwable, message);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span> } else if (cause != null) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> throwable = this.getThrowable(throwableClass, cause);<a name="line.155"></a>
<span class="sourceLineNo">156</span> if (throwable == null) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> throwable = this.getThrowable(throwableClass);<a name="line.157"></a>
<span class="sourceLineNo">158</span> if (throwable != null) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> THROWABLE_CAUSE.set(throwable, cause);<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> } else if (message != null) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> throwable = this.getThrowable(throwableClass, message);<a name="line.163"></a>
<span class="sourceLineNo">164</span> if (throwable == null) {<a name="line.164"></a>
<span class="sourceLineNo">165</span> throwable = this.getThrowable(throwableClass);<a name="line.165"></a>
<span class="sourceLineNo">166</span> if (throwable != null) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> THROWABLE_MESSAGE.set(throwable, cause);<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> } else {<a name="line.170"></a>
<span class="sourceLineNo">171</span> throwable = this.getThrowable(throwableClass);<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> if (throwable == null) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> return null;<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span> throwable.setStackTrace(stackTrace);<a name="line.177"></a>
<span class="sourceLineNo">178</span> return throwable;<a name="line.178"></a>
<span class="sourceLineNo">179</span> } catch (final Exception e) {<a name="line.179"></a>
<span class="sourceLineNo">180</span> return null;<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> private Throwable getThrowable(final Class&lt;Throwable&gt; throwableClass, final String message, final Throwable cause) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> try {<a name="line.185"></a>
<span class="sourceLineNo">186</span> @SuppressWarnings("unchecked")<a name="line.186"></a>
<span class="sourceLineNo">187</span> final<a name="line.187"></a>
<span class="sourceLineNo">188</span> Constructor&lt;Throwable&gt;[] constructors = (Constructor&lt;Throwable&gt;[]) throwableClass.getConstructors();<a name="line.188"></a>
<span class="sourceLineNo">189</span> for (final Constructor&lt;Throwable&gt; constructor : constructors) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> final Class&lt;?&gt;[] parameterTypes = constructor.getParameterTypes();<a name="line.190"></a>
<span class="sourceLineNo">191</span> if (parameterTypes.length == 2) {<a name="line.191"></a>
<span class="sourceLineNo">192</span> if (String.class == parameterTypes[0] &amp;&amp; Throwable.class.isAssignableFrom(parameterTypes[1])) {<a name="line.192"></a>
<span class="sourceLineNo">193</span> return constructor.newInstance(message, cause);<a name="line.193"></a>
<span class="sourceLineNo">194</span> } else if (String.class == parameterTypes[1] &amp;&amp;<a name="line.194"></a>
<span class="sourceLineNo">195</span> Throwable.class.isAssignableFrom(parameterTypes[0])) {<a name="line.195"></a>
<span class="sourceLineNo">196</span> return constructor.newInstance(cause, message);<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> }<a name="line.199"></a>
<span class="sourceLineNo">200</span> return null;<a name="line.200"></a>
<span class="sourceLineNo">201</span> } catch (final Exception e) {<a name="line.201"></a>
<span class="sourceLineNo">202</span> return null;<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<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> private Throwable getThrowable(final Class&lt;Throwable&gt; throwableClass, final Throwable cause) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> try {<a name="line.207"></a>
<span class="sourceLineNo">208</span> @SuppressWarnings("unchecked")<a name="line.208"></a>
<span class="sourceLineNo">209</span> final<a name="line.209"></a>
<span class="sourceLineNo">210</span> Constructor&lt;Throwable&gt;[] constructors = (Constructor&lt;Throwable&gt;[]) throwableClass.getConstructors();<a name="line.210"></a>
<span class="sourceLineNo">211</span> for (final Constructor&lt;Throwable&gt; constructor : constructors) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> final Class&lt;?&gt;[] parameterTypes = constructor.getParameterTypes();<a name="line.212"></a>
<span class="sourceLineNo">213</span> if (parameterTypes.length == 1 &amp;&amp; Throwable.class.isAssignableFrom(parameterTypes[0])) {<a name="line.213"></a>
<span class="sourceLineNo">214</span> return constructor.newInstance(cause);<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span> return null;<a name="line.217"></a>
<span class="sourceLineNo">218</span> } catch (final Exception e) {<a name="line.218"></a>
<span class="sourceLineNo">219</span> return null;<a name="line.219"></a>
<span class="sourceLineNo">220</span> }<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span><a name="line.222"></a>
<span class="sourceLineNo">223</span> private Throwable getThrowable(final Class&lt;Throwable&gt; throwableClass, final String message) {<a name="line.223"></a>
<span class="sourceLineNo">224</span> try {<a name="line.224"></a>
<span class="sourceLineNo">225</span> return throwableClass.getConstructor(String.class).newInstance(message);<a name="line.225"></a>
<span class="sourceLineNo">226</span> } catch (final Exception e) {<a name="line.226"></a>
<span class="sourceLineNo">227</span> return null;<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> private Throwable getThrowable(final Class&lt;Throwable&gt; throwableClass) {<a name="line.231"></a>
<span class="sourceLineNo">232</span> try {<a name="line.232"></a>
<span class="sourceLineNo">233</span> return throwableClass.newInstance();<a name="line.233"></a>
<span class="sourceLineNo">234</span> } catch (final Exception e) {<a name="line.234"></a>
<span class="sourceLineNo">235</span> return null;<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<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>
</pre>
</div>
</body>
</html>