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