Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / async / AsyncQueueFullPolicyFactory.html
blob: 312d2a855aa10a94bf1549adb8212e309083b508 [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.async;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.logging.log4j.Level;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.logging.log4j.Logger;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.logging.log4j.core.util.Loader;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Creates {@link AsyncQueueFullPolicy} instances based on user-specified system properties. The {@code AsyncQueueFullPolicy}<a name="line.26"></a>
<span class="sourceLineNo">027</span> * created by this factory is used in AsyncLogger, AsyncLoggerConfig and AsyncAppender<a name="line.27"></a>
<span class="sourceLineNo">028</span> * to control if events are logged in the current thread, the background thread, or discarded.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Property {@code "log4j2.AsyncQueueFullPolicy"} controls the routing behaviour. If this property is not specified or has<a name="line.30"></a>
<span class="sourceLineNo">031</span> * value {@code "Default"}, this factory creates {@link DefaultAsyncQueueFullPolicy} objects.<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;/p&gt; &lt;p&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> * If this property has value {@code "Discard"}, this factory creates {@link DiscardingAsyncQueueFullPolicy} objects.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * By default, this router discards events of level {@code INFO}, {@code DEBUG} and {@code TRACE} if the queue is full.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * This can be adjusted with property {@code "log4j2.DiscardThreshold"} (name of the level at which to start<a name="line.35"></a>
<span class="sourceLineNo">036</span> * discarding).<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;/p&gt; &lt;p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> * For any other value, this<a name="line.38"></a>
<span class="sourceLineNo">039</span> * factory interprets the value as the fully qualified name of a class implementing the {@link AsyncQueueFullPolicy}<a name="line.39"></a>
<span class="sourceLineNo">040</span> * interface. The class must have a default constructor.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;/p&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @since 2.6<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>public class AsyncQueueFullPolicyFactory {<a name="line.45"></a>
<span class="sourceLineNo">046</span> static final String PROPERTY_NAME_ASYNC_EVENT_ROUTER = "log4j2.AsyncQueueFullPolicy";<a name="line.46"></a>
<span class="sourceLineNo">047</span> static final String PROPERTY_VALUE_DEFAULT_ASYNC_EVENT_ROUTER = "Default";<a name="line.47"></a>
<span class="sourceLineNo">048</span> static final String PROPERTY_VALUE_DISCARDING_ASYNC_EVENT_ROUTER = "Discard";<a name="line.48"></a>
<span class="sourceLineNo">049</span> static final String PROPERTY_NAME_DISCARDING_THRESHOLD_LEVEL = "log4j2.DiscardThreshold";<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> /**<a name="line.53"></a>
<span class="sourceLineNo">054</span> * Creates and returns {@link AsyncQueueFullPolicy} instances based on user-specified system properties.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;p&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Property {@code "log4j2.AsyncQueueFullPolicy"} controls the routing behaviour. If this property is not specified or<a name="line.56"></a>
<span class="sourceLineNo">057</span> * has value {@code "Default"}, this method returns {@link DefaultAsyncQueueFullPolicy} objects.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;/p&gt; &lt;p&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> * If this property has value {@code "Discard"}, this method returns {@link DiscardingAsyncQueueFullPolicy} objects.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;/p&gt; &lt;p&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * For any other value, this method interprets the value as the fully qualified name of a class implementing the<a name="line.61"></a>
<span class="sourceLineNo">062</span> * {@link AsyncQueueFullPolicy} interface. The class must have a default constructor.<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &lt;/p&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> *<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @return a new AsyncQueueFullPolicy<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> public static AsyncQueueFullPolicy create() {<a name="line.67"></a>
<span class="sourceLineNo">068</span> final String router = PropertiesUtil.getProperties().getStringProperty(PROPERTY_NAME_ASYNC_EVENT_ROUTER);<a name="line.68"></a>
<span class="sourceLineNo">069</span> if (router == null || isRouterSelected(<a name="line.69"></a>
<span class="sourceLineNo">070</span> router, DefaultAsyncQueueFullPolicy.class, PROPERTY_VALUE_DEFAULT_ASYNC_EVENT_ROUTER)) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> return new DefaultAsyncQueueFullPolicy();<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span> if (isRouterSelected(<a name="line.73"></a>
<span class="sourceLineNo">074</span> router, DiscardingAsyncQueueFullPolicy.class, PROPERTY_VALUE_DISCARDING_ASYNC_EVENT_ROUTER)) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> return createDiscardingAsyncQueueFullPolicy();<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span> return createCustomRouter(router);<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> private static boolean isRouterSelected(<a name="line.80"></a>
<span class="sourceLineNo">081</span> String propertyValue,<a name="line.81"></a>
<span class="sourceLineNo">082</span> Class&lt;? extends AsyncQueueFullPolicy&gt; policy,<a name="line.82"></a>
<span class="sourceLineNo">083</span> String shortPropertyValue) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return propertyValue != null &amp;&amp; (shortPropertyValue.equalsIgnoreCase(propertyValue)<a name="line.84"></a>
<span class="sourceLineNo">085</span> || policy.getName().equals(propertyValue)<a name="line.85"></a>
<span class="sourceLineNo">086</span> || policy.getSimpleName().equals(propertyValue));<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> private static AsyncQueueFullPolicy createCustomRouter(final String router) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> try {<a name="line.90"></a>
<span class="sourceLineNo">091</span> final Class&lt;? extends AsyncQueueFullPolicy&gt; cls = Loader.loadClass(router).asSubclass(AsyncQueueFullPolicy.class);<a name="line.91"></a>
<span class="sourceLineNo">092</span> LOGGER.debug("Creating custom AsyncQueueFullPolicy '{}'", router);<a name="line.92"></a>
<span class="sourceLineNo">093</span> return cls.newInstance();<a name="line.93"></a>
<span class="sourceLineNo">094</span> } catch (final Exception ex) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> LOGGER.debug("Using DefaultAsyncQueueFullPolicy. Could not create custom AsyncQueueFullPolicy '{}': {}", router,<a name="line.95"></a>
<span class="sourceLineNo">096</span> ex.toString());<a name="line.96"></a>
<span class="sourceLineNo">097</span> return new DefaultAsyncQueueFullPolicy();<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><a name="line.100"></a>
<span class="sourceLineNo">101</span> private static AsyncQueueFullPolicy createDiscardingAsyncQueueFullPolicy() {<a name="line.101"></a>
<span class="sourceLineNo">102</span> final PropertiesUtil util = PropertiesUtil.getProperties();<a name="line.102"></a>
<span class="sourceLineNo">103</span> final String level = util.getStringProperty(PROPERTY_NAME_DISCARDING_THRESHOLD_LEVEL, Level.INFO.name());<a name="line.103"></a>
<span class="sourceLineNo">104</span> final Level thresholdLevel = Level.toLevel(level, Level.INFO);<a name="line.104"></a>
<span class="sourceLineNo">105</span> LOGGER.debug("Creating custom DiscardingAsyncQueueFullPolicy(discardThreshold:{})", thresholdLevel);<a name="line.105"></a>
<span class="sourceLineNo">106</span> return new DiscardingAsyncQueueFullPolicy(thresholdLevel);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span>}<a name="line.108"></a>
</pre>
</div>
</body>
</html>