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