1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.eclipse.aether.transport.wagon;
20
21 import org.apache.maven.wagon.Wagon;
22
23 /**
24 * A component to acquire and release wagon instances for uploads/downloads.
25 */
26 public interface WagonProvider {
27
28 /**
29 * Acquires a wagon instance that matches the specified role hint. The role hint is derived from the URI scheme,
30 * e.g. "http" or "file".
31 *
32 * @param roleHint The role hint to get a wagon for, must not be {@code null}.
33 * @return The requested wagon instance, never {@code null}.
34 * @throws Exception If no wagon could be retrieved for the specified role hint.
35 */
36 Wagon lookup(String roleHint) throws Exception;
37
38 /**
39 * Releases the specified wagon. A wagon provider may either free any resources allocated for the wagon instance or
40 * return the instance back to a pool for future use.
41 *
42 * @param wagon The wagon to release, may be {@code null}.
43 */
44 void release(Wagon wagon);
45 }