﻿// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Org.Apache.REEF.Tang.Annotations;

namespace Org.Apache.REEF.Client.Yarn.RestClient
{
    [DefaultImplementation(typeof(YarnConfigurationUrlProvider))]
    public interface IUrlProvider
    {
        /// <summary>
        /// Returns list of available Yarn resourcemanager addresses for the environment
        /// For environments with single endpoint/single RM this will be list of size 1.
        /// For environments with multiple RMs with different endpoints this is list of all 
        /// RMs. Client will try all endpoints until successful/the list is exhausted.
        /// </summary>
        /// <returns></returns>
        Task<IEnumerable<Uri>> GetUrlAsync();
    }
}