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.context;
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.driver.evaluator.EvaluatorDescriptor;
025import org.apache.reef.io.naming.Identifiable;
026import org.apache.reef.util.Optional;
027
028/**
029 * A common base interface for all Driver-side representations of Contexts.
030 */
031@Public
032@DriverSide
033@Provided
034public interface ContextBase extends Identifiable {
035
036  /**
037   * @return the ID of the Context.
038   */
039  @Override
040  String getId();
041
042  /**
043   * @return the identifier of the Evaluator this Context is instantiated on.
044   */
045  String getEvaluatorId();
046
047  /**
048   * @return the ID of the parent context, if there is one.
049   */
050  Optional<String> getParentId();
051
052  /**
053   * @return the descriptor of the Evaluator this Context is on.
054   */
055  EvaluatorDescriptor getEvaluatorDescriptor();
056}