blob: 3084c7cea7c88ded5d447efd83173b99be7042dc [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.logging.log4j.core.appender;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import org.apache.logging.log4j.Logger;<a name="line.19"></a>
<FONT color="green">020</FONT> import org.apache.logging.log4j.status.StatusLogger;<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> import java.util.HashMap;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.Map;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.concurrent.locks.Lock;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.util.concurrent.locks.ReentrantLock;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * Base class used to register managers.<a name="line.28"></a>
<FONT color="green">029</FONT> */<a name="line.29"></a>
<FONT color="green">030</FONT> public abstract class AbstractManager {<a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> /**<a name="line.32"></a>
<FONT color="green">033</FONT> * Allow subclasses access to the status logger without creating another instance.<a name="line.33"></a>
<FONT color="green">034</FONT> */<a name="line.34"></a>
<FONT color="green">035</FONT> protected static final Logger LOGGER = StatusLogger.getLogger();<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> // Need to lock that map instead of using a ConcurrentMap due to stop removing the<a name="line.37"></a>
<FONT color="green">038</FONT> // manager from the map and closing the stream, requiring the whole stop method to be locked.<a name="line.38"></a>
<FONT color="green">039</FONT> private static Map&lt;String, AbstractManager&gt; map = new HashMap&lt;String, AbstractManager&gt;();<a name="line.39"></a>
<FONT color="green">040</FONT> <a name="line.40"></a>
<FONT color="green">041</FONT> private static Lock lock = new ReentrantLock();<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> private String name;<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> private int count;<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> protected AbstractManager(String name) {<a name="line.47"></a>
<FONT color="green">048</FONT> this.name = name;<a name="line.48"></a>
<FONT color="green">049</FONT> }<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> /**<a name="line.52"></a>
<FONT color="green">053</FONT> * Retrieves a Manager if it has been previously created or creates a new Manager.<a name="line.53"></a>
<FONT color="green">054</FONT> * @param name The name of the Manager to retrieve.<a name="line.54"></a>
<FONT color="green">055</FONT> * @param factory The Factory to use to create the Manager.<a name="line.55"></a>
<FONT color="green">056</FONT> * @param data An Object that should be passed to the factory when creating the Manager.<a name="line.56"></a>
<FONT color="green">057</FONT> * @param &lt;T&gt; The Type of the Manager to be created.<a name="line.57"></a>
<FONT color="green">058</FONT> * @return A Manager with the specified name and type.<a name="line.58"></a>
<FONT color="green">059</FONT> */<a name="line.59"></a>
<FONT color="green">060</FONT> public static &lt;T extends AbstractManager&gt; T getManager(String name, ManagerFactory&lt;T, Object&gt; factory,<a name="line.60"></a>
<FONT color="green">061</FONT> Object data) {<a name="line.61"></a>
<FONT color="green">062</FONT> lock.lock();<a name="line.62"></a>
<FONT color="green">063</FONT> try {<a name="line.63"></a>
<FONT color="green">064</FONT> T manager = (T) map.get(name);<a name="line.64"></a>
<FONT color="green">065</FONT> if (manager == null) {<a name="line.65"></a>
<FONT color="green">066</FONT> manager = factory.createManager(name, data);<a name="line.66"></a>
<FONT color="green">067</FONT> if (manager == null) {<a name="line.67"></a>
<FONT color="green">068</FONT> throw new IllegalStateException("Unable to create a manager");<a name="line.68"></a>
<FONT color="green">069</FONT> }<a name="line.69"></a>
<FONT color="green">070</FONT> map.put(name, manager);<a name="line.70"></a>
<FONT color="green">071</FONT> }<a name="line.71"></a>
<FONT color="green">072</FONT> manager.count++;<a name="line.72"></a>
<FONT color="green">073</FONT> return manager;<a name="line.73"></a>
<FONT color="green">074</FONT> } finally {<a name="line.74"></a>
<FONT color="green">075</FONT> lock.unlock();<a name="line.75"></a>
<FONT color="green">076</FONT> }<a name="line.76"></a>
<FONT color="green">077</FONT> }<a name="line.77"></a>
<FONT color="green">078</FONT> <a name="line.78"></a>
<FONT color="green">079</FONT> /**<a name="line.79"></a>
<FONT color="green">080</FONT> * Determines if a Manager with the specified name exists.<a name="line.80"></a>
<FONT color="green">081</FONT> * @param name The name of the Manager.<a name="line.81"></a>
<FONT color="green">082</FONT> * @return True if the Manager exists, false otherwise.<a name="line.82"></a>
<FONT color="green">083</FONT> */<a name="line.83"></a>
<FONT color="green">084</FONT> public static boolean hasManager(String name) {<a name="line.84"></a>
<FONT color="green">085</FONT> lock.lock();<a name="line.85"></a>
<FONT color="green">086</FONT> try {<a name="line.86"></a>
<FONT color="green">087</FONT> return map.containsKey(name);<a name="line.87"></a>
<FONT color="green">088</FONT> } finally {<a name="line.88"></a>
<FONT color="green">089</FONT> lock.unlock();<a name="line.89"></a>
<FONT color="green">090</FONT> }<a name="line.90"></a>
<FONT color="green">091</FONT> }<a name="line.91"></a>
<FONT color="green">092</FONT> <a name="line.92"></a>
<FONT color="green">093</FONT> /**<a name="line.93"></a>
<FONT color="green">094</FONT> * May be overriden by Managers to perform processing while the Manager is being released and the<a name="line.94"></a>
<FONT color="green">095</FONT> * lock is held.<a name="line.95"></a>
<FONT color="green">096</FONT> */<a name="line.96"></a>
<FONT color="green">097</FONT> protected void releaseSub() {<a name="line.97"></a>
<FONT color="green">098</FONT> }<a name="line.98"></a>
<FONT color="green">099</FONT> <a name="line.99"></a>
<FONT color="green">100</FONT> protected int getCount() {<a name="line.100"></a>
<FONT color="green">101</FONT> return count;<a name="line.101"></a>
<FONT color="green">102</FONT> }<a name="line.102"></a>
<FONT color="green">103</FONT> <a name="line.103"></a>
<FONT color="green">104</FONT> /**<a name="line.104"></a>
<FONT color="green">105</FONT> * Called to signify that this Manager is no longer required by an Appender.<a name="line.105"></a>
<FONT color="green">106</FONT> */<a name="line.106"></a>
<FONT color="green">107</FONT> public void release() {<a name="line.107"></a>
<FONT color="green">108</FONT> lock.lock();<a name="line.108"></a>
<FONT color="green">109</FONT> try {<a name="line.109"></a>
<FONT color="green">110</FONT> --count;<a name="line.110"></a>
<FONT color="green">111</FONT> if (count &lt;= 0) {<a name="line.111"></a>
<FONT color="green">112</FONT> map.remove(name);<a name="line.112"></a>
<FONT color="green">113</FONT> releaseSub();<a name="line.113"></a>
<FONT color="green">114</FONT> }<a name="line.114"></a>
<FONT color="green">115</FONT> } finally {<a name="line.115"></a>
<FONT color="green">116</FONT> lock.unlock();<a name="line.116"></a>
<FONT color="green">117</FONT> }<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> <a name="line.119"></a>
<FONT color="green">120</FONT> /**<a name="line.120"></a>
<FONT color="green">121</FONT> * Return the name of the Manager.<a name="line.121"></a>
<FONT color="green">122</FONT> * @return The name of the Manager.<a name="line.122"></a>
<FONT color="green">123</FONT> */<a name="line.123"></a>
<FONT color="green">124</FONT> public String getName() {<a name="line.124"></a>
<FONT color="green">125</FONT> return name;<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> }<a name="line.127"></a>
</PRE>
</BODY>
</HTML>