org.graylog2.shared.utilities.ExceptionUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.0.1
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.shared.utilities;

import com.google.common.base.Throwables;
import org.apache.commons.lang3.StringUtils;

import java.net.UnknownHostException;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

public class ExceptionUtils {

    public static Throwable getRootCause(Throwable t) {
        return getRootCause(t, false);
    }
    public static Throwable getRootCause(Throwable t, boolean causeNeedsMessage) {
        if (t == null) {
            return null;
        }
        Throwable rootCause = t;
        Throwable cause = rootCause.getCause();
        while (cause != null && (!causeNeedsMessage || StringUtils.isNotBlank(cause.getMessage())) && cause != rootCause) {
            rootCause = cause;
            cause = cause.getCause();
        }
        return rootCause;
    }

    public static String formatMessageCause(Throwable t) {
        if (t == null) {
            return "Unknown cause";
        }
        final StringBuilder causeMessage = new StringBuilder();

        // UnknownHostException has only the hostname as error message, we need to add some
        // information before showing the error message to the user.
        final String message = t.getMessage();
        if (t.getClass() == UnknownHostException.class) {
            causeMessage.append("Unknown host '");
            causeMessage.append(message);
            causeMessage.append("'");
        } else {
            causeMessage.append(message);
        }

        if (message != null && !message.endsWith(".") && !message.endsWith("!")) {
            causeMessage.append(".");
        }

        return causeMessage.toString();
    }

    public static String getRootCauseMessage(Throwable t) {
        return formatMessageCause(getRootCause(t));
    }

    public static String getRootCauseOrMessage(Throwable t) {
        final Throwable rootCause = getRootCause(t, true);
        return formatMessageCause(rootCause != null ? rootCause : t);
    }

    public static boolean hasCauseOf(Throwable t, Class causeType) {
        return Throwables.getCausalChain(t)
                .stream()
                .anyMatch(c -> causeType.isAssignableFrom(c.getClass()));
    }

    public static String getShortenedStackTrace(Throwable t) {
        StringBuilder trace = new StringBuilder();

        final List causalChain = Throwables.getCausalChain(t)
                .stream()
                .filter(c -> StringUtils.isNotBlank(c.getMessage()))
                .collect(Collectors.toList());

        int position = 0;
        for (Throwable c : causalChain) {
            if (position > 0) {
                trace.append("Caused by: ");
            }
            appendWithNewline(trace, c);
            Arrays.stream(c.getStackTrace()).findFirst().ifPresent(firstStackElement -> {
                trace.append("\tat ");
                appendWithNewline(trace, firstStackElement);
                final int more = c.getStackTrace().length - 1;
                if (more > 0) {
                    trace.append("\t... ").append(more);
                    appendWithNewline(trace, " more");
                }
            });

            position++;
        }

        return trace.toString();
    }

    private static StringBuilder appendWithNewline(StringBuilder stringBuilder, Object append) {
        return stringBuilder.append(append).append(System.lineSeparator());
    }
}