org.apache.lucene.util.JavaLoggingInfoStream Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.bundles.lucene
This OSGi bundle wraps ${pkgArtifactId} ${pkgVersion} jar file.
There is a newer version: 6.4.2_1
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.lucene.util;

import java.util.Map;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * InfoStream implementation that logs every message using Java Utils Logging (JUL) with the
 * supplied log level.
 *
 * @lucene.internal
 */
// We export class 'java.util.logging.Level', but we won't want a transitive dependency in
// module descriptor:
@SuppressWarnings("exports")
public final class JavaLoggingInfoStream extends InfoStream {
  private final Map cache = new ConcurrentHashMap<>();

  private final Function componentToLoggerName;
  private final Level level;

  /**
   * Gets an implementation using the given log level with a default prefix {@code
   * "org.apache.lucene."}.
   *
   * @param level Requested log level to be used while logging
   */
  public JavaLoggingInfoStream(Level level) {
    this("org.apache.lucene.", level);
  }

  /**
   * Gets an implementation that logs using the given log level and adds a prefix to the component
   * name.
   *
   * @param namePrefix Prefix to be applied to all component names. It must be empty or include a
   *     final dot
   * @param level Requested log level to be used while logging
   */
  public JavaLoggingInfoStream(String namePrefix, Level level) {
    this(Objects.requireNonNull(namePrefix, "namePrefix")::concat, level);
  }

  /**
   * Gets an implementation that logs using the given log level with a logger name derived from the
   * component name.
   *
   * @param componentToLoggerName A function to convert a component name to a valid JUL logger name
   * @param level Requested log level to be used while logging
   */
  public JavaLoggingInfoStream(Function componentToLoggerName, Level level) {
    this.componentToLoggerName =
        Objects.requireNonNull(componentToLoggerName, "componentToLoggerName");
    this.level = Objects.requireNonNull(level, "level");
  }

  @Override
  public void message(String component, String message) {
    // We pass null as class/method name, because it is irrelevant and useless anyways.
    // This prevents stack trace inspection.
    getLogger(component).logp(level, null, null, message);
  }

  @Override
  public boolean isEnabled(String component) {
    return getLogger(component).isLoggable(level);
  }

  @Override
  public void close() {
    cache.clear();
  }

  private Logger getLogger(String component) {
    return cache.computeIfAbsent(
        Objects.requireNonNull(component, "component"),
        c -> Logger.getLogger(componentToLoggerName.apply(c)));
  }
}