twill-core/src/main/java/org/apache/twill/internal/ProcessLauncher.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 org.apache.twill.internal;

import org.apache.twill.api.LocalFile;

import java.util.Map;

/**
 * Class for launching container process.
 *
 * @param <T> Type of the object that contains information about the container that the process is going to launch.
 */
public interface ProcessLauncher<T extends ResourceCapability> {

  /**
   * Returns information about the container that this launch would launch process in.
   */
  T getContainerInfo();

  /**
   * Returns a preparer with the given default set of environments, resources and credentials.
   */
  <C> PrepareLaunchContext prepareLaunch(Map<String, String> environments,
                                         Iterable<LocalFile> resources, C credentials);

  /**
   * For setting up the launcher.
   */
  interface PrepareLaunchContext {

    /**
     * Adds list of files to be localized for the container.
     */
    PrepareLaunchContext addResources(LocalFile...localFiles);

    /**
     * Adds list of files to be localized for the container.
     */
    PrepareLaunchContext addResources(Iterable<LocalFile> localFiles);

    /**
     * Adds a key value pair to the container environment.
     */
    <V> PrepareLaunchContext addEnvironment(String key, V value);

    /**
     * Adds a command line to run in the container process.
     */
    PrepareLaunchContext addCommand(String cmd, String...args);

    /**
     * Launches the container process.
     */
    <R> ProcessController<R> launch();
  }
}