blob: 53ba71414dbb6ab7a8addb33ad9f6aa32ede49b7 [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.util.Date;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Locale;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.logging.log4j.Logger;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.Core;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.StringLayout;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<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.validation.constraints.Required;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.layout.PatternLayout;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.spi.ThreadContextMap;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.spi.ThreadContextStack;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.util.ReadOnlyStringMap;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * A configuration element for specifying a database column name mapping.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @since 2.8<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>@Plugin(name = "ColumnMapping", category = Core.CATEGORY_NAME, printObject = true)<a name="line.43"></a>
<span class="sourceLineNo">044</span>public class ColumnMapping {<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> * Builder for {@link ColumnMapping}.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> public static class Builder implements org.apache.logging.log4j.core.util.Builder&lt;ColumnMapping&gt; {<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> @PluginConfiguration<a name="line.51"></a>
<span class="sourceLineNo">052</span> private Configuration configuration;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> @PluginElement("Layout")<a name="line.54"></a>
<span class="sourceLineNo">055</span> private StringLayout layout;<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> @PluginBuilderAttribute<a name="line.57"></a>
<span class="sourceLineNo">058</span> private String literal;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> @PluginBuilderAttribute<a name="line.60"></a>
<span class="sourceLineNo">061</span> @Required(message = "No column name provided")<a name="line.61"></a>
<span class="sourceLineNo">062</span> private String name;<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> @PluginBuilderAttribute<a name="line.64"></a>
<span class="sourceLineNo">065</span> private String parameter;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> @PluginBuilderAttribute<a name="line.67"></a>
<span class="sourceLineNo">068</span> private String pattern;<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> @PluginBuilderAttribute<a name="line.70"></a>
<span class="sourceLineNo">071</span> private String source;<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> @PluginBuilderAttribute<a name="line.73"></a>
<span class="sourceLineNo">074</span> @Required(message = "No conversion type provided")<a name="line.74"></a>
<span class="sourceLineNo">075</span> private Class&lt;?&gt; type = String.class;<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 ColumnMapping build() {<a name="line.78"></a>
<span class="sourceLineNo">079</span> if (pattern != null) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> layout = PatternLayout.newBuilder()<a name="line.80"></a>
<span class="sourceLineNo">081</span> .withPattern(pattern)<a name="line.81"></a>
<span class="sourceLineNo">082</span> .withConfiguration(configuration)<a name="line.82"></a>
<span class="sourceLineNo">083</span> .withAlwaysWriteExceptions(false)<a name="line.83"></a>
<span class="sourceLineNo">084</span> .build();<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> if (!(layout == null<a name="line.86"></a>
<span class="sourceLineNo">087</span> || literal == null<a name="line.87"></a>
<span class="sourceLineNo">088</span> || Date.class.isAssignableFrom(type)<a name="line.88"></a>
<span class="sourceLineNo">089</span> || ReadOnlyStringMap.class.isAssignableFrom(type)<a name="line.89"></a>
<span class="sourceLineNo">090</span> || ThreadContextMap.class.isAssignableFrom(type)<a name="line.90"></a>
<span class="sourceLineNo">091</span> || ThreadContextStack.class.isAssignableFrom(type))) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> LOGGER.error("No 'layout' or 'literal' value specified and type ({}) is not compatible with ThreadContextMap, ThreadContextStack, or java.util.Date for the mapping", type, this);<a name="line.92"></a>
<span class="sourceLineNo">093</span> return null;<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span> if (literal != null &amp;&amp; parameter != null) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> LOGGER.error("Only one of 'literal' or 'parameter' can be set on the column mapping {}", this);<a name="line.96"></a>
<span class="sourceLineNo">097</span> return null;<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span> return new ColumnMapping(name, source, layout, literal, parameter, type);<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> public Builder setConfiguration(final Configuration configuration) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> this.configuration = configuration;<a name="line.103"></a>
<span class="sourceLineNo">104</span> return this;<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> * Layout of value to write to database (before type conversion). Not applicable if {@link #setType(Class)} is<a name="line.108"></a>
<span class="sourceLineNo">109</span> * a {@link ReadOnlyStringMap}, {@link ThreadContextMap}, or {@link ThreadContextStack}.<a name="line.109"></a>
<span class="sourceLineNo">110</span> *<a name="line.110"></a>
<span class="sourceLineNo">111</span> * @return this.<a name="line.111"></a>
<span class="sourceLineNo">112</span> */<a name="line.112"></a>
<span class="sourceLineNo">113</span> public Builder setLayout(final StringLayout layout) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> this.layout = layout;<a name="line.114"></a>
<span class="sourceLineNo">115</span> return this;<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<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> * Literal value to use for populating a column. This is generally useful for functions, stored procedures,<a name="line.119"></a>
<span class="sourceLineNo">120</span> * etc. No escaping will be done on this value.<a name="line.120"></a>
<span class="sourceLineNo">121</span> *<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @return this.<a name="line.122"></a>
<span class="sourceLineNo">123</span> */<a name="line.123"></a>
<span class="sourceLineNo">124</span> public Builder setLiteral(final String literal) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> this.literal = literal;<a name="line.125"></a>
<span class="sourceLineNo">126</span> return this;<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> * Column name.<a name="line.130"></a>
<span class="sourceLineNo">131</span> *<a name="line.131"></a>
<span class="sourceLineNo">132</span> * @return this.<a name="line.132"></a>
<span class="sourceLineNo">133</span> */<a name="line.133"></a>
<span class="sourceLineNo">134</span> public Builder setName(final String name) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> this.name = name;<a name="line.135"></a>
<span class="sourceLineNo">136</span> return this;<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> /**<a name="line.139"></a>
<span class="sourceLineNo">140</span> * Parameter value to use for populating a column, MUST contain a single parameter marker '?'. This is generally useful for functions, stored procedures,<a name="line.140"></a>
<span class="sourceLineNo">141</span> * etc. No escaping will be done on this value.<a name="line.141"></a>
<span class="sourceLineNo">142</span> *<a name="line.142"></a>
<span class="sourceLineNo">143</span> * @return this.<a name="line.143"></a>
<span class="sourceLineNo">144</span> */<a name="line.144"></a>
<span class="sourceLineNo">145</span> public Builder setParameter(final String parameter) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> this.parameter= parameter;<a name="line.146"></a>
<span class="sourceLineNo">147</span> return this;<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> * Pattern to use as a {@link PatternLayout}. Convenient shorthand for {@link #setLayout(StringLayout)} with a<a name="line.151"></a>
<span class="sourceLineNo">152</span> * PatternLayout.<a name="line.152"></a>
<span class="sourceLineNo">153</span> *<a name="line.153"></a>
<span class="sourceLineNo">154</span> * @return this.<a name="line.154"></a>
<span class="sourceLineNo">155</span> */<a name="line.155"></a>
<span class="sourceLineNo">156</span> public Builder setPattern(final String pattern) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> this.pattern = pattern;<a name="line.157"></a>
<span class="sourceLineNo">158</span> return this;<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<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> * Source name. Useful when combined with a {@link org.apache.logging.log4j.message.MapMessage} depending on the<a name="line.162"></a>
<span class="sourceLineNo">163</span> * appender.<a name="line.163"></a>
<span class="sourceLineNo">164</span> *<a name="line.164"></a>
<span class="sourceLineNo">165</span> * @return this.<a name="line.165"></a>
<span class="sourceLineNo">166</span> */<a name="line.166"></a>
<span class="sourceLineNo">167</span> public Builder setSource(final String source) {<a name="line.167"></a>
<span class="sourceLineNo">168</span> this.source = source;<a name="line.168"></a>
<span class="sourceLineNo">169</span> return this;<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span> /**<a name="line.172"></a>
<span class="sourceLineNo">173</span> * Class to convert value to before storing in database. If the type is compatible with {@link ThreadContextMap} or<a name="line.173"></a>
<span class="sourceLineNo">174</span> * {@link ReadOnlyStringMap}, then the MDC will be used. If the type is compatible with {@link ThreadContextStack},<a name="line.174"></a>
<span class="sourceLineNo">175</span> * then the NDC will be used. If the type is compatible with {@link Date}, then the event timestamp will be used.<a name="line.175"></a>
<span class="sourceLineNo">176</span> *<a name="line.176"></a>
<span class="sourceLineNo">177</span> * @return this.<a name="line.177"></a>
<span class="sourceLineNo">178</span> */<a name="line.178"></a>
<span class="sourceLineNo">179</span> public Builder setType(final Class&lt;?&gt; type) {<a name="line.179"></a>
<span class="sourceLineNo">180</span> this.type = type;<a name="line.180"></a>
<span class="sourceLineNo">181</span> return this;<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> @Override<a name="line.184"></a>
<span class="sourceLineNo">185</span> public String toString() {<a name="line.185"></a>
<span class="sourceLineNo">186</span> return "Builder [name=" + name + ", source=" + source + ", literal=" + literal + ", parameter=" + parameter<a name="line.186"></a>
<span class="sourceLineNo">187</span> + ", pattern=" + pattern + ", type=" + type + ", layout=" + layout + "]";<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.191"></a>
<span class="sourceLineNo">192</span><a name="line.192"></a>
<span class="sourceLineNo">193</span> @PluginBuilderFactory<a name="line.193"></a>
<span class="sourceLineNo">194</span> public static Builder newBuilder() {<a name="line.194"></a>
<span class="sourceLineNo">195</span> return new Builder();<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> public static String toKey(final String name) {<a name="line.198"></a>
<span class="sourceLineNo">199</span> return name.toUpperCase(Locale.ROOT);<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> private final StringLayout layout;<a name="line.202"></a>
<span class="sourceLineNo">203</span> private final String literalValue;<a name="line.203"></a>
<span class="sourceLineNo">204</span> private final String name;<a name="line.204"></a>
<span class="sourceLineNo">205</span> private final String nameKey;<a name="line.205"></a>
<span class="sourceLineNo">206</span> private final String parameter;<a name="line.206"></a>
<span class="sourceLineNo">207</span> private final String source;<a name="line.207"></a>
<span class="sourceLineNo">208</span> private final Class&lt;?&gt; type;<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span> private ColumnMapping(final String name, final String source, final StringLayout layout, final String literalValue, final String parameter, final Class&lt;?&gt; type) {<a name="line.210"></a>
<span class="sourceLineNo">211</span> this.name = name;<a name="line.211"></a>
<span class="sourceLineNo">212</span> this.nameKey = toKey(name);<a name="line.212"></a>
<span class="sourceLineNo">213</span> this.source = source;<a name="line.213"></a>
<span class="sourceLineNo">214</span> this.layout = layout;<a name="line.214"></a>
<span class="sourceLineNo">215</span> this.literalValue = literalValue;<a name="line.215"></a>
<span class="sourceLineNo">216</span> this.parameter = parameter;<a name="line.216"></a>
<span class="sourceLineNo">217</span> this.type = type;<a name="line.217"></a>
<span class="sourceLineNo">218</span> }<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span> public StringLayout getLayout() {<a name="line.220"></a>
<span class="sourceLineNo">221</span> return layout;<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span> public String getLiteralValue() {<a name="line.224"></a>
<span class="sourceLineNo">225</span> return literalValue;<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> public String getName() {<a name="line.228"></a>
<span class="sourceLineNo">229</span> return name;<a name="line.229"></a>
<span class="sourceLineNo">230</span> }<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span> public String getNameKey() {<a name="line.232"></a>
<span class="sourceLineNo">233</span> return nameKey;<a name="line.233"></a>
<span class="sourceLineNo">234</span> }<a name="line.234"></a>
<span class="sourceLineNo">235</span><a name="line.235"></a>
<span class="sourceLineNo">236</span> public String getParameter() {<a name="line.236"></a>
<span class="sourceLineNo">237</span> return parameter;<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> public String getSource() {<a name="line.240"></a>
<span class="sourceLineNo">241</span> return source;<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> public Class&lt;?&gt; getType() {<a name="line.244"></a>
<span class="sourceLineNo">245</span> return type;<a name="line.245"></a>
<span class="sourceLineNo">246</span> }<a name="line.246"></a>
<span class="sourceLineNo">247</span><a name="line.247"></a>
<span class="sourceLineNo">248</span> @Override<a name="line.248"></a>
<span class="sourceLineNo">249</span> public String toString() {<a name="line.249"></a>
<span class="sourceLineNo">250</span> return "ColumnMapping [name=" + name + ", source=" + source + ", literalValue=" + literalValue + ", parameter="<a name="line.250"></a>
<span class="sourceLineNo">251</span> + parameter + ", type=" + type + ", layout=" + layout + "]";<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>
</pre>
</div>
</body>
</html>