org.lastaflute.job.cron4j.Cron4jJobHistory 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.cron4j;

import java.time.LocalDateTime;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import org.dbflute.optional.OptionalThing;
import org.lastaflute.job.LaJobHistory;
import org.lastaflute.job.key.LaJobKey;
import org.lastaflute.job.key.LaJobNote;
import org.lastaflute.job.key.LaJobUnique;
import org.lastaflute.job.log.SavedHistoryCache;
import org.lastaflute.job.subsidiary.EndTitleRoll;
import org.lastaflute.job.subsidiary.ExecResultType;

import it.sauronsoftware.cron4j.TaskExecutor;

/**
 * @author jflute
 * @since 0.2.8 (2017/03/04 Saturday)
 */
public class Cron4jJobHistory implements LaJobHistory {

    // ===================================================================================
    //                                                                       History Cache
    //                                                                       =============
    protected static final SavedHistoryCache historyCache = new SavedHistoryCache();

    public synchronized static OptionalThing find(TaskExecutor taskExecutor) {
        return historyCache.find(generateHistoryKey(taskExecutor));
    }

    public synchronized static void record(TaskExecutor taskExecutor, LaJobHistory jobHistory, int limit) {
        historyCache.record(generateHistoryKey(taskExecutor), jobHistory, limit);
    }

    public synchronized static List list() {
        return historyCache.list();
    }

    public synchronized static void clear() {
        historyCache.clear();
    }

    protected static String generateHistoryKey(TaskExecutor taskExecutor) {
        return taskExecutor.getGuid(); // trust it
    }

    // ===================================================================================
    //                                                                           Attribute
    //                                                                           =========
    protected final LaJobKey jobKey; // not null
    protected final OptionalThing jobNote; // not null
    protected final OptionalThing jobUnique; // not null
    protected final OptionalThing cronExp; // not null
    protected final String jobTypeFqcn; // not null, not save class directly to avoid hot-deploy trouble
    protected final LocalDateTime activationTime; // not null
    protected final OptionalThing beginTime; // not null, empty allowed if no execution
    protected final OptionalThing endTime; // not null, empty allowed if no execution
    protected final ExecResultType execResultType; // not null
    protected final Map endTitleRollSnapshotMap; // not null, empty allowed, read-only
    protected final OptionalThing cause; // not null, empty allowed

    // ===================================================================================
    //                                                                         Constructor
    //                                                                         ===========
    public Cron4jJobHistory(LaJobKey jobKey, OptionalThing jobNote, OptionalThing jobUnique // identity
            , OptionalThing cronExp, String jobTypeFqcn // cron
            , LocalDateTime activationTime, OptionalThing beginTime, OptionalThing endTime // execution time
            , ExecResultType execResultType, OptionalThing endTitleRoll, OptionalThing cause // execution result
    ) {
        this.jobKey = jobKey;
        this.jobNote = jobNote;
        this.jobUnique = jobUnique;
        this.cronExp = cronExp;
        this.jobTypeFqcn = jobTypeFqcn;
        this.activationTime = activationTime;
        this.beginTime = beginTime;
        this.endTime = endTime;
        this.execResultType = execResultType;
        this.endTitleRollSnapshotMap = prepareEndTitleRollSnapshotMap(endTitleRoll);
        this.cause = cause;
    }

    protected Map prepareEndTitleRollSnapshotMap(OptionalThing endTitleRoll) {
        return endTitleRoll.map(roll -> {
            final Map map = new LinkedHashMap();
            roll.getDataMap().forEach((key, value) -> {
                map.put(key, value != null ? value.toString() : null);
            });
            return Collections.unmodifiableMap(map);
        }).orElseGet(() -> {
            return Collections.emptyMap();
        });
    }

    // ===================================================================================
    //                                                                      Basic Override
    //                                                                      ==============
    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder();
        sb.append("history:{");
        sb.append(jobKey);
        sb.append(jobNote.map(title -> ", " + title).orElse(""));
        sb.append(jobUnique.map(uq -> ", " + uq).orElse(""));
        sb.append(cronExp.map(cron -> ", " + cron).orElse(""));
        sb.append(", ").append(jobTypeFqcn);
        sb.append(", ").append(execResultType);
        if (cause != null) {
            sb.append(", ").append(cause.getClass().getSimpleName());
        }
        sb.append("}@").append(Integer.toHexString(hashCode()));
        return sb.toString();
    }

    // ===================================================================================
    //                                                                            Accessor
    //                                                                            ========
    // -----------------------------------------------------
    //                                         Job Attribute
    //                                         -------------
    @Override
    public LaJobKey getJobKey() {
        return jobKey;
    }

    @Override
    public OptionalThing getJobNote() {
        return jobNote;
    }

    @Override
    public OptionalThing getJobUnique() {
        return jobUnique;
    }

    @Override
    public OptionalThing getCronExp() {
        return cronExp;
    }

    @Override
    public String getJobTypeFqcn() {
        return jobTypeFqcn;
    }

    // -----------------------------------------------------
    //                                      Execution Result
    //                                      ----------------
    @Override
    public LocalDateTime getActivationTime() {
        return activationTime;
    }

    @Override
    public OptionalThing getBeginTime() {
        return beginTime;
    }

    @Override
    public OptionalThing getEndTime() {
        return endTime;
    }

    @Override
    public ExecResultType getExecResultType() {
        return execResultType;
    }

    @Override
    public Map getEndTitleRollSnapshotMap() {
        return endTitleRollSnapshotMap;
    }

    @Override
    public OptionalThing getCause() {
        return cause;
    }
}