View Javadoc
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.impl.resolver;
20  
21  import java.time.Instant;
22  import java.util.Collection;
23  import java.util.Collections;
24  import java.util.LinkedHashMap;
25  import java.util.Map;
26  
27  import org.apache.maven.api.Constants;
28  import org.apache.maven.api.MonotonicClock;
29  import org.eclipse.aether.RepositorySystemSession;
30  import org.eclipse.aether.artifact.Artifact;
31  import org.eclipse.aether.deployment.DeployRequest;
32  import org.eclipse.aether.impl.MetadataGenerator;
33  import org.eclipse.aether.metadata.Metadata;
34  import org.eclipse.aether.util.ConfigUtils;
35  
36  /**
37   * Maven remote GAV level metadata generator.
38   * <p>
39   * Remote snapshot metadata converts artifact on-the-fly to use timestamped snapshot version, and enlist it accordingly.
40   */
41  class RemoteSnapshotMetadataGenerator implements MetadataGenerator {
42  
43      private final Map<Object, RemoteSnapshotMetadata> snapshots;
44  
45      private final Instant timestamp;
46  
47      private final Integer buildNumber;
48  
49      RemoteSnapshotMetadataGenerator(RepositorySystemSession session, DeployRequest request) {
50          timestamp = (Instant) ConfigUtils.getObject(session, MonotonicClock.now(), Constants.MAVEN_START_INSTANT);
51          Object bn = ConfigUtils.getObject(session, null, Constants.MAVEN_DEPLOY_SNAPSHOT_BUILD_NUMBER);
52          if (bn instanceof Integer integer) {
53              this.buildNumber = integer;
54          } else if (bn instanceof String string) {
55              this.buildNumber = Integer.valueOf(string);
56          } else {
57              this.buildNumber = null;
58          }
59  
60          snapshots = new LinkedHashMap<>();
61  
62          /*
63           * NOTE: This should be considered a quirk to support interop with Maven's legacy ArtifactDeployer which
64           * processes one artifact at a time and hence cannot associate the artifacts from the same project to use the
65           * same timestamp+buildno for the snapshot versions. Allowing the caller to pass in metadata from a previous
66           * deployment allows to re-establish the association between the artifacts of the same project.
67           */
68          for (Metadata metadata : request.getMetadata()) {
69              if (metadata instanceof RemoteSnapshotMetadata snapshotMetadata) {
70                  snapshots.put(snapshotMetadata.getKey(), snapshotMetadata);
71              }
72          }
73      }
74  
75      @Override
76      public Collection<? extends Metadata> prepare(Collection<? extends Artifact> artifacts) {
77          for (Artifact artifact : artifacts) {
78              if (artifact.isSnapshot()) {
79                  Object key = RemoteSnapshotMetadata.getKey(artifact);
80                  RemoteSnapshotMetadata snapshotMetadata = snapshots.get(key);
81                  if (snapshotMetadata == null) {
82                      snapshotMetadata = new RemoteSnapshotMetadata(artifact, timestamp, buildNumber);
83                      snapshots.put(key, snapshotMetadata);
84                  }
85                  snapshotMetadata.bind(artifact);
86              }
87          }
88  
89          return snapshots.values();
90      }
91  
92      @Override
93      public Artifact transformArtifact(Artifact artifact) {
94          if (artifact.isSnapshot() && artifact.getVersion().equals(artifact.getBaseVersion())) {
95              Object key = RemoteSnapshotMetadata.getKey(artifact);
96              RemoteSnapshotMetadata snapshotMetadata = snapshots.get(key);
97              if (snapshotMetadata != null) {
98                  artifact = artifact.setVersion(snapshotMetadata.getExpandedVersion(artifact));
99              }
100         }
101 
102         return artifact;
103     }
104 
105     @Override
106     public Collection<? extends Metadata> finish(Collection<? extends Artifact> artifacts) {
107         return Collections.emptyList();
108     }
109 }