io.appulse.logging.logback.LogbackConfigurator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of logging-java Show documentation
Logging dependency for Appulse Java projects
There is a newer version: 1.1.3
/*
 * Copyright 2018 the original author or authors.
 *
 * Licensed 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 io.appulse.logging.logback;

import static lombok.AccessLevel.PRIVATE;

import java.util.HashMap;
import java.util.Map;

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.Appender;
import ch.qos.logback.core.CoreConstants;
import ch.qos.logback.core.pattern.Converter;
import ch.qos.logback.core.spi.ContextAware;
import ch.qos.logback.core.spi.LifeCycle;
import ch.qos.logback.core.spi.PropertyContainer;
import lombok.NonNull;
import lombok.experimental.FieldDefaults;

/**
 * Allows programmatic configuration of logback which is usually faster than parsing XML.
 *
 * @author Artem Labazin
 * @since 1.0.0
 */
@SuppressWarnings("PMD.MoreThanOneLogger")
@FieldDefaults(level = PRIVATE, makeFinal = true)
class LogbackConfigurator {

  LoggerContext context;

  LogbackConfigurator (@NonNull LoggerContext context) {
    this.context = context;
  }

  public PropertyContainer getContext () {
    return this.context;
  }

  public Object getConfigurationLock () {
    return this.context.getConfigurationLock();
  }

  @SuppressWarnings({ "rawtypes", "unchecked" })
  public void conversionRule (@NonNull String conversionWord, @NonNull Class converterClass) {
    Map registry = (Map) this.context.getObject(CoreConstants.PATTERN_RULE_REGISTRY);
    if (registry == null) {
      registry = new HashMap<>();
      this.context.putObject(CoreConstants.PATTERN_RULE_REGISTRY, registry);
    }
    registry.put(conversionWord, converterClass.getName());
  }

  public void appender (String name, Appender appender) {
    appender.setName(name);
    start(appender);
  }

  public void logger (String name, Level level) {
    logger(name, level, true);
  }

  public void logger (String name, Level level, boolean additive) {
    logger(name, level, additive, null);
  }

  public void logger (String name, Level level, boolean additive, Appender appender) {
    Logger logger = this.context.getLogger(name);
    if (level != null) {
      logger.setLevel(level);
    }
    logger.setAdditive(additive);
    if (appender != null) {
      logger.addAppender(appender);
    }
  }

  @SafeVarargs
  public final void root (Level level, Appender... appenders) {
    Logger logger = this.context.getLogger(org.slf4j.Logger.ROOT_LOGGER_NAME);
    if (level != null) {
      logger.setLevel(level);
    }
    for (Appender appender : appenders) {
      logger.addAppender(appender);
    }
  }

  public void start (LifeCycle lifeCycle) {
    if (lifeCycle instanceof ContextAware) {
      ((ContextAware) lifeCycle).setContext(this.context);
    }
    lifeCycle.start();
  }
}