001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.lookup;
018
019import java.util.Objects;
020
021import javax.naming.NamingException;
022
023import org.apache.logging.log4j.Logger;
024import org.apache.logging.log4j.Marker;
025import org.apache.logging.log4j.MarkerManager;
026import org.apache.logging.log4j.core.LogEvent;
027import org.apache.logging.log4j.core.config.plugins.Plugin;
028import org.apache.logging.log4j.core.net.JndiManager;
029import org.apache.logging.log4j.status.StatusLogger;
030
031/**
032 * Looks up keys from JNDI resources.
033 */
034@Plugin(name = "jndi", category = StrLookup.CATEGORY)
035public class JndiLookup extends AbstractLookup {
036
037    private static final Logger LOGGER = StatusLogger.getLogger();
038    private static final Marker LOOKUP = MarkerManager.getMarker("LOOKUP");
039
040    /** JNDI resource path prefix used in a J2EE container */
041    static final String CONTAINER_JNDI_RESOURCE_PATH_PREFIX = "java:comp/env/";
042
043    /**
044     * Looks up the value of the JNDI resource.
045     * @param event The current LogEvent (is ignored by this StrLookup).
046     * @param key  the JNDI resource name to be looked up, may be null
047     * @return The String value of the JNDI resource.
048     */
049    @Override
050    public String lookup(final LogEvent event, final String key) {
051        if (key == null) {
052            return null;
053        }
054        final String jndiName = convertJndiName(key);
055        try (final JndiManager jndiManager = JndiManager.getDefaultManager()) {
056            return Objects.toString(jndiManager.lookup(jndiName), null);
057        } catch (final NamingException e) {
058            LOGGER.warn(LOOKUP, "Error looking up JNDI resource [{}].", jndiName, e);
059            return null;
060        }
061    }
062
063    /**
064     * Convert the given JNDI name to the actual JNDI name to use.
065     * Default implementation applies the "java:comp/env/" prefix
066     * unless other scheme like "java:" is given.
067     * @param jndiName The name of the resource.
068     * @return The fully qualified name to look up.
069     */
070    private String convertJndiName(final String jndiName) {
071        if (!jndiName.startsWith(CONTAINER_JNDI_RESOURCE_PATH_PREFIX) && jndiName.indexOf(':') == -1) {
072            return CONTAINER_JNDI_RESOURCE_PATH_PREFIX + jndiName;
073        }
074        return jndiName;
075    }
076}