| <!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.couchdb;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.lang.reflect.Method;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.Logger;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.config.plugins.convert.TypeConverters;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.plugins.validation.constraints.ValidHost;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.validation.constraints.ValidPort;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.util.NameUtil;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.appender.nosql.NoSqlProvider;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.util.LoaderUtil;<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>import org.lightcouch.CouchDbClient;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.lightcouch.CouchDbProperties;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span>/**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * The Apache CouchDB implementation of {@link NoSqlProvider}.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>@Plugin(name = "CouchDB", category = "Core", printObject = true)<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>public final class CouchDbProvider implements NoSqlProvider<CouchDbConnection> {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> private static final int HTTP = 80;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private static final int HTTPS = 443;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> private final CouchDbClient client;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> private final String description;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> private CouchDbProvider(final CouchDbClient client, final String description) {<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> this.client = client;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> this.description = "couchDb{ " + description + " }";<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> }<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> @Override<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public CouchDbConnection getConnection() {<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> return new CouchDbConnection(this.client);<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> }<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> @Override<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> public String toString() {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> return this.description;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> /**<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * Factory method for creating an Apache CouchDB provider within the plugin manager.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> *<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param databaseName The name of the database to which log event documents will be written.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @param protocol Either "http" or "https," defaults to "http" and mutually exclusive with<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * {@code factoryClassName&factoryMethodName!=null}.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @param server The host name of the CouchDB server, defaults to localhost and mutually exclusive with<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * {@code factoryClassName&factoryMethodName!=null}.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @param port The port that CouchDB is listening on, defaults to 80 if {@code protocol} is "http" and 443 if<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * {@code protocol} is "https," and mutually exclusive with<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * {@code factoryClassName&factoryMethodName!=null}.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @param username The username to authenticate against the MongoDB server with, mutually exclusive with<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * {@code factoryClassName&factoryMethodName!=null}.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param password The password to authenticate against the MongoDB server with, mutually exclusive with<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * {@code factoryClassName&factoryMethodName!=null}.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param factoryClassName A fully qualified class name containing a static factory method capable of returning a<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * {@link CouchDbClient} or {@link CouchDbProperties}.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @param factoryMethodName The name of the public static factory method belonging to the aforementioned factory<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * class.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @return a new Apache CouchDB provider.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> @PluginFactory<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> public static CouchDbProvider createNoSqlProvider(<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> @PluginAttribute("databaseName") final String databaseName,<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> @PluginAttribute("protocol") String protocol,<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> @PluginAttribute(value = "server", defaultString = "localhost") @ValidHost final String server,<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> @PluginAttribute(value = "port", defaultString = "0") @ValidPort final String port,<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> @PluginAttribute("username") final String username,<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> @PluginAttribute(value = "password", sensitive = true) final String password,<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> @PluginAttribute("factoryClassName") final String factoryClassName,<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> @PluginAttribute("factoryMethodName") final String factoryMethodName) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> CouchDbClient client;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> String description;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> if (Strings.isNotEmpty(factoryClassName) && Strings.isNotEmpty(factoryMethodName)) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> try {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> final Class<?> factoryClass = LoaderUtil.loadClass(factoryClassName);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> final Method method = factoryClass.getMethod(factoryMethodName);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> final Object object = method.invoke(null);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> if (object instanceof CouchDbClient) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> client = (CouchDbClient) object;<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> description = "uri=" + client.getDBUri();<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> } else if (object instanceof CouchDbProperties) {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> final CouchDbProperties properties = (CouchDbProperties) object;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> client = new CouchDbClient(properties);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> description = "uri=" + client.getDBUri() + ", username=" + properties.getUsername()<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> + ", passwordHash=" + NameUtil.md5(password + CouchDbProvider.class.getName())<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> + ", maxConnections=" + properties.getMaxConnections() + ", connectionTimeout="<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> + properties.getConnectionTimeout() + ", socketTimeout=" + properties.getSocketTimeout();<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> } else if (object == null) {<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> LOGGER.error("The factory method [{}.{}()] returned null.", factoryClassName, factoryMethodName);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> return null;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> } else {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> LOGGER.error("The factory method [{}.{}()] returned an unsupported type [{}].", factoryClassName,<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> factoryMethodName, object.getClass().getName());<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> return null;<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> } catch (final ClassNotFoundException e) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> LOGGER.error("The factory class [{}] could not be loaded.", factoryClassName, e);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> return null;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> } catch (final NoSuchMethodException e) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> LOGGER.error("The factory class [{}] does not have a no-arg method named [{}].", factoryClassName,<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> factoryMethodName, e);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> return null;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> } catch (final Exception e) {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> LOGGER.error("The factory method [{}.{}()] could not be invoked.", factoryClassName, factoryMethodName,<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> e);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> return null;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> }<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> } else if (Strings.isNotEmpty(databaseName)) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> if (protocol != null && protocol.length() > 0) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> protocol = protocol.toLowerCase();<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> if (!protocol.equals("http") && !protocol.equals("https")) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> LOGGER.error("Only protocols [http] and [https] are supported, [{}] specified.", protocol);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> return null;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> } else {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> protocol = "http";<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> LOGGER.warn("No protocol specified, using default port [http].");<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> final int portInt = TypeConverters.convert(port, int.class, protocol.equals("https") ? HTTPS : HTTP);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> if (Strings.isEmpty(username) || Strings.isEmpty(password)) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> LOGGER.error("You must provide a username and password for the CouchDB provider.");<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> return null;<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> client = new CouchDbClient(databaseName, false, protocol, server, portInt, username, password);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> description = "uri=" + client.getDBUri() + ", username=" + username + ", passwordHash="<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> + NameUtil.md5(password + CouchDbProvider.class.getName());<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> } else {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> LOGGER.error("No factory method was provided so the database name is required.");<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> return null;<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> }<a name="line.157"></a> |
| <span class="sourceLineNo">158</span><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> return new CouchDbProvider(client, description);<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
