io.cdap.cdap.internal.app.runtime.distributed.AbstractTwillProgramController 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 © 2014-2016 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.distributed;

import com.google.common.util.concurrent.Futures;
import io.cdap.cdap.app.runtime.LogLevelUpdater;
import io.cdap.cdap.app.runtime.ProgramController;
import io.cdap.cdap.internal.app.runtime.AbstractProgramController;
import io.cdap.cdap.proto.id.ProgramRunId;
import org.apache.twill.api.RunId;
import org.apache.twill.api.ServiceController;
import org.apache.twill.api.TwillController;
import org.apache.twill.api.logging.LogEntry;
import org.apache.twill.common.Threads;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Map;
import java.util.Set;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import javax.annotation.Nullable;

/**
 * A {@link ProgramController} that control program through twill.
 */
public abstract class AbstractTwillProgramController extends AbstractProgramController
  implements ProgramController, LogLevelUpdater {

  private static final Logger LOG = LoggerFactory.getLogger(AbstractTwillProgramController.class);

  private final TwillController twillController;
  private volatile boolean stopRequested;

  protected AbstractTwillProgramController(ProgramRunId programRunId, TwillController twillController) {
    super(programRunId);
    this.twillController = twillController;
  }

  /**
   * Get the RunId associated with the Twill controller.
   * @return the Twill RunId
   */
  public RunId getTwillRunId() {
    return twillController.getRunId();
  }

  /**
   * Starts listening to TwillController state changes. For internal use only.
   * The listener cannot be binded in constructor to avoid reference leak.
   *
   * @return this instance.
   */
  public ProgramController startListen() {
    twillController.onRunning(() -> {
      LOG.info("Twill program running: {}, twill runId: {}", getProgramRunId(), twillController.getRunId());
      started();
    }, Threads.SAME_THREAD_EXECUTOR);

    twillController.onTerminated(() -> {
      ServiceController.TerminationStatus terminationStatus = twillController.getTerminationStatus();
      LOG.info("Twill program terminated: {}, twill runId: {}, status: {}",
               getProgramRunId(), twillController.getRunId(), terminationStatus);
      if (stopRequested) {
        // Service was killed
        stop();
        return;
      }
      // The terminationStatus shouldn't be null when the twillController state is terminated
      // In case it does (e.g. bug or twill changes), rely on the termination future to determine the state
      if (terminationStatus == null) {
        try {
          Futures.getUnchecked(twillController.terminate());
          complete();
        } catch (Exception e) {
          complete(State.ERROR);
        }
        return;
      }
      // Based on the terminationStatus to set the completion state of the program controller.
      switch (terminationStatus) {
        case SUCCEEDED:
          complete();
          break;
        case FAILED:
          complete(State.ERROR);
          break;
        case KILLED:
          complete(State.KILLED);
          break;
        default:
          // This is just to protect against if more status are added in Twill in future
          complete();
      }
    }, Threads.SAME_THREAD_EXECUTOR);
    return this;
  }

  @Override
  public void updateLogLevels(Map logLevels, @Nullable String componentName) throws Exception {
    if (componentName == null) {
      twillController.updateLogLevels(logLevels).get();
    } else {
      twillController.updateLogLevels(componentName, logLevels).get();
    }
  }

  @Override
  public void resetLogLevels(Set loggerNames, @Nullable String componentName) throws Exception {
    if (componentName == null) {
      twillController.resetLogLevels(loggerNames.toArray(new String[0])).get();
    } else {
      twillController.resetRunnableLogLevels(componentName, loggerNames.toArray(new String[0])).get();
    }
  }

  @Override
  protected final void doSuspend() throws Exception {
    twillController.sendCommand(ProgramCommands.SUSPEND).get();
  }

  @Override
  protected final void doResume() throws Exception {
    twillController.sendCommand(ProgramCommands.RESUME).get();
  }

  @Override
  protected final void doStop() throws Exception {
    stopRequested = true;
    long gracefulTimeoutMillis = getGracefulTimeoutMillis();

    Future terminateFuture;

    if (gracefulTimeoutMillis >= 0) {
      terminateFuture = twillController.terminate(gracefulTimeoutMillis, TimeUnit.MILLISECONDS);
    } else {
      terminateFuture = twillController.terminate();
    }
    Futures.getUnchecked(terminateFuture);
  }

  @Override
  public void kill() {
    stopRequested = true;
    twillController.kill();
  }

  protected final TwillController getTwillController() {
    return twillController;
  }
}