1 package org.apache.maven.shared.io.download;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23 import java.util.List;
24
25 import org.apache.maven.shared.io.logging.MessageHolder;
26 import org.apache.maven.wagon.events.TransferListener;
27
28 /**
29 * The Download Manager interface.
30 *
31 */
32 public interface DownloadManager
33 {
34 /**
35 * The Role.
36 */
37 String ROLE = DownloadManager.class.getName();
38
39 /**
40 * @param url The URL.
41 * @param messageHolder {@link MessageHolder}
42 * @return {@link File}
43 * @throws DownloadFailedException in case of exception.
44 */
45 File download( String url, MessageHolder messageHolder )
46 throws DownloadFailedException;
47
48 /**
49 * @param url The URL.
50 * @param transferListeners {@link TransferListener}
51 * @param messageHolder {@link MessageHolder}
52 * @return {@link File}
53 * @throws DownloadFailedException in case of exception.
54 */
55 File download( String url, List<TransferListener> transferListeners, MessageHolder messageHolder )
56 throws DownloadFailedException;
57
58 }