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.yarn.driver;
020
021import org.apache.hadoop.yarn.api.records.Container;
022import org.apache.reef.annotations.audience.DriverSide;
023import org.apache.reef.annotations.audience.Public;
024import org.apache.reef.annotations.audience.RuntimeAuthor;
025import org.apache.reef.tang.annotations.DefaultImplementation;
026
027/**
028 * Provides a method to retrieve the rack name from a container, which
029 * may be dependent on the Hadoop distribution.
030 */
031@Public
032@RuntimeAuthor
033@DriverSide
034@DefaultImplementation(DefaultRackNameFormatter.class)
035public interface RackNameFormatter {
036
037  /**
038   * The rack name of the Container.
039   */
040  String getRackName(final Container container);
041}