lang/java/reef-runtime-multi/src/main/java/org/apache/reef/runtime/multi/client/MultiRuntimeDefinitionGenerator.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.reef.runtime.multi.client;

import org.apache.reef.annotations.Unstable;
import org.apache.reef.runtime.multi.utils.avro.AvroMultiRuntimeDefinition;
import org.apache.reef.tang.annotations.DefaultImplementation;

import java.net.URI;

/**
 * Defines a contract for a multi runtime definition generator.
 * The multi runtime avro definition contains all the needed information to instantiate
 * runtimes inside runtime host.
 */
@DefaultImplementation(MultiRuntimeDefinitionGeneratorImpl.class)
@Unstable
public interface MultiRuntimeDefinitionGenerator {
  /**
   * Generates needed driver configuration modules.
   *
   * @param jobFolder      the job folder
   * @param clientRemoteId the client remote id
   * @param jobId          the job id
   * @return Instance of <code>MultiRuntimeDefinition</code>
   */
  AvroMultiRuntimeDefinition getMultiRuntimeDefinition(URI jobFolder,
                                                       String clientRemoteId,
                                                       String jobId);

}