com.dua3.utility.logging.LogUtil Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of utility-logging Show documentation

Java utilities (logging)

There is a newer version: 15.0.2

package com.dua3.utility.logging;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.util.ServiceConfigurationError;
import java.util.ServiceLoader;

/**
 * Utility class for logging operations.
 */
public final class LogUtil {
    private LogUtil() {
    }

    private static final Logger LOG = LogManager.getLogger(LogUtil.class);

    /**
     * Returns the global LogEntryDispatcher by using the available ILogEntryDispatcherFactory implementations loaded
     * through ServiceLoader and connects all known loggers to it.
     *
     * @return The global LogEntryDispatcher instance.
     * @throws ServiceConfigurationError if no factories can create a LogEntryDispatcher.
     */
    public static LogEntryDispatcher getGlobalDispatcher() {
        ServiceLoader serviceLoader = ServiceLoader.load(ILogEntryDispatcherFactory.class);

        for (ILogEntryDispatcherFactory factory : serviceLoader) {
            try {
                LogEntryDispatcher dispatcher = factory.getGlobalDispatcher();
                if (dispatcher != null) {
                    LOG.debug("created dispatcher of class {} using factory {}", dispatcher.getClass(), factory.getClass());
                    return dispatcher;
                }
                LOG.debug("factory {} did not return a dispatcher", factory.getClass());
            } catch (Exception e) {
                LOG.warn("factory {} threw an exception when trying to create a dispatcher", factory.getClass().getName(), e);
            }
        }
        throw new ServiceConfigurationError("no factories left to try - could not create a dispatcher");
    }
}