Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4j / 2.13.2 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / appender / db / jdbc / AbstractDriverManagerConnectionSource.html
blob: 264d413a163a6bb2e94aec495cca87552c7d555a [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.jdbc;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.sql.Connection;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.sql.DriverManager;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.sql.SQLException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Properties;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.Logger;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.config.Property;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * A {@link ConnectionSource} that uses a JDBC connection string, a user name, and a password to call<a name="line.32"></a>
<span class="sourceLineNo">033</span> * {@link DriverManager#getConnection(String, String, String)}.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * This plugin does not provide any connection pooling unless it is available through the connection string and driver<a name="line.35"></a>
<span class="sourceLineNo">036</span> * itself. This handy to get you off the ground without having to deal with JNDI.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;/p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>public class AbstractDriverManagerConnectionSource extends AbstractConnectionSource {<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Builds DriverManagerConnectionSource instances.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @param &lt;B&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * This builder type or a subclass.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> public static class Builder&lt;B extends Builder&lt;B&gt;&gt; {<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> @PluginBuilderAttribute<a name="line.49"></a>
<span class="sourceLineNo">050</span> @Required<a name="line.50"></a>
<span class="sourceLineNo">051</span> protected String connectionString;<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> @PluginBuilderAttribute<a name="line.53"></a>
<span class="sourceLineNo">054</span> protected String driverClassName;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> @PluginBuilderAttribute<a name="line.56"></a>
<span class="sourceLineNo">057</span> protected char[] password;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> @PluginElement("Properties")<a name="line.59"></a>
<span class="sourceLineNo">060</span> protected Property[] properties;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> @PluginBuilderAttribute<a name="line.62"></a>
<span class="sourceLineNo">063</span> protected char[] userName;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> @SuppressWarnings("unchecked")<a name="line.65"></a>
<span class="sourceLineNo">066</span> protected B asBuilder() {<a name="line.66"></a>
<span class="sourceLineNo">067</span> return (B) this;<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> public String getConnectionString() {<a name="line.70"></a>
<span class="sourceLineNo">071</span> return connectionString;<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> public String getDriverClassName() {<a name="line.74"></a>
<span class="sourceLineNo">075</span> return driverClassName;<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> public char[] getPassword() {<a name="line.78"></a>
<span class="sourceLineNo">079</span> return password;<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> public Property[] getProperties() {<a name="line.82"></a>
<span class="sourceLineNo">083</span> return properties;<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> public char[] getUserName() {<a name="line.86"></a>
<span class="sourceLineNo">087</span> return userName;<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> public B setConnectionString(final String connectionString) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> this.connectionString = connectionString;<a name="line.91"></a>
<span class="sourceLineNo">092</span> return asBuilder();<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> public B setDriverClassName(final String driverClassName) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> this.driverClassName = driverClassName;<a name="line.96"></a>
<span class="sourceLineNo">097</span> return asBuilder();<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> public B setPassword(final char[] password) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> this.password = password;<a name="line.101"></a>
<span class="sourceLineNo">102</span> return asBuilder();<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> public B setProperties(final Property[] properties) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> this.properties = properties;<a name="line.106"></a>
<span class="sourceLineNo">107</span> return asBuilder();<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> public B setUserName(final char[] userName) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> this.userName = userName;<a name="line.111"></a>
<span class="sourceLineNo">112</span> return asBuilder();<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><a name="line.115"></a>
<span class="sourceLineNo">116</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> public static Logger getLogger() {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return LOGGER;<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> private final String actualConnectionString;<a name="line.122"></a>
<span class="sourceLineNo">123</span> private final String connectionString;<a name="line.123"></a>
<span class="sourceLineNo">124</span> private final String driverClassName;<a name="line.124"></a>
<span class="sourceLineNo">125</span> private final char[] password;<a name="line.125"></a>
<span class="sourceLineNo">126</span> private final Property[] properties;<a name="line.126"></a>
<span class="sourceLineNo">127</span> private final char[] userName;<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> public AbstractDriverManagerConnectionSource(final String driverClassName, final String connectionString,<a name="line.129"></a>
<span class="sourceLineNo">130</span> final String actualConnectionString, final char[] userName, final char[] password, final Property[] properties) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> super();<a name="line.131"></a>
<span class="sourceLineNo">132</span> this.driverClassName = driverClassName;<a name="line.132"></a>
<span class="sourceLineNo">133</span> this.connectionString = connectionString;<a name="line.133"></a>
<span class="sourceLineNo">134</span> this.actualConnectionString = actualConnectionString;<a name="line.134"></a>
<span class="sourceLineNo">135</span> this.userName = userName;<a name="line.135"></a>
<span class="sourceLineNo">136</span> this.password = password;<a name="line.136"></a>
<span class="sourceLineNo">137</span> this.properties = properties;<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> public String getActualConnectionString() {<a name="line.140"></a>
<span class="sourceLineNo">141</span> return actualConnectionString;<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> @SuppressWarnings("resource") // The JDBC Connection is freed when the connection source is stopped.<a name="line.144"></a>
<span class="sourceLineNo">145</span> @Override<a name="line.145"></a>
<span class="sourceLineNo">146</span> public Connection getConnection() throws SQLException {<a name="line.146"></a>
<span class="sourceLineNo">147</span> loadDriver();<a name="line.147"></a>
<span class="sourceLineNo">148</span> final String actualConnectionString = getActualConnectionString();<a name="line.148"></a>
<span class="sourceLineNo">149</span> LOGGER.debug("{} getting connection for '{}'", getClass().getSimpleName(), actualConnectionString);<a name="line.149"></a>
<span class="sourceLineNo">150</span> Connection connection;<a name="line.150"></a>
<span class="sourceLineNo">151</span> if (properties != null &amp;&amp; properties.length &gt; 0) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> if (userName != null || password != null) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> throw new SQLException("Either set the userName and password, or set the Properties, but not both.");<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span> connection = DriverManager.getConnection(actualConnectionString, toProperties(properties));<a name="line.155"></a>
<span class="sourceLineNo">156</span> } else {<a name="line.156"></a>
<span class="sourceLineNo">157</span> connection = DriverManager.getConnection(actualConnectionString, toString(userName), toString(password));<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span> LOGGER.debug("{} acquired connection for '{}': {} ({}@{})", getClass().getSimpleName(), actualConnectionString,<a name="line.159"></a>
<span class="sourceLineNo">160</span> connection, connection.getClass().getName(), Integer.toHexString(connection.hashCode()));<a name="line.160"></a>
<span class="sourceLineNo">161</span> return connection;<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> public String getConnectionString() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return connectionString;<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> public String getDriverClassName() {<a name="line.168"></a>
<span class="sourceLineNo">169</span> return driverClassName;<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> public char[] getPassword() {<a name="line.172"></a>
<span class="sourceLineNo">173</span> return password;<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> public Property[] getProperties() {<a name="line.176"></a>
<span class="sourceLineNo">177</span> return properties;<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> public char[] getUserName() {<a name="line.180"></a>
<span class="sourceLineNo">181</span> return userName;<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> protected void loadDriver() throws SQLException {<a name="line.184"></a>
<span class="sourceLineNo">185</span> loadDriver(driverClassName);<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> /**<a name="line.188"></a>
<span class="sourceLineNo">189</span> * Loads a JDBC driver for the given class name<a name="line.189"></a>
<span class="sourceLineNo">190</span> *<a name="line.190"></a>
<span class="sourceLineNo">191</span> * @param className<a name="line.191"></a>
<span class="sourceLineNo">192</span> * the fully-qualified class name for a JDBC Driver.<a name="line.192"></a>
<span class="sourceLineNo">193</span> * @throws SQLException<a name="line.193"></a>
<span class="sourceLineNo">194</span> * thrown when loading the driver throws an exception.<a name="line.194"></a>
<span class="sourceLineNo">195</span> */<a name="line.195"></a>
<span class="sourceLineNo">196</span> protected void loadDriver(final String className) throws SQLException {<a name="line.196"></a>
<span class="sourceLineNo">197</span> if (className != null) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> // Hack for old JDBC drivers.<a name="line.198"></a>
<span class="sourceLineNo">199</span> LOGGER.debug("Loading driver class {}", className);<a name="line.199"></a>
<span class="sourceLineNo">200</span> try {<a name="line.200"></a>
<span class="sourceLineNo">201</span> Class.forName(className);<a name="line.201"></a>
<span class="sourceLineNo">202</span> } catch (final Exception e) {<a name="line.202"></a>
<span class="sourceLineNo">203</span> throw new SQLException(String.format("The %s could not load the JDBC driver %s: %s",<a name="line.203"></a>
<span class="sourceLineNo">204</span> getClass().getSimpleName(), className, e.toString()), e);<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> }<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> protected Properties toProperties(final Property[] properties) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> final Properties props = new Properties();<a name="line.210"></a>
<span class="sourceLineNo">211</span> for (final Property property : properties) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> props.setProperty(property.getName(), property.getValue());<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span> return props;<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> @Override<a name="line.217"></a>
<span class="sourceLineNo">218</span> public String toString() {<a name="line.218"></a>
<span class="sourceLineNo">219</span> return this.connectionString;<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> protected String toString(final char[] value) {<a name="line.222"></a>
<span class="sourceLineNo">223</span> return value == null ? null : String.valueOf(value);<a name="line.223"></a>
<span class="sourceLineNo">224</span> }<a name="line.224"></a>
<span class="sourceLineNo">225</span>}<a name="line.225"></a>
</pre>
</div>
</body>
</html>