org.lastaflute.job.log.JobHistoryHook Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lasta-job Show documentation

Job Scheduling for LastaFlute

There is a newer version: 2.0.0

/*
 * Copyright 2015-2017 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.lastaflute.job.log;

import java.util.List;
import java.util.function.Supplier;

import org.lastaflute.job.LaJobHistory;

/**
 * @author jflute
 * @since 0.4.1 (2017/03/20 Monday)
 */
public interface JobHistoryHook {

    /**
     * @param jobHistory The job history provided by LastaJob. (NotNull)
     * @param resource the resource of history, e.g. nativeHistoryLimit (NotNull)
     */
    void hookRecord(LaJobHistory jobHistory, JobHistoryResource resource);

    /**
     * @param nativeSearcher The searcher of LastaJob native histories. (NotNull)
     * @return The list of history, native histories or application histories. (NotNull)
     */
    default List hookList(Supplier> nativeSearcher) {
        return nativeSearcher.get(); // as default
    }

    /**
     * Does it suppress notice log of the hook?
     * @return The determination, true or false.
     */
    default boolean suppressesNoticeLog() { // as you like it
        return false;
    }
}