| <!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.selector;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.net.URI;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.ArrayList;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Collections;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Map;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.concurrent.ConcurrentMap;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.concurrent.TimeUnit;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import javax.naming.NamingException;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.LoggerContext;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.impl.ContextAnchor;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.net.JndiManager;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.util.Constants;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>/**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * This class can be used to define a custom logger repository. It makes use of the fact that in J2EE environments, each<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * web-application is guaranteed to have its own JNDI context relative to the <code>java:comp/env</code> context. In<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * EJBs, each enterprise bean (albeit not each application) has its own context relative to the<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <code>java:comp/env</code> context. An <code>env-entry</code> in a deployment descriptor provides the information to<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * the JNDI context. Once the <code>env-entry</code> is set, a repository selector can query the JNDI application<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * context to look up the value of the entry. The logging context of the web-application will depend on the value the<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * env-entry. The JNDI context which is looked up by this class is <code>java:comp/env/log4j/context-name</code>.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <p><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Here is an example of an <code>env-entry</code>:<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * </p><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <blockquote><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <pre><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * &lt;env-entry&gt;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * &lt;description&gt;JNDI logging context name for this app&lt;/description&gt;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * &lt;env-entry-name&gt;log4j/context-name&lt;/env-entry-name&gt;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * &lt;env-entry-value&gt;aDistinctiveLoggingContextName&lt;/env-entry-value&gt;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * &lt;env-entry-type&gt;java.lang.String&lt;/env-entry-type&gt;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * &lt;/env-entry&gt;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * </pre><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> *<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * </blockquote><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> *<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <p><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <em>If multiple applications use the same logging context name, then they<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * will share the same logging context.</em><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * </p><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> *<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <p><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * You can also specify the URL for this context's configuration resource. This repository selector<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * (ContextJNDISelector) will use this resource to automatically configure the log4j repository.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * </p><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> ** <blockquote><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> *<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * <pre><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * &lt;env-entry&gt;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * &lt;description&gt;URL for configuring log4j context&lt;/description&gt;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * &lt;env-entry-name&gt;log4j/configuration-resource&lt;/env-entry-name&gt;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * &lt;env-entry-value&gt;urlOfConfigurationResource&lt;/env-entry-value&gt;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * &lt;env-entry-type&gt;java.lang.String&lt;/env-entry-type&gt;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * &lt;/env-entry&gt;<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * </pre><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> *<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * </blockquote><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> *<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <p><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * It usually good practice for configuration resources of distinct applications to have distinct names. However, if<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * this is not possible Naming<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * </p><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> */<a name="line.86"></a> |
| <span class="sourceLineNo">087</span>public class JndiContextSelector implements NamedContextSelector {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> private static final LoggerContext CONTEXT = new LoggerContext("Default");<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> private static final ConcurrentMap<String, LoggerContext> CONTEXT_MAP =<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> new ConcurrentHashMap<>();<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> private static final StatusLogger LOGGER = StatusLogger.getLogger();<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> @Override<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> public void shutdown(String fqcn, ClassLoader loader, boolean currentContext, boolean allContexts) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> LoggerContext ctx = ContextAnchor.THREAD_CONTEXT.get();<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> if (ctx == null) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> String loggingContextName = getContextName();<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> if (loggingContextName != null) {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> ctx = CONTEXT_MAP.get(loggingContextName);<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> if (ctx != null) {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> ctx.stop(DEFAULT_STOP_TIMEOUT, TimeUnit.MILLISECONDS);<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> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> @Override<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> public boolean hasContext(String fqcn, ClassLoader loader, boolean currentContext) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> 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> String loggingContextName = getContextName();<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> if (loggingContextName == null) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return false;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> ctx = CONTEXT_MAP.get(loggingContextName);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> return ctx != null && ctx.isStarted();<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> @Override<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> public LoggerContext getContext(final String fqcn, final ClassLoader loader, final boolean currentContext) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> return getContext(fqcn, loader, currentContext, null);<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> @Override<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> public LoggerContext getContext(final String fqcn, final ClassLoader loader, final boolean currentContext,<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> final URI configLocation) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> final LoggerContext lc = ContextAnchor.THREAD_CONTEXT.get();<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> if (lc != null) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> return lc;<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> String loggingContextName = null;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> try (final JndiManager jndiManager = JndiManager.getDefaultManager()) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> loggingContextName = jndiManager.lookup(Constants.JNDI_CONTEXT_NAME);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> } catch (final NamingException ne) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> LOGGER.error("Unable to lookup {}", Constants.JNDI_CONTEXT_NAME, ne);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> return loggingContextName == null ? CONTEXT : locateContext(loggingContextName, null, configLocation);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> }<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> private String getContextName() {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> String loggingContextName = null;<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> try (final JndiManager jndiManager = JndiManager.getDefaultManager()) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> loggingContextName = jndiManager.lookup(Constants.JNDI_CONTEXT_NAME);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> } catch (final NamingException ne) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> LOGGER.error("Unable to lookup {}", Constants.JNDI_CONTEXT_NAME, ne);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> return loggingContextName;<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> }<a name="line.157"></a> |
| <span class="sourceLineNo">158</span><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> @Override<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> public LoggerContext locateContext(final String name, final Object externalContext, final URI configLocation) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> if (name == null) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> LOGGER.error("A context name is required to locate a LoggerContext");<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> return null;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> if (!CONTEXT_MAP.containsKey(name)) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> final LoggerContext ctx = new LoggerContext(name, externalContext, configLocation);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> CONTEXT_MAP.putIfAbsent(name, ctx);<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> }<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> return CONTEXT_MAP.get(name);<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> @Override<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> public void removeContext(final LoggerContext context) {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> for (final Map.Entry<String, LoggerContext> entry : CONTEXT_MAP.entrySet()) {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> if (entry.getValue().equals(context)) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> CONTEXT_MAP.remove(entry.getKey());<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> }<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> @Override<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> public LoggerContext removeContext(final String name) {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> return CONTEXT_MAP.remove(name);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> }<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> @Override<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> public List<LoggerContext> getLoggerContexts() {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> return Collections.unmodifiableList(new ArrayList<>(CONTEXT_MAP.values()));<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
