no.difi.oxalis.api.error.ErrorTracker Maven / Gradle / Ivy

Go to download

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

Holds the stuff required by external components, which may be hooked into Oxalis. Classes and resources in this module should be made available to oxalis-inbound by placing it into a shared library in the web container.

There is a newer version: 4.1.2

Show newest version

package no.difi.oxalis.api.error;

import no.difi.oxalis.api.model.Direction;

/**
 * Defining interface for tracking of exceptions received as result of external communication, both
 * inbound and outbound.
 *
 * @author erlend
 * @since 4.0.2
 */
public interface ErrorTracker {

    /**
     * Method called where errors are gathered.
     *
     * @param direction Direction of transmission where error occurred.
     * @param e The exception triggered.
     * @param handled Whether Oxalis were able to gracefully handle the exception using own relevant exception handling.
     * @return Identifier uniquely identifying the error in the error handling system or logging.
     * @since 4.0.2
     */
    String track(Direction direction, Exception e, boolean handled);

}