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.apache.maven.repository.legacy.metadata;
20
21 import java.util.List;
22
23 import org.apache.maven.artifact.Artifact;
24 import org.apache.maven.artifact.repository.ArtifactRepository;
25 import org.apache.maven.artifact.versioning.ArtifactVersion;
26
27 /**
28 * Provides some metadata operations, like querying the remote repository for a list of versions available for an
29 * artifact.
30 *
31 * @author <a href="mailto:jason@maven.org">Jason van Zyl </a>
32 */
33 public interface ArtifactMetadataSource {
34
35 ResolutionGroup retrieve(MetadataResolutionRequest request) throws ArtifactMetadataRetrievalException;
36
37 ResolutionGroup retrieve(
38 Artifact artifact, ArtifactRepository localRepository, List<ArtifactRepository> remoteRepositories)
39 throws ArtifactMetadataRetrievalException;
40
41 /**
42 * Get a list of available versions for an artifact in the remote repository
43 *
44 * @param artifact artifact we are interested in. Only <code>groupid</code> and <code>artifactId</code>
45 * are needed, for instance the following code will work
46 * <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code>
47 * @param localRepository local repository
48 * @param remoteRepositories remote repositories, {@link List} $lt; {@link ArtifactRepository} >
49 * @return {@link List} $lt; {@link ArtifactVersion} >
50 * @throws ArtifactMetadataRetrievalException
51 * in case of error while retrieving repository metadata from the repository.
52 */
53 List<ArtifactVersion> retrieveAvailableVersions(
54 Artifact artifact, ArtifactRepository localRepository, List<ArtifactRepository> remoteRepositories)
55 throws ArtifactMetadataRetrievalException;
56
57 /**
58 * Get a list of available versions for an artifact in the remote deployment repository. This ignores any update
59 * policy checks and mirrors and always retrieves the latest information from the given repository.
60 *
61 * @param artifact artifact we are interested in. Only <code>groupid</code> and <code>artifactId</code> are
62 * needed, for instance the following code will work
63 * <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code>
64 * @param localRepository local repository
65 * @param remoteRepository remote repository
66 * @return {@link List} $lt; {@link ArtifactVersion} >
67 * @throws ArtifactMetadataRetrievalException
68 * in case of error while retrieving repository metadata from the repository.
69 */
70 List<ArtifactVersion> retrieveAvailableVersionsFromDeploymentRepository(
71 Artifact artifact, ArtifactRepository localRepository, ArtifactRepository remoteRepository)
72 throws ArtifactMetadataRetrievalException;
73 }