This project has retired. For details please refer to its Attic page.
Source code
001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019
020package org.apache.reef.runtime.multi.client;
021
022import org.apache.reef.annotations.Unstable;
023import org.apache.reef.runtime.multi.utils.avro.AvroMultiRuntimeDefinition;
024import org.apache.reef.tang.annotations.DefaultImplementation;
025
026import java.net.URI;
027
028/**
029 * Defines a contract for a multi runtime definition generator.
030 * The multi runtime avro definition contains all the needed information to instantiate
031 * runtimes inside runtime host.
032 */
033@DefaultImplementation(MultiRuntimeDefinitionGeneratorImpl.class)
034@Unstable
035public interface MultiRuntimeDefinitionGenerator {
036  /**
037   * Generates needed driver configuration modules.
038   *
039   * @param jobFolder      the job folder
040   * @param clientRemoteId the client remote id
041   * @param jobId          the job id
042   * @return Instance of <code>MultiRuntimeDefinition</code>
043   */
044  AvroMultiRuntimeDefinition getMultiRuntimeDefinition(final URI jobFolder,
045                                                       final String clientRemoteId,
046                                                       final String jobId);
047
048}