JobExecutionDriver.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 gobblin.runtime.api;

import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.RunnableFuture;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.Service;

/**
 * Defines an implementation which knows how to run a GobblinJob and keep track of the progress.
 *
 * <p> The class utilizes the {@link Service} interface.
 * <ul>
 *  <li> {@link Service#startAsync()} starts the execution.
 *  <li> {@link Service#stopAsync()} cancels the execution if running; if the job has completed, it
 *       is a NO-OP
 *  <li> {@link Service#awaitTerminated(long, java.util.concurrent.TimeUnit)} - waits for the job
 *       to complete or get canceled.
 * <ul>
 */
public interface JobExecutionDriver
       extends JobExecutionStateListenerContainer, ListenableFuture<JobExecutionResult>, RunnableFuture<JobExecutionResult> {

  /** The job execution ID */
  JobExecution getJobExecution();
  /** The job execution status */
  JobExecutionStatus getJobExecutionStatus();
  /** The job execution state */
  JobExecutionState getJobExecutionState();
  //TODO add:
  //void stopForcefully();

  /** {@inheritDoc} */
  @Override JobExecutionResult get() throws InterruptedException;

  /** {@inheritDoc} */
  @Override JobExecutionResult get(long timeout, TimeUnit unit)
            throws InterruptedException, TimeoutException;
}