    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     */
    017    package org.apache.logging.log4j.core.lookup;
    018
    019    import javax.naming.NamingException;
    020
    021    import org.apache.logging.log4j.Logger;
    022    import org.apache.logging.log4j.Marker;
    023    import org.apache.logging.log4j.MarkerManager;
    024    import org.apache.logging.log4j.core.LogEvent;
    025    import org.apache.logging.log4j.core.config.plugins.Plugin;
    026    import org.apache.logging.log4j.core.net.JndiManager;
    027    import org.apache.logging.log4j.status.StatusLogger;
    028
    029    /**
    030     * Looks up keys from JNDI resources.
    031     */
    032    @Plugin(name = "jndi", category = StrLookup.CATEGORY)
    033    public class JndiLookup extends AbstractLookup {
    034
    035        private static final Logger LOGGER = StatusLogger.getLogger();
    036        private static final Marker LOOKUP = MarkerManager.getMarker("LOOKUP");
    037
    038        /** JNDI resource path prefix used in a J2EE container */
    039        static final String CONTAINER_JNDI_RESOURCE_PATH_PREFIX = "java:comp/env/";
    040
    041        /**
    042         * Looks up the value of the JNDI resource.
    043         * @param event The current LogEvent (is ignored by this StrLookup).
    044         * @param key  the JNDI resource name to be looked up, may be null
    045         * @return The value of the JNDI resource.
    046         */
    047        @Override
    048        public String lookup(final LogEvent event, final String key) {
    049            if (key == null) {
    050                return null;
    051            }
    052            final String jndiName = convertJndiName(key);
    053            final JndiManager jndiManager = JndiManager.getDefaultManager();
    054            try {
    055                return jndiManager.lookup(jndiName);
    056            } catch (final NamingException e) {
    057                LOGGER.warn(LOOKUP, "Error looking up JNDI resource [{}].", jndiName, e);
    058                return null;
    059            } finally {
    060                jndiManager.release();
    061            }
    062        }
    063
    064        /**
    065         * Convert the given JNDI name to the actual JNDI name to use.
    066         * Default implementation applies the "java:comp/env/" prefix
    067         * unless other scheme like "java:" is given.
    068         * @param jndiName The name of the resource.
    069         * @return The fully qualified name to look up.
    070         */
    071        private String convertJndiName(final String jndiName) {
    072            if (!jndiName.startsWith(CONTAINER_JNDI_RESOURCE_PATH_PREFIX) && jndiName.indexOf(':') == -1) {
    073                return CONTAINER_JNDI_RESOURCE_PATH_PREFIX + jndiName;
    074            }
    075            return jndiName;
    076        }
    077    }