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