org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of open-lineage-services-api Show documentation

Provides the definitions that make up the APIs used by external components when communicating with the open lineage.

There is a newer version: 4.3

Show newest version

/* SPDX-License-Identifier: Apache-2.0 */
package org.odpi.openmetadata.governanceservers.openlineage.ffdc;

import org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase;

/**
 * OpenLineageException provides a checked exception for reporting errors found when using
 * the Open Lineage services.
 * Typically these errors are either configuration or operational errors that can be fixed by an administrator
 * or power Open LineageConsumerInterface.  However, there may be the odd bug that surfaces here.
 * The OpenLineageErrorCode can be used with this exception to populate it with standard messages.
 * The aim is to be able to uniquely identify the cause and remedy for the error.
 */
public class OpenLineageException extends OCFCheckedExceptionBase {

    /**
     * @param httpCode          - http response code to use if this exception flows over a rest call
     * @param className         - name of class reporting error
     * @param actionDescription - description of function it was performing when error detected
     * @param errorMessage      - description of error
     * @param systemAction      - actions of the system as a result of the error
     * @param userAction        - instructions for correcting the error
     */
    public OpenLineageException(int httpCode,
                                String className,
                                String actionDescription,
                                String errorMessage,
                                String systemAction,
                                String userAction) {
        super(httpCode,
                className,
                actionDescription,
                errorMessage,
                systemAction,
                userAction);
    }


    /**
     * This is the  constructor used for creating a ConnectionCheckedException that resulted from a previous error.
     *
     * @param httpCode          - http response code to use if this exception flows over a rest call
     * @param className         - name of class reporting error
     * @param actionDescription - description of function it was performing when error detected
     * @param errorMessage      - description of error
     * @param systemAction      - actions of the system as a result of the error
     * @param userAction        - instructions for correcting the error
     * @param caughtError       - the error that resulted in this exception.
     */
    public OpenLineageException(int httpCode,
                                String className,
                                String actionDescription,
                                String errorMessage,
                                String systemAction,
                                String userAction,
                                Throwable caughtError) {
        super(httpCode,
                className,
                actionDescription,
                errorMessage,
                systemAction,
                userAction,
                caughtError);
    }
}