001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2025 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019import javax.annotation.Nonnull;
020import javax.annotation.concurrent.ThreadSafe;
021
022/**
023 * Contract for handling database statement log events.
024 * <p>
025 * Implementations should be threadsafe.
026 *
027 * @author <a href="https://www.revetkn.com">Mark Allen</a>
028 * @since 1.0.0
029 */
030@ThreadSafe
031@FunctionalInterface
032public interface StatementLogger {
033        /**
034         * Performs a logging operation on the given {@code statementLog}.
035         * <p>
036         * Implementors might choose to no-op, write to stdout or a logging framework, send alerts about slow queries, and so
037         * on.
038         *
039         * @param statementLog The event to log
040         */
041        void log(@Nonnull StatementLog statementLog);
042}