com.google.appengine.tools.admin.CronEntryImpl Maven / Gradle / Ivy
/*
* Copyright 2021 Google LLC
*
* 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
*
* https://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 com.google.appengine.tools.admin;
import com.google.borg.borgcron.GrocTimeSpecification;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Iterator;
import java.util.TimeZone;
/**
* Implementation of the CronEntry interface used to describe a single cron
* task.
*
*/
public class CronEntryImpl implements CronEntry {
private final DateFormat formatter;
private final String url;
private final String description;
private final String schedule;
private final String tz;
public CronEntryImpl(String url, String description, String schedule, String tz) {
this.url = url;
this.description = description;
this.schedule = schedule;
this.tz = (tz == null) ? "UTC" : tz;
formatter = new SimpleDateFormat("EEE MMM dd, yyyy HH:mm z (Z)");
formatter.setTimeZone(TimeZone.getTimeZone(this.tz));
}
@Override
public String getDescription() {
return description;
}
@Override
public Iterator getNextTimesIterator() {
return new TimeIterator(new Date(),
GrocTimeSpecification.create(schedule, TimeZone.getTimeZone(tz)));
}
/**
* Test variant of {@link #getNextTimesIterator()}, with a specified start.
*/
Iterator getNextTimesIterator(Date start) {
return new TimeIterator(start,
GrocTimeSpecification.create(schedule, TimeZone.getTimeZone(tz)));
}
@Override
public String getSchedule() {
return schedule;
}
@Override
public String getTimezone() {
return tz;
}
@Override
public String getUrl() {
return url;
}
@Override
public String toXml() {
String result =
"\n" +
" " + url + " \n" +
" " + schedule + " \n" +
" " + tz + " \n";
if (description != null) {
result = result + " " + description + " \n";
}
return result + " ";
}
/**
* An iterator tracking the last execution time, and the groc time
* specification object to compute future execution times.
*/
public class TimeIterator implements Iterator {
private Date lastRun;
private GrocTimeSpecification groc;
public TimeIterator(Date seedTime, GrocTimeSpecification groc) {
lastRun = seedTime;
this.groc = groc;
}
@Override
public boolean hasNext() {
return true; // the iterator is open-ended
}
@Override
public String next() {
lastRun = groc.getMatch(lastRun);
String result = formatter.format(lastRun);
return result;
}
@Override
public void remove() {
throw new UnsupportedOperationException("cron execution times cannot be removed");
}
}
}