1 package org.eclipse.aether.transport.wagon;
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 org.apache.maven.wagon.Wagon;
23
24 /**
25 * A component to acquire and release wagon instances for uploads/downloads.
26 */
27 public interface WagonProvider
28 {
29
30 /**
31 * Acquires a wagon instance that matches the specified role hint. The role hint is derived from the URI scheme,
32 * e.g. "http" or "file".
33 *
34 * @param roleHint The role hint to get a wagon for, must not be {@code null}.
35 * @return The requested wagon instance, never {@code null}.
36 * @throws Exception If no wagon could be retrieved for the specified role hint.
37 */
38 Wagon lookup( String roleHint )
39 throws Exception;
40
41 /**
42 * Releases the specified wagon. A wagon provider may either free any resources allocated for the wagon instance or
43 * return the instance back to a pool for future use.
44 *
45 * @param wagon The wagon to release, may be {@code null}.
46 */
47 void release( Wagon wagon );
48
49 }