elephant-scheduler/src/main/java/org/turro/scheduler/task/AbstractTask.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2022 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.scheduler.task;
 
import org.turro.scheduler.task.settings.TaskSettings;
import java.time.Duration;
import java.util.Date;
import java.util.concurrent.ScheduledFuture;
import org.turro.elephant.context.IConstructor;
import org.turro.html.Colors;
import org.turro.log.WebLoggers;
import org.turro.scheduler.motor.Motor;
import org.turro.string.Phrases;
import org.turro.util.Comparison;
 
public abstract class AbstractTask implements Runnable, Comparable<AbstractTask> {
 
  private ScheduledFuture<?> future;
 
  private TaskSettings settings;
  
  private IConstructor constructor;
  private Date lastExecuted;
  
  public void setConstructor(IConstructor constructor) {
    this.constructor = constructor;
  }
 
  public void setSettings(TaskSettings settings) {
    this.settings = settings;
  }
  
  public IConstructor getConstructor() {
    return constructor;
  }
 
  public TaskSettings getSettings() {
    if(settings == null) settings = TaskSettings.from(this);
    return settings;
  }
 
  public void setLastExecuted(Date lastExecuted) {
    this.lastExecuted = lastExecuted;
  }
 
  public boolean isDone() {
    return future == null ? true : future.isDone();
  }
 
  public boolean shouldRun(Date now) {
    if(enoughTimeLapse(now) && settings.shouldRun(now)) {
      return settings.getConstraints().needsRefresh();
    }
    return false;
  }
 
  public void doRun(Motor motor) {
    lastExecuted = new Date();
    future = motor.runTask(this);
  }
 
  public void stop() {
    if(future != null && !future.isDone()) {
      future.cancel(true);
    }
  }
 
  @Override
  public void run() {
    try {
      execute();
    } catch(Exception ex) {
      WebLoggers.warning(this).exception(ex).log();
    }
  }
 
  public abstract boolean isSystem();
  public abstract String getName();
  public abstract String getDataLabel();
  public abstract void execute();
 
  private boolean enoughTimeLapse(Date now) {
    return lastExecuted == null || (Duration.between(lastExecuted.toInstant(), now.toInstant()).getSeconds() >  (60 * 5));
  }
 
  /* Utils */
  
  public String getColor() {
    return Colors.cssByName(isSystem() ? "DarkRed" : "DarkBlue");
  }
  
  public String getIcon() {
    return isSystem() ? "gears" : "user";
  }
  
  public String getDescription() {
    return Phrases.start()
            .add(getName(), "[]")
            .add(getSettings().getDescription())
            .toString();
  }
  
  /* Comparable */
  
  @Override
  public int compareTo(AbstractTask o) {
    return Comparison.ascendant()
            .compare(isSystem(), o.isSystem())
            .compareTo(getSettings().compareTo(o.getSettings()))
            .get();
  }
 
}