1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache license, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the license for the specific language governing permissions and 15 * limitations under the license. 16 */ 17 package org.apache.logging.log4j.core.lookup; 18 19 import javax.naming.InitialContext; 20 import javax.naming.NamingException; 21 22 import org.apache.logging.log4j.core.LogEvent; 23 import org.apache.logging.log4j.core.config.plugins.Plugin; 24 25 /** 26 * Looks up keys from JNDI resources. 27 */ 28 @Plugin(name = "jndi", category = "Lookup") 29 public class JndiLookup implements StrLookup { 30 31 /** JNDI resourcce path prefix used in a J2EE container */ 32 static final String CONTAINER_JNDI_RESOURCE_PATH_PREFIX = "java:comp/env/"; 33 34 /** 35 * Looks up the value of the JNDI resource. 36 * @param key the JNDI resource name to be looked up, may be null 37 * @return The value of the JNDI resource. 38 */ 39 @Override 40 public String lookup(final String key) { 41 return lookup(null, key); 42 } 43 44 /** 45 * Looks up the value of the JNDI resource. 46 * @param event The current LogEvent (is ignored by this StrLookup). 47 * @param key the JNDI resource name to be looked up, may be null 48 * @return The value of the JNDI resource. 49 */ 50 @Override 51 public String lookup(final LogEvent event, final String key) { 52 if (key == null) { 53 return null; 54 } 55 56 try { 57 InitialContext ctx = new InitialContext(); 58 return (String) ctx.lookup(convertJndiName(key)); 59 } catch (NamingException e) { 60 return null; 61 } 62 } 63 64 /** 65 * Convert the given JNDI name to the actual JNDI name to use. 66 * Default implementation applies the "java:comp/env/" prefix 67 * unless other scheme like "java:" is given. 68 * @param jndiName The name of the resource. 69 * @return The fully qualified name to look up. 70 */ 71 private String convertJndiName(String jndiName) { 72 if (!jndiName.startsWith(CONTAINER_JNDI_RESOURCE_PATH_PREFIX) && jndiName.indexOf(':') == -1) { 73 jndiName = CONTAINER_JNDI_RESOURCE_PATH_PREFIX + jndiName; 74 } 75 76 return jndiName; 77 } 78 }