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.driver;
020
021import org.apache.reef.annotations.Provided;
022import org.apache.reef.annotations.audience.DriverSide;
023import org.apache.reef.annotations.audience.Public;
024import org.apache.reef.tang.Configuration;
025
026/**
027 * Base interface for classes that support the simultaneous submission of both Context and Task configurations.
028 */
029@DriverSide
030@Provided
031@Public
032public interface ContextAndTaskSubmittable {
033  /**
034   * Submit a Context and a Task.
035   * <p>
036   * The semantics of this call are the same as first submitting the context and then, on the fired ActiveContext event
037   * to submit the Task. The performance of this will be better, though as it potentially saves some roundtrips on
038   * the network.
039   * <p>
040   * REEF will not fire an ActiveContext as a result of this. Instead, it will fire a TaskRunning event.
041   *
042   * @param contextConfiguration the Configuration of the EvaluatorContext. See ContextConfiguration for details.
043   * @param taskConfiguration    the Configuration of the Task. See TaskConfiguration for details.
044   */
045  void submitContextAndTask(final Configuration contextConfiguration, final Configuration taskConfiguration);
046
047  /**
048   * Submit a Context with Services and a Task.
049   * <p>
050   * The semantics of this call are the same as first submitting the context and services and then, on the fired
051   * ActiveContext event to submit the Task. The performance of this will be better, though as it potentially saves
052   * some roundtrips on the network.
053   * <p>
054   * REEF will not fire an ActiveContext as a result of this. Instead, it will fire a TaskRunning event.
055   *
056   * @param contextConfiguration
057   * @param serviceConfiguration
058   * @param taskConfiguration
059   */
060  void submitContextAndServiceAndTask(final Configuration contextConfiguration,
061                                      final Configuration serviceConfiguration,
062                                      final Configuration taskConfiguration);
063
064}