Lean  $LEAN_TAG$
IDownloadProvider.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14 */
15 using System.Collections.Generic;
16 
18 {
19  /// <summary>
20  /// Wrapper on the API for downloading data for an algorithm.
21  /// </summary>
22  public interface IDownloadProvider
23  {
24  /// <summary>
25  /// Method for downloading data for an algorithm
26  /// </summary>
27  /// <param name="address">Source URL to download from</param>
28  /// <param name="headers">Headers to pass to the site</param>
29  /// <param name="userName">Username for basic authentication</param>
30  /// <param name="password">Password for basic authentication</param>
31  /// <returns>String contents of file</returns>
32  string Download(string address, IEnumerable<KeyValuePair<string, string>> headers, string userName, string password);
33 
34  /// <summary>
35  /// Method for downloading data for an algorithm that can be read from a stream
36  /// </summary>
37  /// <param name="address">Source URL to download from</param>
38  /// <param name="headers">Headers to pass to the site</param>
39  /// <param name="userName">Username for basic authentication</param>
40  /// <param name="password">Password for basic authentication</param>
41  /// <returns>String contents of file</returns>
42  byte[] DownloadBytes(string address, IEnumerable<KeyValuePair<string, string>> headers, string userName, string password);
43  }
44 }