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 */
019package org.apache.reef.client;
020
021import org.apache.reef.annotations.audience.ClientSide;
022import org.apache.reef.annotations.audience.Public;
023import org.apache.reef.runtime.common.client.REEFImplementation;
024import org.apache.reef.tang.Configuration;
025import org.apache.reef.tang.annotations.DefaultImplementation;
026
027/**
028 * The main entry point into the REEF resourcemanager.
029 * <p>
030 * Every REEF resourcemanager provides an implementation of this interface. That
031 * instance is used to submitTask the Driver class for execution to REEF. As with
032 * all submissions in REEF, this is done in the form of a TANG Configuration
033 * object.
034 */
035@Public
036@ClientSide
037@DefaultImplementation(REEFImplementation.class)
038public interface REEF extends AutoCloseable {
039
040  /**
041   * Close the resourcemanager connection.
042   */
043  @Override
044  void close();
045
046  /**
047   * Submits the Driver set up in the given Configuration for execution.
048   * <p>
049   * The Configuration needs to bind the Driver interface to an actual
050   * implementation of that interface for the job at hand.
051   *
052   * @param driverConf The driver configuration: including everything it needs to execute.  @see DriverConfiguration
053   */
054  void submit(final Configuration driverConf);
055}