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