Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.2 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / osgi / BundleContextSelector.html
blob: 3a9a0fc059788e84a8ec829b3125b2a608fd466b [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.osgi;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.lang.ref.WeakReference;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.net.URI;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Objects;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.TimeUnit;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.atomic.AtomicReference;<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.core.LoggerContext;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.impl.ContextAnchor;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.selector.ClassLoaderContextSelector;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.util.StackLocatorUtil;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.osgi.framework.Bundle;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.osgi.framework.BundleReference;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.osgi.framework.FrameworkUtil;<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> * ContextSelector for OSGi bundles. This ContextSelector works rather similarly to the<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@link ClassLoaderContextSelector}, but instead of each ClassLoader having its own LoggerContext (like in a<a name="line.35"></a>
<span class="sourceLineNo">036</span> * servlet container), each OSGi bundle has its own LoggerContext.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * @since 2.1<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>public class BundleContextSelector extends ClassLoaderContextSelector {<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> @Override<a name="line.42"></a>
<span class="sourceLineNo">043</span> public void shutdown(final String fqcn, final ClassLoader loader, final boolean currentContext,<a name="line.43"></a>
<span class="sourceLineNo">044</span> final boolean allContexts) {<a name="line.44"></a>
<span class="sourceLineNo">045</span> LoggerContext ctx = null;<a name="line.45"></a>
<span class="sourceLineNo">046</span> Bundle bundle = null;<a name="line.46"></a>
<span class="sourceLineNo">047</span> if (currentContext) {<a name="line.47"></a>
<span class="sourceLineNo">048</span> ctx = ContextAnchor.THREAD_CONTEXT.get();<a name="line.48"></a>
<span class="sourceLineNo">049</span> ContextAnchor.THREAD_CONTEXT.remove();<a name="line.49"></a>
<span class="sourceLineNo">050</span> }<a name="line.50"></a>
<span class="sourceLineNo">051</span> if (ctx == null &amp;&amp; loader instanceof BundleReference) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> bundle = ((BundleReference) loader).getBundle();<a name="line.52"></a>
<span class="sourceLineNo">053</span> ctx = getLoggerContext(bundle);<a name="line.53"></a>
<span class="sourceLineNo">054</span> removeLoggerContext(ctx);<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span> if (ctx == null) {<a name="line.56"></a>
<span class="sourceLineNo">057</span> final Class&lt;?&gt; callerClass = StackLocatorUtil.getCallerClass(fqcn);<a name="line.57"></a>
<span class="sourceLineNo">058</span> if (callerClass != null) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> bundle = FrameworkUtil.getBundle(callerClass);<a name="line.59"></a>
<span class="sourceLineNo">060</span> ctx = getLoggerContext(FrameworkUtil.getBundle(callerClass));<a name="line.60"></a>
<span class="sourceLineNo">061</span> removeLoggerContext(ctx);<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> if (ctx == null) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> ctx = ContextAnchor.THREAD_CONTEXT.get();<a name="line.65"></a>
<span class="sourceLineNo">066</span> ContextAnchor.THREAD_CONTEXT.remove();<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span> if (ctx != null) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> ctx.stop(DEFAULT_STOP_TIMEOUT, TimeUnit.MILLISECONDS);<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span> if (bundle != null &amp;&amp; allContexts) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> final Bundle[] bundles = bundle.getBundleContext().getBundles();<a name="line.72"></a>
<span class="sourceLineNo">073</span> for (final Bundle bdl : bundles) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> ctx = getLoggerContext(bdl);<a name="line.74"></a>
<span class="sourceLineNo">075</span> if (ctx != null) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> ctx.stop(DEFAULT_STOP_TIMEOUT, TimeUnit.MILLISECONDS);<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<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> }<a name="line.80"></a>
<span class="sourceLineNo">081</span> private LoggerContext getLoggerContext(final Bundle bundle) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> final String name = Objects.requireNonNull(bundle, "No Bundle provided").getSymbolicName();<a name="line.82"></a>
<span class="sourceLineNo">083</span> final AtomicReference&lt;WeakReference&lt;LoggerContext&gt;&gt; ref = CONTEXT_MAP.get(name);<a name="line.83"></a>
<span class="sourceLineNo">084</span> if (ref != null &amp;&amp; ref.get() != null) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> return ref.get().get();<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span> return null;<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> private void removeLoggerContext(LoggerContext context) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> CONTEXT_MAP.remove(context.getName());<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> @Override<a name="line.94"></a>
<span class="sourceLineNo">095</span> public boolean hasContext(final String fqcn, final ClassLoader loader, final boolean currentContext) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> if (currentContext &amp;&amp; ContextAnchor.THREAD_CONTEXT.get() != null) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> return ContextAnchor.THREAD_CONTEXT.get().isStarted();<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span> if (loader instanceof BundleReference) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> return hasContext(((BundleReference) loader).getBundle());<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span> final Class&lt;?&gt; callerClass = StackLocatorUtil.getCallerClass(fqcn);<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (callerClass != null) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return hasContext(FrameworkUtil.getBundle(callerClass));<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span> return ContextAnchor.THREAD_CONTEXT.get() != null &amp;&amp; ContextAnchor.THREAD_CONTEXT.get().isStarted();<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> @Override<a name="line.108"></a>
<span class="sourceLineNo">109</span> public LoggerContext getContext(final String fqcn, final ClassLoader loader, final boolean currentContext,<a name="line.109"></a>
<span class="sourceLineNo">110</span> final URI configLocation) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> if (currentContext) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> final LoggerContext ctx = ContextAnchor.THREAD_CONTEXT.get();<a name="line.112"></a>
<span class="sourceLineNo">113</span> if (ctx != null) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> return ctx;<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> return getDefault();<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> // it's quite possible that the provided ClassLoader may implement BundleReference which gives us a nice shortcut<a name="line.118"></a>
<span class="sourceLineNo">119</span> if (loader instanceof BundleReference) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return locateContext(((BundleReference) loader).getBundle(), configLocation);<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span> final Class&lt;?&gt; callerClass = StackLocatorUtil.getCallerClass(fqcn);<a name="line.122"></a>
<span class="sourceLineNo">123</span> if (callerClass != null) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> return locateContext(FrameworkUtil.getBundle(callerClass), configLocation);<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span> final LoggerContext lc = ContextAnchor.THREAD_CONTEXT.get();<a name="line.126"></a>
<span class="sourceLineNo">127</span> return lc == null ? getDefault() : lc;<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> private static boolean hasContext(final Bundle bundle) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> final String name = Objects.requireNonNull(bundle, "No Bundle provided").getSymbolicName();<a name="line.131"></a>
<span class="sourceLineNo">132</span> final AtomicReference&lt;WeakReference&lt;LoggerContext&gt;&gt; ref = CONTEXT_MAP.get(name);<a name="line.132"></a>
<span class="sourceLineNo">133</span> return ref != null &amp;&amp; ref.get() != null &amp;&amp; ref.get().get() != null &amp;&amp; ref.get().get().isStarted();<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> private static LoggerContext locateContext(final Bundle bundle, final URI configLocation) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> final String name = Objects.requireNonNull(bundle, "No Bundle provided").getSymbolicName();<a name="line.137"></a>
<span class="sourceLineNo">138</span> final AtomicReference&lt;WeakReference&lt;LoggerContext&gt;&gt; ref = CONTEXT_MAP.get(name);<a name="line.138"></a>
<span class="sourceLineNo">139</span> if (ref == null) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> final LoggerContext context = new LoggerContext(name, bundle, configLocation);<a name="line.140"></a>
<span class="sourceLineNo">141</span> CONTEXT_MAP.putIfAbsent(name,<a name="line.141"></a>
<span class="sourceLineNo">142</span> new AtomicReference&lt;&gt;(new WeakReference&lt;&gt;(context)));<a name="line.142"></a>
<span class="sourceLineNo">143</span> return CONTEXT_MAP.get(name).get().get();<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span> final WeakReference&lt;LoggerContext&gt; r = ref.get();<a name="line.145"></a>
<span class="sourceLineNo">146</span> final LoggerContext ctx = r.get();<a name="line.146"></a>
<span class="sourceLineNo">147</span> if (ctx == null) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> final LoggerContext context = new LoggerContext(name, bundle, configLocation);<a name="line.148"></a>
<span class="sourceLineNo">149</span> ref.compareAndSet(r, new WeakReference&lt;&gt;(context));<a name="line.149"></a>
<span class="sourceLineNo">150</span> return ref.get().get();<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span> final URI oldConfigLocation = ctx.getConfigLocation();<a name="line.152"></a>
<span class="sourceLineNo">153</span> if (oldConfigLocation == null &amp;&amp; configLocation != null) {<a name="line.153"></a>
<span class="sourceLineNo">154</span> LOGGER.debug("Setting bundle ({}) configuration to {}", name, configLocation);<a name="line.154"></a>
<span class="sourceLineNo">155</span> ctx.setConfigLocation(configLocation);<a name="line.155"></a>
<span class="sourceLineNo">156</span> } else if (oldConfigLocation != null &amp;&amp; configLocation != null &amp;&amp; !configLocation.equals(oldConfigLocation)) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> LOGGER.warn("locateContext called with URI [{}], but existing LoggerContext has URI [{}]",<a name="line.157"></a>
<span class="sourceLineNo">158</span> configLocation, oldConfigLocation);<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span> return ctx;<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span>}<a name="line.162"></a>
</pre>
</div>
</body>
</html>