001/*
002 * Licensed to DuraSpace under one or more contributor license agreements.
003 * See the NOTICE file distributed with this work for additional information
004 * regarding copyright ownership.
005 *
006 * DuraSpace licenses this file to you under the Apache License,
007 * Version 2.0 (the "License"); you may not use this file except in
008 * compliance with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.fcrepo.http.commons.exceptionhandlers;
019
020import org.slf4j.Logger;
021
022/**
023 * @author barmintor
024 * @since 6/28/16
025 */
026public interface ExceptionDebugLogging {
027    /**
028     * Log a Throwable at the DEBUG level, log the stacktrace at the TRACE level.
029     *
030     * @param context ExceptionDebugLogging the exception intercepting context.
031     * @param error Throwable the intercepted error.
032     * @param logger Logger the logger to use
033     */
034    public default void debugException(ExceptionDebugLogging context, Throwable error, Logger logger) {
035        /**
036         * Because the majority case is not debug logging, trade one additional
037         * accessor call in a guard clause for multiple in message construction
038         * and internal log level checks
039         */
040        if (!logger.isDebugEnabled()) {
041            return;
042        }
043        logger.debug("{} intercepted exception:{} \n", context.getClass()
044                .getSimpleName(), error);
045        logger.trace(error.getMessage(), error);
046    }
047}