View Javadoc

    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.NamingException;
    20
    21  import org.apache.logging.log4j.Logger;
    22  import org.apache.logging.log4j.Marker;
    23  import org.apache.logging.log4j.MarkerManager;
    24  import org.apache.logging.log4j.core.LogEvent;
    25  import org.apache.logging.log4j.core.config.plugins.Plugin;
    26  import org.apache.logging.log4j.core.net.JndiManager;
    27  import org.apache.logging.log4j.status.StatusLogger;
    28
    29  /**
    30   * Looks up keys from JNDI resources.
    31   */
    32  @Plugin(name = "jndi", category = StrLookup.CATEGORY)
    33  public class JndiLookup extends AbstractLookup {
    34
    35      private static final Logger LOGGER = StatusLogger.getLogger();
    36      private static final Marker LOOKUP = MarkerManager.getMarker("LOOKUP");
    37
    38      /** JNDI resource path prefix used in a J2EE container */
    39      static final String CONTAINER_JNDI_RESOURCE_PATH_PREFIX = "java:comp/env/";
    40
    41      /**
    42       * Looks up the value of the JNDI resource.
    43       * @param event The current LogEvent (is ignored by this StrLookup).
    44       * @param key  the JNDI resource name to be looked up, may be null
    45       * @return The value of the JNDI resource.
    46       */
    47      @Override
    48      public String lookup(final LogEvent event, final String key) {
    49          if (key == null) {
    50              return null;
    51          }
    52          final String jndiName = convertJndiName(key);
    53          final JndiManager jndiManager = JndiManager.getDefaultManager();
    54          try {
    55              return jndiManager.lookup(jndiName);
    56          } catch (final NamingException e) {
    57              LOGGER.warn(LOOKUP, "Error looking up JNDI resource [{}].", jndiName, e);
    58              return null;
    59          } finally {
    60              jndiManager.release();
    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(final String jndiName) {
    72          if (!jndiName.startsWith(CONTAINER_JNDI_RESOURCE_PATH_PREFIX) && jndiName.indexOf(':') == -1) {
    73              return CONTAINER_JNDI_RESOURCE_PATH_PREFIX + jndiName;
    74          }
    75          return jndiName;
    76      }
    77  }