| <!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.nosql;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.Serializable;<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.core.Appender;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.Filter;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.Layout;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.appender.AbstractAppender;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.appender.db.AbstractDatabaseAppender;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.Property;<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.PluginBuilderAttribute;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<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.util.Booleans;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span>/**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * This Appender writes logging events to a NoSQL database using a configured NoSQL provider. It requires<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * implementations of {@link NoSqlObject}, {@link NoSqlConnection}, and {@link NoSqlProvider} to "know" how to write<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * events to the chosen NoSQL database.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <p><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * For examples on how to write your own NoSQL provider, see the simple source code for the MongoDB and CouchDB<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * providers.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * </p><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @see NoSqlObject<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @see NoSqlConnection<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @see NoSqlProvider<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>@Plugin(name = "NoSql", category = "Core", elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>public final class NoSqlAppender extends AbstractDatabaseAppender<NoSqlDatabaseManager<?>> {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> /**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * Builds ConsoleAppender instances.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> *<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * @param <B><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * The type to build<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> public static class Builder<B extends Builder<B>> extends AbstractAppender.Builder<B><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> implements org.apache.logging.log4j.core.util.Builder<NoSqlAppender> {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> @PluginBuilderAttribute("bufferSize")<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private int bufferSize;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> @PluginElement("NoSqlProvider")<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> private NoSqlProvider<?> provider;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> @SuppressWarnings("resource")<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> @Override<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> public NoSqlAppender build() {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> final String name = getName();<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> if (provider == null) {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> LOGGER.error("NoSQL provider not specified for appender [{}].", name);<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> return null;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> }<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> final String managerName = "noSqlManager{ description=" + name + ", bufferSize=" + bufferSize<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> + ", provider=" + provider + " }";<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> final NoSqlDatabaseManager<?> manager = NoSqlDatabaseManager.getNoSqlDatabaseManager(managerName,<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> bufferSize, provider);<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> if (manager == null) {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> return null;<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> return new NoSqlAppender(name, getFilter(), getLayout(), isIgnoreExceptions(), getPropertyArray(), manager);<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> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * Sets the buffer size.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> *<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @param bufferSize<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * If an integer greater than 0, this causes the appender to buffer log events and flush whenever the<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * buffer reaches this size.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @return this<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> public B setBufferSize(final int bufferSize) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> this.bufferSize = bufferSize;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return asBuilder();<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> /**<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * Sets the provider.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> *<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param provider<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * The NoSQL provider that provides connections to the chosen NoSQL database.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @return this<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public B setProvider(final NoSqlProvider<?> provider) {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> this.provider = provider;<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><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> /**<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * Factory method for creating a NoSQL appender within the plugin manager.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> *<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @param name<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * The name of the appender.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param ignore<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise they<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * are propagated to the caller.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param filter<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * The filter, if any, to use.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @param bufferSize<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * If an integer greater than 0, this causes the appender to buffer log events and flush whenever the<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * buffer reaches this size.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @param provider<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * The NoSQL provider that provides connections to the chosen NoSQL database.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * @return a new NoSQL appender.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * @deprecated since 2.11.0; use {@link Builder}.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> */<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> @SuppressWarnings("resource")<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> @Deprecated<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public static NoSqlAppender createAppender(<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> // @formatter:off<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> final String name,<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> final String ignore,<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> final Filter filter,<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> final String bufferSize,<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> final NoSqlProvider<?> provider) {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> // @formatter:on<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> if (provider == null) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> LOGGER.error("NoSQL provider not specified for appender [{}].", name);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> return null;<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 bufferSizeInt = AbstractAppender.parseInt(bufferSize, 0);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> final String managerName = "noSqlManager{ description=" + name + ", bufferSize=" + bufferSizeInt + ", provider="<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> + provider + " }";<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> final NoSqlDatabaseManager<?> manager = NoSqlDatabaseManager.getNoSqlDatabaseManager(managerName, bufferSizeInt,<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> provider);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> if (manager == null) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> return null;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> return new NoSqlAppender(name, filter, null, ignoreExceptions, null, manager);<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> @PluginBuilderFactory<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> public static <B extends Builder<B>> B newBuilder() {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> return new Builder<B>().asBuilder();<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> private final String description;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> private NoSqlAppender(final String name, final Filter filter, final Layout<? extends Serializable> layout,<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> final boolean ignoreExceptions, final Property[] properties, final NoSqlDatabaseManager<?> manager) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> super(name, filter, layout, ignoreExceptions, properties, manager);<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> this.description = this.getName() + "{ manager=" + this.getManager() + " }";<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> @Override<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> public String toString() {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> return this.description;<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span>}<a name="line.176"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
