blob: 5f7e1a571d3713fd5292d4bc05fb19740656d828 [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.lookup;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.Objects;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import javax.naming.NamingException;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.logging.log4j.Logger;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.Marker;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.MarkerManager;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.net.JndiManager;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.status.StatusLogger;<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> * Looks up keys from JNDI resources.<a name="line.32"></a>
<span class="sourceLineNo">033</span> */<a name="line.33"></a>
<span class="sourceLineNo">034</span>@Plugin(name = "jndi", category = StrLookup.CATEGORY)<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class JndiLookup extends AbstractLookup {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.37"></a>
<span class="sourceLineNo">038</span> private static final Marker LOOKUP = MarkerManager.getMarker("LOOKUP");<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> /** JNDI resource path prefix used in a J2EE container */<a name="line.40"></a>
<span class="sourceLineNo">041</span> static final String CONTAINER_JNDI_RESOURCE_PATH_PREFIX = "java:comp/env/";<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * Looks up the value of the JNDI resource.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @param event The current LogEvent (is ignored by this StrLookup).<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @param key the JNDI resource name to be looked up, may be null<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @return The String value of the JNDI resource.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> @Override<a name="line.49"></a>
<span class="sourceLineNo">050</span> public String lookup(final LogEvent event, final String key) {<a name="line.50"></a>
<span class="sourceLineNo">051</span> if (key == null) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> return null;<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span> final String jndiName = convertJndiName(key);<a name="line.54"></a>
<span class="sourceLineNo">055</span> try (final JndiManager jndiManager = JndiManager.getDefaultManager()) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> return Objects.toString(jndiManager.lookup(jndiName), null);<a name="line.56"></a>
<span class="sourceLineNo">057</span> } catch (final NamingException e) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> LOGGER.warn(LOOKUP, "Error looking up JNDI resource [{}].", jndiName, e);<a name="line.58"></a>
<span class="sourceLineNo">059</span> return null;<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<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> * Convert the given JNDI name to the actual JNDI name to use.<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Default implementation applies the "java:comp/env/" prefix<a name="line.65"></a>
<span class="sourceLineNo">066</span> * unless other scheme like "java:" is given.<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @param jndiName The name of the resource.<a name="line.67"></a>
<span class="sourceLineNo">068</span> * @return The fully qualified name to look up.<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> private String convertJndiName(final String jndiName) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> if (!jndiName.startsWith(CONTAINER_JNDI_RESOURCE_PATH_PREFIX) &amp;&amp; jndiName.indexOf(':') == -1) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> return CONTAINER_JNDI_RESOURCE_PATH_PREFIX + jndiName;<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> return jndiName;<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span>}<a name="line.76"></a>
</pre>
</div>
</body>
</html>