Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-jdbc-dbcp2 / apidocs / src-html / org / apache / logging / log4j / core / appender / db / jdbc / PoolingDriverConnectionSource.html
blob: 92224eca1ec6bc481f1d1574148f88418889eac0 [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.DriverManager;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.sql.SQLException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Arrays;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.TimeUnit;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.commons.dbcp2.ConnectionFactory;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.commons.dbcp2.DriverManagerConnectionFactory;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.commons.dbcp2.PoolableConnection;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.commons.dbcp2.PoolableConnectionFactory;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.commons.dbcp2.PoolingDriver;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.commons.pool2.ObjectPool;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.commons.pool2.impl.GenericObjectPool;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.Core;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.Property;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<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 {@link ConnectionSource} that uses a JDBC connection string, a user name, and a password to call<a name="line.39"></a>
<span class="sourceLineNo">040</span> * {@link DriverManager#getConnection(String, String, String)}. The connections are served from an<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;a href="http://commons.apache.org/proper/commons-dbcp/"&gt;Apache Commons DBCP&lt;/a&gt; pooling driver.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>@Plugin(name = "PoolingDriver", category = Core.CATEGORY_NAME, elementType = "connectionSource", printObject = true)<a name="line.43"></a>
<span class="sourceLineNo">044</span>public final class PoolingDriverConnectionSource extends AbstractDriverManagerConnectionSource {<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> * Builds PoolingDriverConnectionSource instances.<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @param &lt;B&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * This builder type or a subclass.<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span> public static class Builder&lt;B extends Builder&lt;B&gt;&gt; extends AbstractDriverManagerConnectionSource.Builder&lt;B&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> implements org.apache.logging.log4j.core.util.Builder&lt;PoolingDriverConnectionSource&gt; {<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> public static final String DEFAULT_POOL_NAME = "example";<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> @PluginElement("PoolableConnectionFactoryConfig")<a name="line.57"></a>
<span class="sourceLineNo">058</span> private PoolableConnectionFactoryConfig poolableConnectionFactoryConfig;<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> private String poolName = DEFAULT_POOL_NAME;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> @Override<a name="line.63"></a>
<span class="sourceLineNo">064</span> public PoolingDriverConnectionSource build() {<a name="line.64"></a>
<span class="sourceLineNo">065</span> try {<a name="line.65"></a>
<span class="sourceLineNo">066</span> return new PoolingDriverConnectionSource(getDriverClassName(), getConnectionString(), getUserName(),<a name="line.66"></a>
<span class="sourceLineNo">067</span> getPassword(), getProperties(), poolName, poolableConnectionFactoryConfig);<a name="line.67"></a>
<span class="sourceLineNo">068</span> } catch (final SQLException e) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> getLogger().error("Exception constructing {} to '{}' with {}", PoolingDriverConnectionSource.class,<a name="line.69"></a>
<span class="sourceLineNo">070</span> getConnectionString(), this, e);<a name="line.70"></a>
<span class="sourceLineNo">071</span> return null;<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><a name="line.74"></a>
<span class="sourceLineNo">075</span> public B setPoolableConnectionFactoryConfig(final PoolableConnectionFactoryConfig poolableConnectionFactoryConfig) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> this.poolableConnectionFactoryConfig = poolableConnectionFactoryConfig;<a name="line.76"></a>
<span class="sourceLineNo">077</span> return asBuilder();<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> public B setPoolName(final String poolName) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> this.poolName = poolName;<a name="line.81"></a>
<span class="sourceLineNo">082</span> return asBuilder();<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> @Override<a name="line.85"></a>
<span class="sourceLineNo">086</span> public String toString() {<a name="line.86"></a>
<span class="sourceLineNo">087</span> return "Builder [poolName=" + poolName + ", connectionString=" + connectionString + ", driverClassName="<a name="line.87"></a>
<span class="sourceLineNo">088</span> + driverClassName + ", properties=" + Arrays.toString(properties) + ", userName="<a name="line.88"></a>
<span class="sourceLineNo">089</span> + Arrays.toString(userName) + "]";<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> public static final String URL_PREFIX = "jdbc:apache:commons:dbcp:";<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> // This method is not named newBuilder() to make the compiler happy.<a name="line.95"></a>
<span class="sourceLineNo">096</span> @PluginBuilderFactory<a name="line.96"></a>
<span class="sourceLineNo">097</span> public static &lt;B extends Builder&lt;B&gt;&gt; B newPoolingDriverConnectionSourceBuilder() {<a name="line.97"></a>
<span class="sourceLineNo">098</span> return new Builder&lt;B&gt;().asBuilder();<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> private final String poolingDriverClassName = "org.apache.commons.dbcp2.PoolingDriver";<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> private final String poolName;<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> * @deprecated Use {@link #newPoolingDriverConnectionSourceBuilder()}.<a name="line.106"></a>
<span class="sourceLineNo">107</span> */<a name="line.107"></a>
<span class="sourceLineNo">108</span> @Deprecated<a name="line.108"></a>
<span class="sourceLineNo">109</span> public PoolingDriverConnectionSource(final String driverClassName, final String connectionString,<a name="line.109"></a>
<span class="sourceLineNo">110</span> final char[] userName, final char[] password, final Property[] properties, final String poolName)<a name="line.110"></a>
<span class="sourceLineNo">111</span> throws SQLException {<a name="line.111"></a>
<span class="sourceLineNo">112</span> super(driverClassName, connectionString, URL_PREFIX + poolName, userName, password, properties);<a name="line.112"></a>
<span class="sourceLineNo">113</span> this.poolName = poolName;<a name="line.113"></a>
<span class="sourceLineNo">114</span> setupDriver(connectionString, null);<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span> private PoolingDriverConnectionSource(final String driverClassName, final String connectionString,<a name="line.117"></a>
<span class="sourceLineNo">118</span> final char[] userName, final char[] password, final Property[] properties, final String poolName,<a name="line.118"></a>
<span class="sourceLineNo">119</span> final PoolableConnectionFactoryConfig poolableConnectionFactoryConfig)<a name="line.119"></a>
<span class="sourceLineNo">120</span> throws SQLException {<a name="line.120"></a>
<span class="sourceLineNo">121</span> super(driverClassName, connectionString, URL_PREFIX + poolName, userName, password, properties);<a name="line.121"></a>
<span class="sourceLineNo">122</span> this.poolName = poolName;<a name="line.122"></a>
<span class="sourceLineNo">123</span> setupDriver(connectionString, poolableConnectionFactoryConfig);<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> @Override<a name="line.126"></a>
<span class="sourceLineNo">127</span> public String getActualConnectionString() {<a name="line.127"></a>
<span class="sourceLineNo">128</span> // TODO Auto-generated method stub<a name="line.128"></a>
<span class="sourceLineNo">129</span> return super.getActualConnectionString();<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> private PoolingDriver getPoolingDriver() throws SQLException {<a name="line.132"></a>
<span class="sourceLineNo">133</span> final PoolingDriver driver = (PoolingDriver) DriverManager.getDriver(URL_PREFIX);<a name="line.133"></a>
<span class="sourceLineNo">134</span> if (driver == null) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> getLogger().error("No JDBC driver for '{}'", URL_PREFIX);<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span> return driver;<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> private void setupDriver(final String connectionString,<a name="line.140"></a>
<span class="sourceLineNo">141</span> final PoolableConnectionFactoryConfig poolableConnectionFactoryConfig) throws SQLException {<a name="line.141"></a>
<span class="sourceLineNo">142</span> //<a name="line.142"></a>
<span class="sourceLineNo">143</span> // First, we'll create a ConnectionFactory that the<a name="line.143"></a>
<span class="sourceLineNo">144</span> // pool will use to create Connections.<a name="line.144"></a>
<span class="sourceLineNo">145</span> // We'll use the DriverManagerConnectionFactory,<a name="line.145"></a>
<span class="sourceLineNo">146</span> // using the connect string passed in the command line<a name="line.146"></a>
<span class="sourceLineNo">147</span> // arguments.<a name="line.147"></a>
<span class="sourceLineNo">148</span> //<a name="line.148"></a>
<span class="sourceLineNo">149</span> final Property[] properties = getProperties();<a name="line.149"></a>
<span class="sourceLineNo">150</span> final char[] userName = getUserName();<a name="line.150"></a>
<span class="sourceLineNo">151</span> final char[] password = getPassword();<a name="line.151"></a>
<span class="sourceLineNo">152</span> final ConnectionFactory connectionFactory;<a name="line.152"></a>
<span class="sourceLineNo">153</span> if (properties != null &amp;&amp; properties.length &gt; 0) {<a name="line.153"></a>
<span class="sourceLineNo">154</span> if (userName != null || password != null) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> throw new SQLException("Either set the userName and password, or set the Properties, but not both.");<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span> connectionFactory = new DriverManagerConnectionFactory(connectionString, toProperties(properties));<a name="line.157"></a>
<span class="sourceLineNo">158</span> } else {<a name="line.158"></a>
<span class="sourceLineNo">159</span> connectionFactory = new DriverManagerConnectionFactory(connectionString, toString(userName), toString(password));<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> //<a name="line.162"></a>
<span class="sourceLineNo">163</span> // Next, we'll create the PoolableConnectionFactory, which wraps<a name="line.163"></a>
<span class="sourceLineNo">164</span> // the "real" Connections created by the ConnectionFactory with<a name="line.164"></a>
<span class="sourceLineNo">165</span> // the classes that implement the pooling functionality.<a name="line.165"></a>
<span class="sourceLineNo">166</span> //<a name="line.166"></a>
<span class="sourceLineNo">167</span> final PoolableConnectionFactory poolableConnectionFactory = new PoolableConnectionFactory(connectionFactory,<a name="line.167"></a>
<span class="sourceLineNo">168</span> null);<a name="line.168"></a>
<span class="sourceLineNo">169</span> if (poolableConnectionFactoryConfig != null) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> poolableConnectionFactoryConfig.init(poolableConnectionFactory);<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> //<a name="line.173"></a>
<span class="sourceLineNo">174</span> // Now we'll need a ObjectPool that serves as the<a name="line.174"></a>
<span class="sourceLineNo">175</span> // actual pool of connections.<a name="line.175"></a>
<span class="sourceLineNo">176</span> //<a name="line.176"></a>
<span class="sourceLineNo">177</span> // We'll use a GenericObjectPool instance, although<a name="line.177"></a>
<span class="sourceLineNo">178</span> // any ObjectPool implementation will suffice.<a name="line.178"></a>
<span class="sourceLineNo">179</span> //<a name="line.179"></a>
<span class="sourceLineNo">180</span> @SuppressWarnings("resource")<a name="line.180"></a>
<span class="sourceLineNo">181</span> // This GenericObjectPool will be closed on shutdown<a name="line.181"></a>
<span class="sourceLineNo">182</span> final ObjectPool&lt;PoolableConnection&gt; connectionPool = new GenericObjectPool&lt;&gt;(poolableConnectionFactory);<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> // Set the factory's pool property to the owning pool<a name="line.184"></a>
<span class="sourceLineNo">185</span> poolableConnectionFactory.setPool(connectionPool);<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> loadDriver(poolingDriverClassName);<a name="line.187"></a>
<span class="sourceLineNo">188</span> final PoolingDriver driver = getPoolingDriver();<a name="line.188"></a>
<span class="sourceLineNo">189</span> if (driver != null) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> getLogger().debug("Registering DBCP pool '{}' with pooling driver {}: {}", poolName, driver, connectionPool);<a name="line.190"></a>
<span class="sourceLineNo">191</span> driver.registerPool(poolName, connectionPool);<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span> //<a name="line.193"></a>
<span class="sourceLineNo">194</span> // Now we can just use the connect string "jdbc:apache:commons:dbcp:example"<a name="line.194"></a>
<span class="sourceLineNo">195</span> // to access our pool of Connections.<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><a name="line.198"></a>
<span class="sourceLineNo">199</span> @Override<a name="line.199"></a>
<span class="sourceLineNo">200</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.200"></a>
<span class="sourceLineNo">201</span> try {<a name="line.201"></a>
<span class="sourceLineNo">202</span> final PoolingDriver driver = getPoolingDriver();<a name="line.202"></a>
<span class="sourceLineNo">203</span> if (driver != null) {<a name="line.203"></a>
<span class="sourceLineNo">204</span> getLogger().debug("Driver {} closing DBCP pool '{}'", driver, poolName);<a name="line.204"></a>
<span class="sourceLineNo">205</span> driver.closePool(poolName);<a name="line.205"></a>
<span class="sourceLineNo">206</span> }<a name="line.206"></a>
<span class="sourceLineNo">207</span> return true;<a name="line.207"></a>
<span class="sourceLineNo">208</span> } catch (final Exception e) {<a name="line.208"></a>
<span class="sourceLineNo">209</span> getLogger().error("Exception stopping connection source for '{}' → '{}'", getConnectionString(),<a name="line.209"></a>
<span class="sourceLineNo">210</span> getActualConnectionString(), e);<a name="line.210"></a>
<span class="sourceLineNo">211</span> return false;<a name="line.211"></a>
<span class="sourceLineNo">212</span> }<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span>}<a name="line.214"></a>
</pre>
</div>
</body>
</html>