ch.qos.logback.core.status.StatusUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
The newest version!
/**
 * Logback: the reliable, generic, fast and flexible logging framework.
 * Copyright (C) 1999-2015, QOS.ch. All rights reserved.
 *
 * This program and the accompanying materials are dual-licensed under
 * either the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation
 *
 *   or (per the licensee's choosing)
 *
 * under the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation.
 */
package ch.qos.logback.core.status;

import ch.qos.logback.core.Context;
import ch.qos.logback.core.CoreConstants;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

// @deprecated This internal logback API is not supported by AEM as a Cloud Service.
@Deprecated(since = "2022-01-27")
public class StatusUtil {

    StatusManager sm;

    public StatusUtil(StatusManager sm) {
        this.sm = sm;
    }

    public StatusUtil(Context context) {
        this.sm = context.getStatusManager();
    }

    /**
     * Returns true if the StatusManager associated with the context passed
     * as parameter has one or more StatusListener instances registered. Returns
     * false otherwise.
     *
     * @param context
     * @return true if one or more StatusListeners registered, false otherwise
     * @since 1.0.8
     */
    static public boolean contextHasStatusListener(Context context) {
        StatusManager sm = context.getStatusManager();
        if (sm == null)
            return false;
        List listeners = sm.getCopyOfStatusListenerList();
        if (listeners == null || listeners.size() == 0)
            return false;
        else
            return true;
    }

    static public List filterStatusListByTimeThreshold(List rawList, long threshold) {
        List filteredList = new ArrayList();
        for (Status s : rawList) {
            if (s.getDate() >= threshold)
                filteredList.add(s);
        }
        return filteredList;
    }

    public void addStatus(Status status) {
        if (sm != null) {
            sm.add(status);
        }
    }

    public void addInfo(Object caller, String msg) {
        addStatus(new InfoStatus(msg, caller));
    }

    public void addWarn(Object caller, String msg) {
        addStatus(new WarnStatus(msg, caller));
    }

    public void addError(Object caller, String msg, Throwable t) {
        addStatus(new ErrorStatus(msg, caller, t));
    }

    public boolean hasXMLParsingErrors(long threshold) {
        return containsMatch(threshold, Status.ERROR, CoreConstants.XML_PARSING);
    }

    public boolean noXMLParsingErrorsOccurred(long threshold) {
        return !hasXMLParsingErrors(threshold);
    }

    public int getHighestLevel(long threshold) {
        List filteredList = filterStatusListByTimeThreshold(sm.getCopyOfStatusList(), threshold);
        int maxLevel = Status.INFO;
        for (Status s : filteredList) {
            if (s.getLevel() > maxLevel)
                maxLevel = s.getLevel();
        }
        return maxLevel;
    }

    public boolean isErrorFree(long threshold) {
        return Status.ERROR > getHighestLevel(threshold);
    }

    public boolean isWarningOrErrorFree(long threshold) {
        return Status.WARN > getHighestLevel(threshold);
    }

    public boolean containsMatch(long threshold, int level, String regex) {
        List filteredList = filterStatusListByTimeThreshold(sm.getCopyOfStatusList(), threshold);
        Pattern p = Pattern.compile(regex);
        for (Status status : filteredList) {
            if (level != status.getLevel()) {
                continue;
            }
            String msg = status.getMessage();
            Matcher matcher = p.matcher(msg);
            if (matcher.lookingAt()) {
                return true;
            }
        }
        return false;
    }

    public boolean containsMatch(int level, String regex) {
        return containsMatch(0, level, regex);
    }

    public boolean containsMatch(String regex) {
        Pattern p = Pattern.compile(regex);
        for (Status status : sm.getCopyOfStatusList()) {
            String msg = status.getMessage();
            Matcher matcher = p.matcher(msg);
            if (matcher.lookingAt()) {
                return true;
            }
        }
        return false;
    }

    public int matchCount(String regex) {
        int count = 0;
        Pattern p = Pattern.compile(regex);
        for (Status status : sm.getCopyOfStatusList()) {
            String msg = status.getMessage();
            Matcher matcher = p.matcher(msg);
            if (matcher.lookingAt()) {
                count++;
            }
        }
        return count;
    }

    public boolean containsException(Class exceptionType) {
        Iterator stati = sm.getCopyOfStatusList().iterator();
        while (stati.hasNext()) {
            Status status = stati.next();
            Throwable t = status.getThrowable();
            while (t != null) {
                if (t.getClass().getName().equals(exceptionType.getName())) {
                    return true;
                }
                t = t.getCause();
            }
        }
        return false;
    }

    /**
     * Return the time of last reset. -1 if last reset time could not be found
     *
     * @return time of last reset or -1
     */
    public long timeOfLastReset() {
        List statusList = sm.getCopyOfStatusList();
        if (statusList == null)
            return -1;
        int len = statusList.size();
        for (int i = len - 1; i >= 0; i--) {
            Status s = statusList.get(i);
            if (CoreConstants.RESET_MSG_PREFIX.equals(s.getMessage())) {
                return s.getDate();
            }
        }
        return -1;
    }
}