io.cdap.cdap.app.runtime.ProgramStateWriter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cdap-app-fabric Show documentation
The newest version!
/*
 * Copyright © 2017-2019 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.app.runtime;

import io.cdap.cdap.app.program.ProgramDescriptor;
import io.cdap.cdap.proto.ProgramRunStatus;
import io.cdap.cdap.proto.id.ProgramRunId;
import javax.annotation.Nullable;

/**
 * An interface that defines the behavior for how program states are persisted
 */
public interface ProgramStateWriter {

  /**
   * Updates the program run's status to be {@link ProgramRunStatus#STARTING} at the start time
   * given by the {@link ProgramRunId}
   *
   * @param programRunId the id of the program run
   * @param programOptions the program options
   * @param twillRunId the run id of the twill application
   * @param programDescriptor the program descriptor
   */
  void start(ProgramRunId programRunId, ProgramOptions programOptions, @Nullable String twillRunId,
      ProgramDescriptor programDescriptor);

  /**
   * Updates the program run's status to be {@link ProgramRunStatus#RUNNING} at the given start time
   * in seconds
   *
   * @param programRunId the id of the program run
   * @param twillRunId the run id of the twill application
   */
  void running(ProgramRunId programRunId, @Nullable String twillRunId);

  /**
   * Updates the program run's status to be {@link ProgramRunStatus#STOPPING} at the start time
   * given by the {@link ProgramRunId}
   *
   * @param programRunId the id of the program run
   * @param gracefulShutdownSecs time duration in seconds to wait for program to be terminated
   *     on its own before issuing kill. The value should be Integer.MAX_VALUE if kill shouldn't be
   *     issued.
   */
  void stop(ProgramRunId programRunId, int gracefulShutdownSecs);

  /**
   * Updates the program run's status to be completed
   *
   * @param programRunId the id of the program run
   */
  void completed(ProgramRunId programRunId);

  /**
   * Updates the program run's status to be killed
   *
   * @param programRunId the id of the program run
   */
  void killed(ProgramRunId programRunId);

  /**
   * Updates the program run's status to be failed with a specified failure cause
   *
   * @param programRunId the id of the program run
   * @param failureCause the cause of the failure
   */
  void error(ProgramRunId programRunId, Throwable failureCause);

  /**
   * Updates the program run's status to be suspended
   *
   * @param programRunId the id of the program run
   */
  void suspend(ProgramRunId programRunId);

  /**
   * Updates the program run's status to be resumed
   *
   * @param programRunId the id of the program run
   */
  void resume(ProgramRunId programRunId);

  /**
   * Updates the program run's status to be rejected
   *
   * @param programRunId the id of the program run
   * @param programOptions the program options
   * @param programDescriptor the program descriptor
   * @param userId the user that attempted to run the program
   * @param cause the cause of the failure
   */
  void reject(ProgramRunId programRunId, ProgramOptions programOptions,
      ProgramDescriptor programDescriptor,
      String userId, Throwable cause);
}