org.opendaylight.odlparent.bundlestest.lib.SystemStateFailureException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bundles-test-lib Show documentation

There is a newer version: 14.0.5

/*
 * Copyright (c) 2017 Red Hat, Inc. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.odlparent.bundlestest.lib;

import org.osgi.framework.Bundle;
import org.osgi.framework.BundleActivator;

/**
 * Exception thrown (only) by
 * {@link TestBundleDiag#checkBundleDiagInfos(long, java.util.concurrent.TimeUnit)}
 * if there are any OSGi bundles that failed to start.  This is based on not only {@link Bundle#getState()}'s
 * {@link Bundle#ACTIVE}, but also DI wiring systems such as blueprint containers.  The Exceptions' message
 * will likely contain a longer multi-line String with extensive technical details including all failed
 * bundles' states, detailed technical information related to OSGi bundle and blueprint resolution,
 * and possibly exceptions incl. stack traces thrown by {@link BundleActivator} start() methods and
 * dependency injection object wiring {@literal @}PostConstruct "init" type methods.
 *
 * @author Michael Vorburger.ch
 */
public class SystemStateFailureException extends Exception {
    private static final long serialVersionUID = 1L;

    private final BundleDiagInfos bundleDiagInfos;

    public SystemStateFailureException(String message, BundleDiagInfos bundleDiagInfos, Throwable cause) {
        super(getExtendedMessage(message, bundleDiagInfos), cause);
        this.bundleDiagInfos = bundleDiagInfos;
    }

    public SystemStateFailureException(String message, BundleDiagInfos bundleDiagInfos) {
        super(getExtendedMessage(message, bundleDiagInfos));
        this.bundleDiagInfos = bundleDiagInfos;
    }

    private static String getExtendedMessage(String message, BundleDiagInfos bundleDiagInfos) {
        return message + "\n" + bundleDiagInfos.getFullDiagnosticText();
    }

    public BundleDiagInfos getBundleDiagInfos() {
        return bundleDiagInfos;
    }
}