org.opencms.util.CmsLog4jUtil Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-core Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 17.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.util;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

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

/**
 * Utilities for dealing with log4j loggers.
 */
public final class CmsLog4jUtil {

    /**
     * Hidden default constructor.

     */
    private CmsLog4jUtil() {

        // do nothing
    }

    /**
     * Gets the list of all loggers.

     *
     * @return the list of all loggers
     */
    @SuppressWarnings("resource")
    public static List getAllLoggers() {

        LoggerContext context = (LoggerContext)(LogManager.getContext(false));
        Map loggersByName = new TreeMap();
        for (Logger logger : context.getLoggers()) {
            String loggerName = logger.getName();
            while (loggerName != null) {
                if (!loggersByName.containsKey(loggerName)) {
                    Logger currentLogger = (Logger)(LogManager.getLogger(loggerName));
                    loggersByName.put(loggerName, currentLogger);
                }
                loggerName = getParentLoggerName(loggerName);

            }
        }
        return new ArrayList(loggersByName.values());

    }

    /**
     * Gets the parent logger name for a given logger name, or null if there is no parent logger name.
     *
     * @param loggerName the name of a logger
     * @return the parent name of the logger, or null if the logger name has no parent
     */
    public static String getParentLoggerName(String loggerName) {

        int dotIndex = loggerName.lastIndexOf(".");
        if (dotIndex < 0) {
            return null;
        } else {
            return loggerName.substring(0, dotIndex);
        }

    }

}