io.cdap.cdap.internal.app.runtime.schedule.constraint.TimeRangeConstraint Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cdap-app-fabric Show documentation
There is a newer version: 6.10.1
/*
 * Copyright © 2017 Cask Data, Inc.
 *
 * 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 io.cdap.cdap.internal.app.runtime.schedule.constraint;

import io.cdap.cdap.internal.app.runtime.schedule.ProgramSchedule;
import io.cdap.cdap.proto.ProtoConstraint;

import java.util.Calendar;
import java.util.TimeZone;

/**
 * A Constraint that defines a time range in which the schedule is allowed to execute.
 */
public class TimeRangeConstraint extends ProtoConstraint.TimeRangeConstraint implements CheckableConstraint {

  // only is satisfied within the range [startTime, endTime)
  // this are transient so they don't get serialized to Json
  private transient int startHour;
  private transient int startMinute;
  private transient int endHour;
  private transient int endMinute;

  private transient boolean isStartTimeSmaller;
  private transient Calendar calendar;

  public TimeRangeConstraint(String startTime, String endTime, TimeZone timeZone) {
    super(startTime, endTime, timeZone);
  }

  @Override
  public void validate() {
    initialize();
  }

  private void initialize() {
    if (calendar == null) {
      ValidationResult vr = doValidate();
      Calendar calendar = vr.getCalendar();

      calendar.setTime(vr.getStartDate());
      startHour = calendar.get(Calendar.HOUR_OF_DAY);
      startMinute = calendar.get(Calendar.MINUTE);

      calendar.setTime(vr.getEndDate());
      endHour = calendar.get(Calendar.HOUR_OF_DAY);
      endMinute = calendar.get(Calendar.MINUTE);

      isStartTimeSmaller = vr.getStartDate().compareTo(vr.getEndDate()) < 0;

      this.calendar = calendar; // do this last, it should only be set if validation was successful
    }
  }

  @Override
  public ConstraintResult check(ProgramSchedule schedule, ConstraintContext context) {
    initialize();
    calendar.setTimeInMillis(context.getCheckTimeMillis());
    int hourOfDay = calendar.get(Calendar.HOUR_OF_DAY);
    int minute = calendar.get(Calendar.MINUTE);

    boolean pastOrEqualStartRange = hourOfDay > startHour || (hourOfDay == startHour && minute >= startMinute);
    boolean pastOrEqualEndRange = hourOfDay > endHour || (hourOfDay == endHour && minute >= endMinute);

    if (isStartTimeSmaller) {
      // [6AM,10PM)
      boolean satisfied = pastOrEqualStartRange && !pastOrEqualEndRange;
      if (satisfied) {
        return ConstraintResult.SATISFIED;
      }
    } else {
      // [10PM,6AM)
      boolean satisfied = pastOrEqualStartRange || !pastOrEqualEndRange;
      if (satisfied) {
        return ConstraintResult.SATISFIED;
      }
    }

    // not satisfied if code execution reaches here
    if (!waitUntilMet) {
      return ConstraintResult.NEVER_SATISFIED;
    }

    // the next satisfy time will always be later today if isStartTimeSmaller is false
    if (pastOrEqualEndRange && isStartTimeSmaller) {
      // we've past the end time range for today
      calendar.add(Calendar.DAY_OF_YEAR, 1);
    }
    calendar.set(Calendar.HOUR_OF_DAY, startHour);
    calendar.set(Calendar.MINUTE, startMinute);
    calendar.set(Calendar.SECOND, 0);
    calendar.set(Calendar.MILLISECOND, 0);
    return new ConstraintResult(ConstraintResult.SatisfiedState.NOT_SATISFIED,
                                calendar.getTimeInMillis());
  }
}