Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.2 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / appender / AbstractManager.html
blob: 803738cca02cfa4a40f698c3d26c811d8bb1811b [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;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.HashMap;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Map;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.concurrent.TimeUnit;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.locks.Lock;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.locks.ReentrantLock;<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.Level;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.Logger;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.AbstractLifeCycle;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.LoggerContext;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.ConfigurationException;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.message.Message;<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><a name="line.32"></a>
<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * Abstract base class used to register managers.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * This class implements {@link AutoCloseable} mostly to allow unit tests to be written safely and succinctly. While<a name="line.36"></a>
<span class="sourceLineNo">037</span> * managers do need to allocate resources (usually on construction) and then free these resources, a manager is longer<a name="line.37"></a>
<span class="sourceLineNo">038</span> * lived than other auto-closeable objects like streams. None the less, making a manager AutoCloseable forces readers to<a name="line.38"></a>
<span class="sourceLineNo">039</span> * be aware of the the pattern: allocate resources on construction and call {@link #close()} at some point.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;/p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span>public abstract class AbstractManager implements AutoCloseable {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Allow subclasses access to the status logger without creating another instance.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> protected static final Logger LOGGER = StatusLogger.getLogger();<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> // Need to lock that map instead of using a ConcurrentMap due to stop removing the<a name="line.49"></a>
<span class="sourceLineNo">050</span> // manager from the map and closing the stream, requiring the whole stop method to be locked.<a name="line.50"></a>
<span class="sourceLineNo">051</span> private static final Map&lt;String, AbstractManager&gt; MAP = new HashMap&lt;&gt;();<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> private static final Lock LOCK = new ReentrantLock();<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> * Number of Appenders using this manager.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> protected int count;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> private final String name;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> private final LoggerContext loggerContext;<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> protected AbstractManager(final LoggerContext loggerContext, final String name) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> this.loggerContext = loggerContext;<a name="line.65"></a>
<span class="sourceLineNo">066</span> this.name = name;<a name="line.66"></a>
<span class="sourceLineNo">067</span> LOGGER.debug("Starting {} {}", this.getClass().getSimpleName(), name);<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
<span class="sourceLineNo">071</span> * Called to signify that this Manager is no longer required by an Appender.<a name="line.71"></a>
<span class="sourceLineNo">072</span> */<a name="line.72"></a>
<span class="sourceLineNo">073</span> @Override<a name="line.73"></a>
<span class="sourceLineNo">074</span> public void close() {<a name="line.74"></a>
<span class="sourceLineNo">075</span> stop(AbstractLifeCycle.DEFAULT_STOP_TIMEOUT, AbstractLifeCycle.DEFAULT_STOP_TIMEUNIT);<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> boolean stopped = true;<a name="line.79"></a>
<span class="sourceLineNo">080</span> LOCK.lock();<a name="line.80"></a>
<span class="sourceLineNo">081</span> try {<a name="line.81"></a>
<span class="sourceLineNo">082</span> --count;<a name="line.82"></a>
<span class="sourceLineNo">083</span> if (count &lt;= 0) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> MAP.remove(name);<a name="line.84"></a>
<span class="sourceLineNo">085</span> LOGGER.debug("Shutting down {} {}", this.getClass().getSimpleName(), getName());<a name="line.85"></a>
<span class="sourceLineNo">086</span> stopped = releaseSub(timeout, timeUnit);<a name="line.86"></a>
<span class="sourceLineNo">087</span> LOGGER.debug("Shut down {} {}, all resources released: {}", this.getClass().getSimpleName(), getName(), stopped);<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span> } finally {<a name="line.89"></a>
<span class="sourceLineNo">090</span> LOCK.unlock();<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span> return stopped;<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> /**<a name="line.95"></a>
<span class="sourceLineNo">096</span> * Retrieves a Manager if it has been previously created or creates a new Manager.<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @param name The name of the Manager to retrieve.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @param factory The Factory to use to create the Manager.<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @param data An Object that should be passed to the factory when creating the Manager.<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @param &lt;M&gt; The Type of the Manager to be created.<a name="line.100"></a>
<span class="sourceLineNo">101</span> * @param &lt;T&gt; The type of the Factory data.<a name="line.101"></a>
<span class="sourceLineNo">102</span> * @return A Manager with the specified name and type.<a name="line.102"></a>
<span class="sourceLineNo">103</span> */<a name="line.103"></a>
<span class="sourceLineNo">104</span> // @SuppressWarnings("resource"): this is a factory method, the resource is allocated and released elsewhere.<a name="line.104"></a>
<span class="sourceLineNo">105</span> @SuppressWarnings("resource")<a name="line.105"></a>
<span class="sourceLineNo">106</span> public static &lt;M extends AbstractManager, T&gt; M getManager(final String name, final ManagerFactory&lt;M, T&gt; factory,<a name="line.106"></a>
<span class="sourceLineNo">107</span> final T data) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> LOCK.lock();<a name="line.108"></a>
<span class="sourceLineNo">109</span> try {<a name="line.109"></a>
<span class="sourceLineNo">110</span> @SuppressWarnings("unchecked")<a name="line.110"></a>
<span class="sourceLineNo">111</span> M manager = (M) MAP.get(name);<a name="line.111"></a>
<span class="sourceLineNo">112</span> if (manager == null) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> manager = factory.createManager(name, data);<a name="line.113"></a>
<span class="sourceLineNo">114</span> if (manager == null) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> throw new IllegalStateException("ManagerFactory [" + factory + "] unable to create manager for ["<a name="line.115"></a>
<span class="sourceLineNo">116</span> + name + "] with data [" + data + "]");<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> MAP.put(name, manager);<a name="line.118"></a>
<span class="sourceLineNo">119</span> } else {<a name="line.119"></a>
<span class="sourceLineNo">120</span> manager.updateData(data);<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span> manager.count++;<a name="line.122"></a>
<span class="sourceLineNo">123</span> return manager;<a name="line.123"></a>
<span class="sourceLineNo">124</span> } finally {<a name="line.124"></a>
<span class="sourceLineNo">125</span> LOCK.unlock();<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * Used by Log4j to update the Manager during reconfiguration. This method should be considered private.<a name="line.130"></a>
<span class="sourceLineNo">131</span> * Implementations may not be thread safe. This method may be made protected in a future release.<a name="line.131"></a>
<span class="sourceLineNo">132</span> * @param data The data to update.<a name="line.132"></a>
<span class="sourceLineNo">133</span> */<a name="line.133"></a>
<span class="sourceLineNo">134</span> public void updateData(final Object data) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> // This default implementation does nothing.<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span> /**<a name="line.138"></a>
<span class="sourceLineNo">139</span> * Determines if a Manager with the specified name exists.<a name="line.139"></a>
<span class="sourceLineNo">140</span> * @param name The name of the Manager.<a name="line.140"></a>
<span class="sourceLineNo">141</span> * @return True if the Manager exists, false otherwise.<a name="line.141"></a>
<span class="sourceLineNo">142</span> */<a name="line.142"></a>
<span class="sourceLineNo">143</span> public static boolean hasManager(final String name) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> LOCK.lock();<a name="line.144"></a>
<span class="sourceLineNo">145</span> try {<a name="line.145"></a>
<span class="sourceLineNo">146</span> return MAP.containsKey(name);<a name="line.146"></a>
<span class="sourceLineNo">147</span> } finally {<a name="line.147"></a>
<span class="sourceLineNo">148</span> LOCK.unlock();<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><a name="line.151"></a>
<span class="sourceLineNo">152</span> /**<a name="line.152"></a>
<span class="sourceLineNo">153</span> * Returns the specified manager, cast to the specified narrow type.<a name="line.153"></a>
<span class="sourceLineNo">154</span> * @param narrowClass the type to cast to<a name="line.154"></a>
<span class="sourceLineNo">155</span> * @param manager the manager object to return<a name="line.155"></a>
<span class="sourceLineNo">156</span> * @param &lt;M&gt; the narrow type<a name="line.156"></a>
<span class="sourceLineNo">157</span> * @return the specified manager, cast to the specified narrow type<a name="line.157"></a>
<span class="sourceLineNo">158</span> * @throws ConfigurationException if the manager cannot be cast to the specified type, which only happens when<a name="line.158"></a>
<span class="sourceLineNo">159</span> * the configuration has multiple incompatible appenders pointing to the same resource<a name="line.159"></a>
<span class="sourceLineNo">160</span> * @since 2.9<a name="line.160"></a>
<span class="sourceLineNo">161</span> * @see &lt;a href="https://issues.apache.org/jira/browse/LOG4J2-1908"&gt;LOG4J2-1908&lt;/a&gt;<a name="line.161"></a>
<span class="sourceLineNo">162</span> */<a name="line.162"></a>
<span class="sourceLineNo">163</span> protected static &lt;M extends AbstractManager&gt; M narrow(final Class&lt;M&gt; narrowClass, final AbstractManager manager) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> if (narrowClass.isAssignableFrom(manager.getClass())) {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return (M) manager;<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span> throw new ConfigurationException(<a name="line.167"></a>
<span class="sourceLineNo">168</span> "Configuration has multiple incompatible Appenders pointing to the same resource '" +<a name="line.168"></a>
<span class="sourceLineNo">169</span> manager.getName() + "'");<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> protected static StatusLogger logger() {<a name="line.172"></a>
<span class="sourceLineNo">173</span> return StatusLogger.getLogger();<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<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>
<span class="sourceLineNo">177</span> * May be overridden by managers to perform processing while the manager is being released and the<a name="line.177"></a>
<span class="sourceLineNo">178</span> * lock is held. A timeout is passed for implementors to use as they see fit.<a name="line.178"></a>
<span class="sourceLineNo">179</span> * @param timeout timeout<a name="line.179"></a>
<span class="sourceLineNo">180</span> * @param timeUnit timeout time unit<a name="line.180"></a>
<span class="sourceLineNo">181</span> * @return true if all resources were closed normally, false otherwise.<a name="line.181"></a>
<span class="sourceLineNo">182</span> */<a name="line.182"></a>
<span class="sourceLineNo">183</span> protected boolean releaseSub(final long timeout, final TimeUnit timeUnit) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> // This default implementation does nothing.<a name="line.184"></a>
<span class="sourceLineNo">185</span> return true;<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> protected int getCount() {<a name="line.188"></a>
<span class="sourceLineNo">189</span> return count;<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> /**<a name="line.192"></a>
<span class="sourceLineNo">193</span> * Gets the logger context used to create this instance or null. The logger context is usually set when an appender<a name="line.193"></a>
<span class="sourceLineNo">194</span> * creates a manager and that appender is given a Configuration. Not all appenders are given a Configuration by<a name="line.194"></a>
<span class="sourceLineNo">195</span> * their factory method or builder.<a name="line.195"></a>
<span class="sourceLineNo">196</span> *<a name="line.196"></a>
<span class="sourceLineNo">197</span> * @return the logger context used to create this instance or null.<a name="line.197"></a>
<span class="sourceLineNo">198</span> */<a name="line.198"></a>
<span class="sourceLineNo">199</span> public LoggerContext getLoggerContext() {<a name="line.199"></a>
<span class="sourceLineNo">200</span> return loggerContext;<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span> /**<a name="line.203"></a>
<span class="sourceLineNo">204</span> * Called to signify that this Manager is no longer required by an Appender.<a name="line.204"></a>
<span class="sourceLineNo">205</span> * @deprecated In 2.7, use {@link #close()}.<a name="line.205"></a>
<span class="sourceLineNo">206</span> */<a name="line.206"></a>
<span class="sourceLineNo">207</span> @Deprecated<a name="line.207"></a>
<span class="sourceLineNo">208</span> public void release() {<a name="line.208"></a>
<span class="sourceLineNo">209</span> close();<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span> /**<a name="line.212"></a>
<span class="sourceLineNo">213</span> * Returns the name of the Manager.<a name="line.213"></a>
<span class="sourceLineNo">214</span> * @return The name of the Manager.<a name="line.214"></a>
<span class="sourceLineNo">215</span> */<a name="line.215"></a>
<span class="sourceLineNo">216</span> public String getName() {<a name="line.216"></a>
<span class="sourceLineNo">217</span> return name;<a name="line.217"></a>
<span class="sourceLineNo">218</span> }<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span> /**<a name="line.220"></a>
<span class="sourceLineNo">221</span> * Provide a description of the content format supported by this Manager. Default implementation returns an empty<a name="line.221"></a>
<span class="sourceLineNo">222</span> * (unspecified) Map.<a name="line.222"></a>
<span class="sourceLineNo">223</span> *<a name="line.223"></a>
<span class="sourceLineNo">224</span> * @return a Map of key/value pairs describing the Manager-specific content format, or an empty Map if no content<a name="line.224"></a>
<span class="sourceLineNo">225</span> * format descriptors are specified.<a name="line.225"></a>
<span class="sourceLineNo">226</span> */<a name="line.226"></a>
<span class="sourceLineNo">227</span> public Map&lt;String, String&gt; getContentFormat() {<a name="line.227"></a>
<span class="sourceLineNo">228</span> return new HashMap&lt;&gt;();<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
<span class="sourceLineNo">231</span> protected void log(final Level level, final String message, final Throwable throwable) {<a name="line.231"></a>
<span class="sourceLineNo">232</span> final Message m = LOGGER.getMessageFactory().newMessage("{} {} {}: {}",<a name="line.232"></a>
<span class="sourceLineNo">233</span> getClass().getSimpleName(), getName(), message, throwable);<a name="line.233"></a>
<span class="sourceLineNo">234</span> LOGGER.log(level, m, throwable);<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span><a name="line.236"></a>
<span class="sourceLineNo">237</span> protected void logDebug(final String message, final Throwable throwable) {<a name="line.237"></a>
<span class="sourceLineNo">238</span> log(Level.DEBUG, message, throwable);<a name="line.238"></a>
<span class="sourceLineNo">239</span> }<a name="line.239"></a>
<span class="sourceLineNo">240</span><a name="line.240"></a>
<span class="sourceLineNo">241</span> protected void logError(final String message, final Throwable throwable) {<a name="line.241"></a>
<span class="sourceLineNo">242</span> log(Level.ERROR, message, throwable);<a name="line.242"></a>
<span class="sourceLineNo">243</span> }<a name="line.243"></a>
<span class="sourceLineNo">244</span><a name="line.244"></a>
<span class="sourceLineNo">245</span> protected void logWarn(final String message, final Throwable throwable) {<a name="line.245"></a>
<span class="sourceLineNo">246</span> log(Level.WARN, message, throwable);<a name="line.246"></a>
<span class="sourceLineNo">247</span> }<a name="line.247"></a>
<span class="sourceLineNo">248</span><a name="line.248"></a>
<span class="sourceLineNo">249</span>}<a name="line.249"></a>
</pre>
</div>
</body>
</html>