org.apache.sshd.common.util.logging.AbstractLoggingBean Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sshd-common Show documentation
The newest version!
/*
 * 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.sshd.common.util.logging;

import java.util.concurrent.atomic.AtomicReference;

import org.apache.sshd.common.util.GenericUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Serves as a common base class for the vast majority of classes that require some kind of logging. Facilitates quick
 * and easy replacement of the actual used logger from one framework to another
 *
 * @author Apache MINA SSHD Project
 */
public abstract class AbstractLoggingBean {
    protected final Logger log;
    private final AtomicReference simplifiedLog = new AtomicReference<>();

    /**
     * Default constructor - creates a logger using the full class name
     *
     * @see #AbstractLoggingBean(Logger)
     */
    protected AbstractLoggingBean() {
        this((Logger) null);
    }

    /**
     * Create a logger for instances of the same class for which we might want to have a "discriminator" for
     * them
     *
     * @param discriminator The discriminator value - ignored if {@code null} or empty
     */
    protected AbstractLoggingBean(String discriminator) {
        String name = getClass().getName();
        if (GenericUtils.isNotEmpty(discriminator)) {
            name += "[" + discriminator + "]";
        }
        log = LoggerFactory.getLogger(name);
    }

    /**
     * @param logger The {@link Logger} instance to use - if {@code null} then one is retrieved using the full class
     *               name
     */
    protected AbstractLoggingBean(Logger logger) {
        log = (logger == null) ? LoggerFactory.getLogger(getClass()) : logger;
    }

    protected SimplifiedLog getSimplifiedLogger() {
        SimplifiedLog logger;
        synchronized (simplifiedLog) {
            logger = simplifiedLog.get();
            if (logger == null) {
                logger = LoggingUtils.wrap(log);
            }
        }

        return logger;
    }

    protected void debug(String message, Object o1, Object o2, Throwable t) {
        LoggingUtils.debug(log, message, o1, o2, t);
    }

    protected void debug(String message, Object o1, Object o2, Object o3, Throwable t) {
        LoggingUtils.debug(log, message, o1, o2, o3, t);
    }

    protected void debug(String message, Object o1, Object o2, Object o3, Object o4, Throwable t) {
        LoggingUtils.debug(log, message, o1, o2, o3, o4, t);
    }

    protected void debug(String message, Object o1, Object o2, Object o3, Object o4, Object o5, Throwable t) {
        LoggingUtils.debug(log, message, o1, o2, o3, o4, o5, t);
    }

    protected void debug(String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Throwable t) {
        LoggingUtils.debug(log, message, o1, o2, o3, o4, o5, o6, t);
    }

    protected void info(String message, Object o1, Object o2, Throwable t) {
        LoggingUtils.info(log, message, o1, o2, t);
    }

    protected void info(String message, Object o1, Object o2, Object o3, Throwable t) {
        LoggingUtils.info(log, message, o1, o2, o3, t);
    }

    protected void warn(String message, Object o1, Object o2, Throwable t) {
        LoggingUtils.warn(log, message, o1, o2, t);
    }

    protected void warn(String message, Object o1, Object o2, Object o3, Throwable t) {
        LoggingUtils.warn(log, message, o1, o2, o3, t);
    }

    protected void warn(String message, Object o1, Object o2, Object o3, Object o4, Throwable t) {
        LoggingUtils.warn(log, message, o1, o2, o3, o4, t);
    }

    protected void warn(String message, Object o1, Object o2, Object o3, Object o4, Object o5, Throwable t) {
        LoggingUtils.warn(log, message, o1, o2, o3, o4, o5, t);
    }

    protected void warn(String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Throwable t) {
        LoggingUtils.warn(log, message, o1, o2, o3, o4, o5, o6, t);
    }

    @SuppressWarnings("all")
    protected void warn(
            String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Object o7, Throwable t) {
        LoggingUtils.warn(log, message, o1, o2, o3, o4, o5, o6, o7, t);
    }

    @SuppressWarnings("all")
    protected void warn(
            String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Object o7, Object o8,
            Throwable t) {
        LoggingUtils.warn(log, message, o1, o2, o3, o4, o5, o6, o7, o8, t);
    }

    @SuppressWarnings("all")
    protected void warn(
            String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Object o7, Object o8, Object o9,
            Throwable t) {
        LoggingUtils.warn(log, message, o1, o2, o3, o4, o5, o6, o7, o8, o9, t);
    }

    protected void error(String message, Object o1, Object o2, Throwable t) {
        LoggingUtils.error(log, message, o1, o2, t);
    }

    protected void error(String message, Object o1, Object o2, Object o3, Throwable t) {
        LoggingUtils.error(log, message, o1, o2, o3, t);
    }

    protected void error(String message, Object o1, Object o2, Object o3, Object o4, Throwable t) {
        LoggingUtils.error(log, message, o1, o2, o3, o4, t);
    }

    protected void error(String message, Object o1, Object o2, Object o3, Object o4, Object o5, Throwable t) {
        LoggingUtils.error(log, message, o1, o2, o3, o4, o5, t);
    }

    protected void error(String message, Object o1, Object o2, Object o3, Object o4, Object o5, Object o6, Throwable t) {
        LoggingUtils.error(log, message, o1, o2, o3, o4, o5, o6, t);
    }
}