View Javadoc

1   package org.apache.maven.repository.legacy.resolver.transform;
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.repository.DefaultRepositoryRequest;
27  import org.apache.maven.artifact.repository.RepositoryRequest;
28  import org.apache.maven.artifact.repository.metadata.ArtifactRepositoryMetadata;
29  import org.apache.maven.artifact.repository.metadata.Metadata;
30  import org.apache.maven.artifact.repository.metadata.RepositoryMetadata;
31  import org.apache.maven.artifact.repository.metadata.RepositoryMetadataManager;
32  import org.apache.maven.artifact.repository.metadata.RepositoryMetadataResolutionException;
33  import org.apache.maven.artifact.repository.metadata.SnapshotArtifactRepositoryMetadata;
34  import org.apache.maven.artifact.repository.metadata.Versioning;
35  import org.apache.maven.artifact.resolver.ArtifactNotFoundException;
36  import org.apache.maven.artifact.resolver.ArtifactResolutionException;
37  import org.apache.maven.repository.legacy.WagonManager;
38  import org.codehaus.plexus.component.annotations.Requirement;
39  import org.codehaus.plexus.logging.AbstractLogEnabled;
40  
41  /**
42   * Describes a version transformation during artifact resolution.
43   *
44   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
45   * @version $Id: AbstractVersionTransformation.java 929691 2010-03-31 19:50:06Z bentmann $
46   * @todo try and refactor to remove abstract methods - not particular happy about current design
47   */
48  public abstract class AbstractVersionTransformation
49      extends AbstractLogEnabled
50      implements ArtifactTransformation
51  {
52      @Requirement
53      protected RepositoryMetadataManager repositoryMetadataManager;
54  
55      @Requirement
56      protected WagonManager wagonManager;
57  
58      public void transformForResolve( Artifact artifact, List<ArtifactRepository> remoteRepositories,
59                                       ArtifactRepository localRepository )
60          throws ArtifactResolutionException, ArtifactNotFoundException
61      {
62          RepositoryRequest request = new DefaultRepositoryRequest();
63          request.setLocalRepository( localRepository );
64          request.setRemoteRepositories( remoteRepositories );
65          transformForResolve( artifact, request );
66      }
67  
68      protected String resolveVersion( Artifact artifact, ArtifactRepository localRepository,
69                                       List<ArtifactRepository> remoteRepositories )
70          throws RepositoryMetadataResolutionException
71      {
72          RepositoryRequest request = new DefaultRepositoryRequest();
73          request.setLocalRepository( localRepository );
74          request.setRemoteRepositories( remoteRepositories );
75          return resolveVersion( artifact, request );
76      }
77  
78      protected String resolveVersion( Artifact artifact, RepositoryRequest request )
79          throws RepositoryMetadataResolutionException
80      {
81          RepositoryMetadata metadata;
82          // Don't use snapshot metadata for LATEST (which isSnapshot returns true for)
83          if ( !artifact.isSnapshot() || Artifact.LATEST_VERSION.equals( artifact.getBaseVersion() ) )
84          {
85              metadata = new ArtifactRepositoryMetadata( artifact );
86          }
87          else
88          {
89              metadata = new SnapshotArtifactRepositoryMetadata( artifact );
90          }
91  
92          repositoryMetadataManager.resolve( metadata, request );
93  
94          artifact.addMetadata( metadata );
95  
96          Metadata repoMetadata = metadata.getMetadata();
97          String version = null;
98          if ( repoMetadata != null && repoMetadata.getVersioning() != null )
99          {
100             version = constructVersion( repoMetadata.getVersioning(), artifact.getBaseVersion() );
101         }
102 
103         if ( version == null )
104         {
105             // use the local copy, or if it doesn't exist - go to the remote repo for it
106             version = artifact.getBaseVersion();
107         }
108 
109         // TODO: also do this logging for other metadata?
110         // TODO: figure out way to avoid duplicated message
111         if ( getLogger().isDebugEnabled() )
112         {
113             if ( !version.equals( artifact.getBaseVersion() ) )
114             {
115                 String message = artifact.getArtifactId() + ": resolved to version " + version;
116                 if ( artifact.getRepository() != null )
117                 {
118                     message += " from repository " + artifact.getRepository().getId();
119                 }
120                 else
121                 {
122                     message += " from local repository";
123                 }
124                 getLogger().debug( message );
125             }
126             else
127             {
128                 // Locally installed file is newer, don't use the resolved version
129                 getLogger().debug( artifact.getArtifactId() + ": using locally installed snapshot" );
130             }
131         }
132         return version;
133     }
134 
135     protected abstract String constructVersion( Versioning versioning, String baseVersion );
136 }