org.odpi.openmetadata.accessservices.assetlineage.ffdc.package-info Maven / Gradle / Ivy

Go to download

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

API classes for the Asset Lineage Open Metadata Access Service (OMAS).

There is a newer version: 5.0

/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.assetlineage.ffdc;

/**
 * This package provides the first failure data capture support for the Asset Lineage OMAS module.
 * This includes an error code enum, a base class for runtime exceptions, a base class for checked exceptions plus
 * implementation of each specific exception.
 * 
 * The error code enum (AssetLineageErrorCode) has an entry for each unique situation
 * where an exception is returned.  Each entry defines:
 *
 * 

 *     A unique id for the error
 *     An HTTP error code for rest calls
 *     A unique message Id
 *     Message text with place holders for specific values
 *     A description of the cause of the error and system action as a result.
 *     A description of how to correct the error (if known)
 * 
 * 
 * Each exception (whether a checked or runtime exception) has two constructors.
 * The first constructor is used when a new error has been detected.
 * The second constructor is used when another exception has been caught.
 * This caught exception is passed on the constructor so it is effectively
 * embedded in the OMAS exception.
 * 
 * Both constructors take the values from the error code enum to define the cause and resolution.
 */