be.yildizgames.common.logging.logback.LogbackLogEngine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-logging-logback Show documentation
Logback implementation for Common Logging library.
There is a newer version: 1.1.40
Show newest version
/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *
 *  Copyright (c) 2019 Grégory Van den Borre
 *
 *  More infos available: https://engine.yildiz-games.be
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 *  documentation files (the "Software"), to deal in the Software without restriction, including without
 *  limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 *  of the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all copies or substantial
 *  portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 *  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 *  OR COPYRIGHT  HOLDERS BE LIABLE FOR ANY CLAIM,
 *  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  SOFTWARE.
 *
 */
package be.yildizgames.common.logging.logback;

import be.yildizgames.common.logging.LogEngine;
import be.yildizgames.common.logging.LoggerConfiguration;
import be.yildizgames.common.logging.PatternBuilder;

import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Objects;

/**
 * Logback implementation for the LogEngine.
 *
 * @author Grégory Van den Borre
 */
public class LogbackLogEngine implements LogEngine {

    /**
     * Generator to build a configuration file.
     */
    private final LogbackConfigFileGenerator generator = new LogbackConfigFileGenerator();

    /**
     * Create a new instance.
     */
    public LogbackLogEngine() {
        this.configureForJBoss();
    }

    @Override
    public final PatternBuilder createPatternBuilder() {
        return new LogbackPatternBuilder();
    }

    @Override
    public final void setConfigurationPath(final String path) {
        Objects.requireNonNull(path);
        System.setProperty("logging.config", Paths.get(path).toAbsolutePath().toString());
        System.setProperty("logback.configurationFile", Paths.get(path).toAbsolutePath().toString());
    }

    @Override
    public final void configureFromProperties(final LoggerConfiguration properties) throws IOException {
        Objects.requireNonNull(properties);
        String result = this.generator.generate(properties);
        Path path = Paths.get(properties.getLoggerConfigurationFile());
        if(path.getParent() != null) {
            Files.createDirectories(path.getParent());
        }
        Files.write(path, result.getBytes(StandardCharsets.UTF_8));
        this.setConfigurationPath(properties.getLoggerConfigurationFile());
    }

    /**
     * Force the systems from jboss to use slf4j and logback.
     */
    private void configureForJBoss() {
        System.setProperty("org.jboss.logging.provider", "slf4j");
    }


}