be.yildizgames.common.logging.LoggerPropertiesConfiguration Maven / Gradle / Ivy

Go to download
/*
 This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 Copyright (c) 2018-2024 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;

import be.yildizgames.common.properties.PropertiesHelper;

import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import java.util.Properties;

/**
 * Logger configuration built from a property file.
 * @author Grégory Van den Borre.
 */
public class LoggerPropertiesConfiguration implements LoggerConfiguration {

    public static final String LOGGER_PATTERN_KEY = "logger.pattern";

    public static final String LOGGER_LEVEL_KEY = "logger.level";

    public static final String LOGGER_OUTPUT_KEY = "logger.output";

    public static final String LOGGER_TCP_HOST_KEY = "logger.tcp.host";

    public static final String LOGGER_TCP_PORT_KEY = "logger.tcp.port";

    public static final String LOGGER_FILE_OUTPUT_KEY = "logger.file.output";

    public static final String LOGGER_CONFIGURATION_FILE_KEY = "logger.configuration.file";

    public static final String LOGGER_DISABLED_KEY = "logger.disabled";

    /**
     * Pattern to display to message.
     */
    private final String loggerPattern;

    /**
     * Level of the logger.
     */
    private final LoggerLevel loggerLevel;

    /**
     * Output of the logger.
     */
    private final List loggerOutputs;

    /**
     * Host in case of TCP output.
     */
    private final String loggerTcpHost;

    /**
     * Port in case of TCP output.
     */
    private final int loggerTcpPort;

    /**
     * File in case of FILE output.
     */
    private final String loggerFile;

    /**
     * File where the configuration will be written.
     */
    private final String configurationFile;

    private final List loggerToDisable;

    /**
     * Build the instance.
     * @param p Properties to build from.
     */
    private LoggerPropertiesConfiguration(final Properties p) {
        Objects.requireNonNull(p);
        this.loggerPattern = PropertiesHelper.getValue(p, LOGGER_PATTERN_KEY);
        this.loggerLevel = LoggerLevel.valueOf(PropertiesHelper.getValue(p, LOGGER_LEVEL_KEY).toUpperCase());
        this.loggerOutputs = Arrays.stream(PropertiesHelper.getValue(p, LOGGER_OUTPUT_KEY).split(","))
                .map(String::trim)
                .map(String::toUpperCase)
                .map(SupportedOutput::valueOf)
                .toList();
        this.loggerTcpHost = PropertiesHelper.getValue(p, LOGGER_TCP_HOST_KEY);
        this.loggerTcpPort = PropertiesHelper.getIntValue(p, LOGGER_TCP_PORT_KEY);
        this.loggerFile = PropertiesHelper.getValue(p, LOGGER_FILE_OUTPUT_KEY);
        this.configurationFile = PropertiesHelper.getValue(p, LOGGER_CONFIGURATION_FILE_KEY);
        String disable = PropertiesHelper.getValue(p, LOGGER_DISABLED_KEY);
        this.loggerToDisable = Arrays.asList(disable.split(","));
    }

    /**
     * Create a new configuration from a properties file.
     * Expected properties are:
     * logger.pattern: String.
     * logger.level: TRACE, DEBUG, INFO, WARN, ERROR.
     * logger.output: FILE, TCP, CONSOLE.
     * logger.tcp.host: String.
     * logger.tcp.port: a valid port number.
     * logger.file.output: String.
     * logger.configuration.file: String.
     * @param p Properties to build from.
     * @return The built configuration.
     */
    public static LoggerConfiguration fromProperties(Properties p) {
        return new LoggerPropertiesConfiguration(p);
    }

    @Override
    public final String getLoggerPattern() {
        return this.loggerPattern;
    }

    @Override
    public final LoggerLevel getLoggerLevel() {
        return this.loggerLevel;
    }

    @Override
    public final List getLoggerOutputs() {
        return this.loggerOutputs;
    }

    @Override
    public final String getLoggerTcpHost() {
        return this.loggerTcpHost;
    }

    @Override
    public final int getLoggerTcpPort() {
        return this.loggerTcpPort;
    }

    @Override
    public final String getLoggerOutputFile() {
        return this.loggerFile;
    }

    @Override
    public final String getLoggerConfigurationFile() {
        return this.configurationFile;
    }

    @Override
    public final List getLoggerToDisable() {
        return this.loggerToDisable;
    }

}