org.dbflute.hook.SqlFireHook Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.dbflute.hook;

import org.dbflute.bhv.core.BehaviorCommandMeta;

/**
 * The hook interface of SQL fires for call-back. 

 * You can hook before-and-finally of all SQL fires.
 * @author jflute
 */
public interface SqlFireHook {

    /**
     * Hook it before the SQL fire.
     * @param meta The meta information of the behavior command. (NotNull)
     * @param fireReadyInfo The information of SQL fire ready. (NotNull)
     */
    void hookBefore(BehaviorCommandMeta meta, SqlFireReadyInfo fireReadyInfo);

    /**
     * Hook it in finally clause after the SQL fire.
     * @param meta The meta information of the behavior command. (NotNull)
     * @param fireResultInfo The information of SQL fire result. (NotNull)
     */
    void hookFinally(BehaviorCommandMeta meta, SqlFireResultInfo fireResultInfo);

    /**
     * Does it inherit the existing hook?
     * @return The determination, true or false.
     */
    default boolean inheritsExistingHook() {
        return true; // inherits as default since 1.1.1
    }
}