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.runtime.common.driver.api;
020
021import org.apache.reef.annotations.audience.DriverSide;
022import org.apache.reef.annotations.audience.RuntimeAuthor;
023import org.apache.reef.driver.evaluator.EvaluatorProcess;
024import org.apache.reef.runtime.common.files.FileResource;
025import org.apache.reef.tang.Configuration;
026import org.apache.reef.tang.annotations.DefaultImplementation;
027
028import java.util.Set;
029
030/**
031 * Event from Driver Process to Driver Runtime.
032 * A request to the Driver Runtime to launch an Evaluator on the allocated Resource
033 */
034@RuntimeAuthor
035@DriverSide
036@DefaultImplementation(ResourceLaunchEventImpl.class)
037public interface ResourceLaunchEvent {
038
039    /**
040     * @return Id of the resource to launch the Evaluator on
041     */
042  String getIdentifier();
043
044    /**
045     * @return Remote Id for the error handler
046     */
047  String getRemoteId();
048
049    /**
050     * @return Evaluator configuration
051     */
052  Configuration getEvaluatorConf();
053
054    /**
055     * @return Evaluator process to launch
056     */
057  EvaluatorProcess getProcess();
058
059    /**
060     * @return List of libraries local to this Evaluator
061     */
062  Set<FileResource> getFileSet();
063
064  /**
065   * @return name of the runtime to launch the Evaluator on
066   */
067  String getRuntimeName();
068}