View Javadoc
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   */
34  public interface ArtifactMetadataSource
35  {
36  
37      ResolutionGroup retrieve( MetadataResolutionRequest request )
38          throws ArtifactMetadataRetrievalException;
39  
40      ResolutionGroup retrieve( Artifact artifact, ArtifactRepository localRepository,
41                                List<ArtifactRepository> remoteRepositories )
42          throws ArtifactMetadataRetrievalException;
43  
44      /**
45       * Get a list of available versions for an artifact in the remote repository
46       *
47       * @param artifact           artifact we are interested in. Only <code>groupid</code> and <code>artifactId</code>
48       *                           are needed, for instance the following code will work
49       *                           <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code>
50       * @param localRepository    local repository
51       * @param remoteRepositories remote repositories, {@link List} $lt; {@link ArtifactRepository} &gt;
52       * @return {@link List} $lt; {@link ArtifactVersion} &gt;
53       * @throws ArtifactMetadataRetrievalException
54       *          in case of error while retrieving repository metadata from the repository.
55       */
56      List<ArtifactVersion> retrieveAvailableVersions( Artifact artifact, ArtifactRepository localRepository,
57                                                       List<ArtifactRepository> remoteRepositories )
58          throws ArtifactMetadataRetrievalException;
59  
60      /**
61       * Get a list of available versions for an artifact in the remote deployment repository. This ignores any update
62       * policy checks and mirrors and always retrieves the latest information from the given repository.
63       *
64       * @param artifact artifact we are interested in. Only <code>groupid</code> and <code>artifactId</code> are
65       *            needed, for instance the following code will work
66       *            <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code>
67       * @param localRepository    local repository
68       * @param remoteRepository   remote repository
69       * @return {@link List} $lt; {@link ArtifactVersion} &gt;
70       * @throws ArtifactMetadataRetrievalException
71       *          in case of error while retrieving repository metadata from the repository.
72       */
73      List<ArtifactVersion> retrieveAvailableVersionsFromDeploymentRepository( Artifact artifact,
74                                                                               ArtifactRepository localRepository,
75                                                                               ArtifactRepository remoteRepository )
76          throws ArtifactMetadataRetrievalException;
77  
78  }