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