blob: c7e5165c7fc0419fa3e95421419545b605935846 [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.io.PrintWriter;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.lang.reflect.Method;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.sql.Connection;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.sql.SQLException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import javax.sql.DataSource;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.Logger;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Core;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.util.Loader;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.util.Strings;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * A {@link JdbcAppender} connection source that uses a public static factory method to obtain a {@link Connection} or<a name="line.35"></a>
<span class="sourceLineNo">036</span> * {@link DataSource}.<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>@Plugin(name = "ConnectionFactory", category = Core.CATEGORY_NAME, elementType = "connectionSource", printObject = true)<a name="line.38"></a>
<span class="sourceLineNo">039</span>public final class FactoryMethodConnectionSource extends AbstractConnectionSource {<a name="line.39"></a>
<span class="sourceLineNo">040</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private final DataSource dataSource;<a name="line.42"></a>
<span class="sourceLineNo">043</span> private final String description;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> private FactoryMethodConnectionSource(final DataSource dataSource, final String className, final String methodName,<a name="line.45"></a>
<span class="sourceLineNo">046</span> final String returnType) {<a name="line.46"></a>
<span class="sourceLineNo">047</span> this.dataSource = dataSource;<a name="line.47"></a>
<span class="sourceLineNo">048</span> this.description = "factory{ public static " + returnType + ' ' + className + '.' + methodName + "() }";<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> @Override<a name="line.51"></a>
<span class="sourceLineNo">052</span> public Connection getConnection() throws SQLException {<a name="line.52"></a>
<span class="sourceLineNo">053</span> return this.dataSource.getConnection();<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> @Override<a name="line.56"></a>
<span class="sourceLineNo">057</span> public String toString() {<a name="line.57"></a>
<span class="sourceLineNo">058</span> return this.description;<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> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Factory method for creating a connection source within the plugin manager.<a name="line.62"></a>
<span class="sourceLineNo">063</span> *<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param className The name of a public class that contains a static method capable of returning either a<a name="line.64"></a>
<span class="sourceLineNo">065</span> * {@link DataSource} or a {@link Connection}.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param methodName The name of the public static method on the aforementioned class that returns the data source<a name="line.66"></a>
<span class="sourceLineNo">067</span> * or connection. If this method returns a {@link Connection}, it should return a new connection<a name="line.67"></a>
<span class="sourceLineNo">068</span> * every call.<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @return the created connection source.<a name="line.69"></a>
<span class="sourceLineNo">070</span> */<a name="line.70"></a>
<span class="sourceLineNo">071</span> @PluginFactory<a name="line.71"></a>
<span class="sourceLineNo">072</span> public static FactoryMethodConnectionSource createConnectionSource(<a name="line.72"></a>
<span class="sourceLineNo">073</span> @PluginAttribute("class") final String className,<a name="line.73"></a>
<span class="sourceLineNo">074</span> @PluginAttribute("method") final String methodName) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> if (Strings.isEmpty(className) || Strings.isEmpty(methodName)) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> LOGGER.error("No class name or method name specified for the connection factory method.");<a name="line.76"></a>
<span class="sourceLineNo">077</span> return null;<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> final Method method;<a name="line.80"></a>
<span class="sourceLineNo">081</span> try {<a name="line.81"></a>
<span class="sourceLineNo">082</span> final Class&lt;?&gt; factoryClass = Loader.loadClass(className);<a name="line.82"></a>
<span class="sourceLineNo">083</span> method = factoryClass.getMethod(methodName);<a name="line.83"></a>
<span class="sourceLineNo">084</span> } catch (final Exception e) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> LOGGER.error(e.toString(), e);<a name="line.85"></a>
<span class="sourceLineNo">086</span> return null;<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> final Class&lt;?&gt; returnType = method.getReturnType();<a name="line.89"></a>
<span class="sourceLineNo">090</span> String returnTypeString = returnType.getName();<a name="line.90"></a>
<span class="sourceLineNo">091</span> DataSource dataSource;<a name="line.91"></a>
<span class="sourceLineNo">092</span> if (returnType == DataSource.class) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> try {<a name="line.93"></a>
<span class="sourceLineNo">094</span> dataSource = (DataSource) method.invoke(null);<a name="line.94"></a>
<span class="sourceLineNo">095</span> returnTypeString += "[" + dataSource + ']';<a name="line.95"></a>
<span class="sourceLineNo">096</span> } catch (final Exception e) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> LOGGER.error(e.toString(), e);<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> } else if (returnType == Connection.class) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> dataSource = new DataSource() {<a name="line.101"></a>
<span class="sourceLineNo">102</span> @Override<a name="line.102"></a>
<span class="sourceLineNo">103</span> public Connection getConnection() throws SQLException {<a name="line.103"></a>
<span class="sourceLineNo">104</span> try {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return (Connection) method.invoke(null);<a name="line.105"></a>
<span class="sourceLineNo">106</span> } catch (final Exception e) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> throw new SQLException("Failed to obtain connection from factory method.", e);<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><a name="line.110"></a>
<span class="sourceLineNo">111</span> @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span> public Connection getConnection(final String username, final String password) throws SQLException {<a name="line.112"></a>
<span class="sourceLineNo">113</span> throw new UnsupportedOperationException();<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> @Override<a name="line.116"></a>
<span class="sourceLineNo">117</span> public int getLoginTimeout() throws SQLException {<a name="line.117"></a>
<span class="sourceLineNo">118</span> throw new UnsupportedOperationException();<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> @Override<a name="line.121"></a>
<span class="sourceLineNo">122</span> public PrintWriter getLogWriter() throws SQLException {<a name="line.122"></a>
<span class="sourceLineNo">123</span> throw new UnsupportedOperationException();<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> @SuppressWarnings("unused")<a name="line.127"></a>
<span class="sourceLineNo">128</span> public java.util.logging.Logger getParentLogger() {<a name="line.128"></a>
<span class="sourceLineNo">129</span> throw new UnsupportedOperationException();<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> @Override<a name="line.132"></a>
<span class="sourceLineNo">133</span> public boolean isWrapperFor(final Class&lt;?&gt; iface) throws SQLException {<a name="line.133"></a>
<span class="sourceLineNo">134</span> return false;<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> @Override<a name="line.137"></a>
<span class="sourceLineNo">138</span> public void setLoginTimeout(final int seconds) throws SQLException {<a name="line.138"></a>
<span class="sourceLineNo">139</span> throw new UnsupportedOperationException();<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> @Override<a name="line.142"></a>
<span class="sourceLineNo">143</span> public void setLogWriter(final PrintWriter out) throws SQLException {<a name="line.143"></a>
<span class="sourceLineNo">144</span> throw new UnsupportedOperationException();<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> @Override<a name="line.147"></a>
<span class="sourceLineNo">148</span> public &lt;T&gt; T unwrap(final Class&lt;T&gt; iface) throws SQLException {<a name="line.148"></a>
<span class="sourceLineNo">149</span> return null;<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> };<a name="line.151"></a>
<span class="sourceLineNo">152</span> } else {<a name="line.152"></a>
<span class="sourceLineNo">153</span> LOGGER.error("Method [{}.{}()] returns unsupported type [{}].", className, methodName,<a name="line.153"></a>
<span class="sourceLineNo">154</span> returnType.getName());<a name="line.154"></a>
<span class="sourceLineNo">155</span> return null;<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> return new FactoryMethodConnectionSource(dataSource, className, methodName, returnTypeString);<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>
</pre>
</div>
</body>
</html>