Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-api / apidocs / src-html / org / apache / logging / log4j / spi / AbstractLoggerAdapter.html
blob: a7efe5f3e4880e3a359093f92c0324dff4bb2404 [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.spi;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.HashSet;<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.Set;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.WeakHashMap;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.ConcurrentMap;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.locks.ReadWriteLock;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.locks.ReentrantReadWriteLock;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.LogManager;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.util.LoaderUtil;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Provides an abstract base class to use for implementing LoggerAdapter.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * <a name="line.33"></a>
<span class="sourceLineNo">034</span> * @param &lt;L&gt; the Logger class to adapt<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @since 2.1<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>public abstract class AbstractLoggerAdapter&lt;L&gt; implements LoggerAdapter&lt;L&gt;, LoggerContextShutdownAware {<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> /**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * A map to store loggers for their given LoggerContexts.<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span> protected final Map&lt;LoggerContext, ConcurrentMap&lt;String, L&gt;&gt; registry = new ConcurrentHashMap&lt;&gt;();<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> private final ReadWriteLock lock = new ReentrantReadWriteLock (true);<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> @Override<a name="line.46"></a>
<span class="sourceLineNo">047</span> public L getLogger(final String name) {<a name="line.47"></a>
<span class="sourceLineNo">048</span> final LoggerContext context = getContext();<a name="line.48"></a>
<span class="sourceLineNo">049</span> final ConcurrentMap&lt;String, L&gt; loggers = getLoggersInContext(context);<a name="line.49"></a>
<span class="sourceLineNo">050</span> final L logger = loggers.get(name);<a name="line.50"></a>
<span class="sourceLineNo">051</span> if (logger != null) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> return logger;<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span> loggers.putIfAbsent(name, newLogger(name, context));<a name="line.54"></a>
<span class="sourceLineNo">055</span> return loggers.get(name);<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 void contextShutdown(LoggerContext loggerContext) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> registry.remove(loggerContext);<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> * Gets or creates the ConcurrentMap of named loggers for a given LoggerContext.<a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param context the LoggerContext to get loggers for<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @return the map of loggers for the given LoggerContext<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> public ConcurrentMap&lt;String, L&gt; getLoggersInContext(final LoggerContext context) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> ConcurrentMap&lt;String, L&gt; loggers;<a name="line.70"></a>
<span class="sourceLineNo">071</span> lock.readLock ().lock ();<a name="line.71"></a>
<span class="sourceLineNo">072</span> try {<a name="line.72"></a>
<span class="sourceLineNo">073</span> loggers = registry.get (context);<a name="line.73"></a>
<span class="sourceLineNo">074</span> } finally {<a name="line.74"></a>
<span class="sourceLineNo">075</span> lock.readLock ().unlock ();<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> if (loggers != null) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> return loggers;<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span> lock.writeLock ().lock ();<a name="line.81"></a>
<span class="sourceLineNo">082</span> try {<a name="line.82"></a>
<span class="sourceLineNo">083</span> loggers = registry.get (context);<a name="line.83"></a>
<span class="sourceLineNo">084</span> if (loggers == null) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> loggers = new ConcurrentHashMap&lt;&gt; ();<a name="line.85"></a>
<span class="sourceLineNo">086</span> registry.put (context, loggers);<a name="line.86"></a>
<span class="sourceLineNo">087</span> if (context instanceof LoggerContextShutdownEnabled) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> ((LoggerContextShutdownEnabled) context).addShutdownListener(this);<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span> return loggers;<a name="line.91"></a>
<span class="sourceLineNo">092</span> } finally {<a name="line.92"></a>
<span class="sourceLineNo">093</span> lock.writeLock ().unlock ();<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><a name="line.96"></a>
<span class="sourceLineNo">097</span> /**<a name="line.97"></a>
<span class="sourceLineNo">098</span> * For unit testing. Consider to be private.<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> public Set&lt;LoggerContext&gt; getLoggerContexts() {<a name="line.100"></a>
<span class="sourceLineNo">101</span> return new HashSet&lt;&gt;(registry.keySet());<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> /**<a name="line.104"></a>
<span class="sourceLineNo">105</span> * Creates a new named logger for a given {@link LoggerContext}.<a name="line.105"></a>
<span class="sourceLineNo">106</span> *<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @param name the name of the logger to create<a name="line.107"></a>
<span class="sourceLineNo">108</span> * @param context the LoggerContext this logger will be associated with<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @return the new named logger<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> protected abstract L newLogger(final String name, final LoggerContext context);<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
<span class="sourceLineNo">114</span> * Gets the {@link LoggerContext} that should be used to look up or create loggers. This is similar in spirit to the<a name="line.114"></a>
<span class="sourceLineNo">115</span> * {@code ContextSelector} class in {@code log4j-core}. However, implementations can rely on their own framework's<a name="line.115"></a>
<span class="sourceLineNo">116</span> * separation of contexts instead (or simply use a singleton).<a name="line.116"></a>
<span class="sourceLineNo">117</span> *<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @return the LoggerContext to be used for lookup and creation purposes<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @see org.apache.logging.log4j.LogManager#getContext(ClassLoader, boolean)<a name="line.119"></a>
<span class="sourceLineNo">120</span> * @see org.apache.logging.log4j.LogManager#getContext(String, boolean)<a name="line.120"></a>
<span class="sourceLineNo">121</span> */<a name="line.121"></a>
<span class="sourceLineNo">122</span> protected abstract LoggerContext getContext();<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
<span class="sourceLineNo">125</span> * Gets the {@link LoggerContext} associated with the given caller class.<a name="line.125"></a>
<span class="sourceLineNo">126</span> *<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @param callerClass the caller class<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @return the LoggerContext for the calling class<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> protected LoggerContext getContext(final Class&lt;?&gt; callerClass) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> ClassLoader cl = null;<a name="line.131"></a>
<span class="sourceLineNo">132</span> if (callerClass != null) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> cl = callerClass.getClassLoader();<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span> if (cl == null) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> cl = LoaderUtil.getThreadContextClassLoader();<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span> return LogManager.getContext(cl, false);<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> @Override<a name="line.141"></a>
<span class="sourceLineNo">142</span> public void close() {<a name="line.142"></a>
<span class="sourceLineNo">143</span> lock.writeLock ().lock ();<a name="line.143"></a>
<span class="sourceLineNo">144</span> try {<a name="line.144"></a>
<span class="sourceLineNo">145</span> registry.clear();<a name="line.145"></a>
<span class="sourceLineNo">146</span> } finally {<a name="line.146"></a>
<span class="sourceLineNo">147</span> lock.writeLock ().unlock ();<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<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>
</pre>
</div>
</body>
</html>