Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply similar pattern as for relocation source #1397

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,127 +18,16 @@
*/
package org.apache.maven.repository.internal;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import org.apache.maven.model.DependencyManagement;
import org.apache.maven.model.DistributionManagement;
import org.apache.maven.model.License;
import org.apache.maven.model.Model;
import org.apache.maven.model.Prerequisites;
import org.apache.maven.model.Repository;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.artifact.ArtifactProperties;
import org.eclipse.aether.artifact.ArtifactType;
import org.eclipse.aether.artifact.ArtifactTypeRegistry;
import org.eclipse.aether.artifact.DefaultArtifact;
import org.eclipse.aether.artifact.DefaultArtifactType;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.graph.Exclusion;
import org.apache.maven.repository.internal.reader.CoreArtifactDescriptorReaderSource;
import org.eclipse.aether.resolution.ArtifactDescriptorResult;

/**
* Populates Aether {@link ArtifactDescriptorResult} from Maven project {@link Model}.
* <p>
* <strong>Note:</strong> This class is part of work in progress and can be changed or removed without notice.
* @since 3.2.4
* @deprecated Use {@link ArtifactDescriptorReaderSource} components instead.
*/
public class ArtifactDescriptorReaderDelegate {
public void populateResult(RepositorySystemSession session, ArtifactDescriptorResult result, Model model) {
ArtifactTypeRegistry stereotypes = session.getArtifactTypeRegistry();

for (Repository r : model.getRepositories()) {
result.addRepository(ArtifactDescriptorUtils.toRemoteRepository(r));
}

for (org.apache.maven.model.Dependency dependency : model.getDependencies()) {
result.addDependency(convert(dependency, stereotypes));
}

DependencyManagement mgmt = model.getDependencyManagement();
if (mgmt != null) {
for (org.apache.maven.model.Dependency dependency : mgmt.getDependencies()) {
result.addManagedDependency(convert(dependency, stereotypes));
}
}

Map<String, Object> properties = new LinkedHashMap<>();

Prerequisites prerequisites = model.getPrerequisites();
if (prerequisites != null) {
properties.put("prerequisites.maven", prerequisites.getMaven());
}

List<License> licenses = model.getLicenses();
properties.put("license.count", licenses.size());
for (int i = 0; i < licenses.size(); i++) {
License license = licenses.get(i);
properties.put("license." + i + ".name", license.getName());
properties.put("license." + i + ".url", license.getUrl());
properties.put("license." + i + ".comments", license.getComments());
properties.put("license." + i + ".distribution", license.getDistribution());
}

result.setProperties(properties);

setArtifactProperties(result, model);
}

private Dependency convert(org.apache.maven.model.Dependency dependency, ArtifactTypeRegistry stereotypes) {
ArtifactType stereotype = stereotypes.get(dependency.getType());
if (stereotype == null) {
stereotype = new DefaultArtifactType(dependency.getType());
}

boolean system = dependency.getSystemPath() != null
&& !dependency.getSystemPath().isEmpty();

Map<String, String> props = null;
if (system) {
props = Collections.singletonMap(ArtifactProperties.LOCAL_PATH, dependency.getSystemPath());
}

Artifact artifact = new DefaultArtifact(
dependency.getGroupId(),
dependency.getArtifactId(),
dependency.getClassifier(),
null,
dependency.getVersion(),
props,
stereotype);

List<Exclusion> exclusions = new ArrayList<>(dependency.getExclusions().size());
for (org.apache.maven.model.Exclusion exclusion : dependency.getExclusions()) {
exclusions.add(convert(exclusion));
}

return new Dependency(
artifact,
dependency.getScope(),
dependency.getOptional() != null ? dependency.isOptional() : null,
exclusions);
}

private Exclusion convert(org.apache.maven.model.Exclusion exclusion) {
return new Exclusion(exclusion.getGroupId(), exclusion.getArtifactId(), "*", "*");
}

private void setArtifactProperties(ArtifactDescriptorResult result, Model model) {
String downloadUrl = null;
DistributionManagement distMgmt = model.getDistributionManagement();
if (distMgmt != null) {
downloadUrl = distMgmt.getDownloadUrl();
}
if (downloadUrl != null && !downloadUrl.isEmpty()) {
Artifact artifact = result.getArtifact();
Map<String, String> props = new HashMap<>(artifact.getProperties());
props.put(ArtifactProperties.DOWNLOAD_URL, downloadUrl);
result.setArtifact(artifact.setProperties(props));
}
}
}
@Deprecated
public class ArtifactDescriptorReaderDelegate extends CoreArtifactDescriptorReaderSource {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.repository.internal;

import org.apache.maven.model.Model;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.resolution.ArtifactDescriptorException;
import org.eclipse.aether.resolution.ArtifactDescriptorResult;

/**
* Component populating Aether {@link ArtifactDescriptorResult} from Maven project {@link Model}.
*
* @since TBD
*/
public interface ArtifactDescriptorReaderSource {
/**
* Method the populates {@link ArtifactDescriptorResult} out of passed in {@link Model}.
*
* @param session The session, never {@code null}.
* @param result The {@link ArtifactDescriptorResult} instance, never {@code null}.
* @param model The {@link Model} instance, never {@code null}.
*/
void populateResult(RepositorySystemSession session, ArtifactDescriptorResult result, Model model)
throws ArtifactDescriptorException;
}
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public class DefaultArtifactDescriptorReader implements ArtifactDescriptorReader
private final ModelBuilder modelBuilder;
private final ModelCacheFactory modelCacheFactory;
private final Map<String, MavenArtifactRelocationSource> artifactRelocationSources;
private final ArtifactDescriptorReaderDelegate delegate;
private final Map<String, ArtifactDescriptorReaderSource> artifactDescriptorReaderSources;

@Inject
public DefaultArtifactDescriptorReader(
Expand All @@ -87,7 +87,8 @@ public DefaultArtifactDescriptorReader(
ModelBuilder modelBuilder,
RepositoryEventDispatcher repositoryEventDispatcher,
ModelCacheFactory modelCacheFactory,
Map<String, MavenArtifactRelocationSource> artifactRelocationSources) {
Map<String, MavenArtifactRelocationSource> artifactRelocationSources,
Map<String, ArtifactDescriptorReaderSource> artifactDescriptorReaderSources) {
this.remoteRepositoryManager =
Objects.requireNonNull(remoteRepositoryManager, "remoteRepositoryManager cannot be null");
this.versionResolver = Objects.requireNonNull(versionResolver, "versionResolver cannot be null");
Expand All @@ -99,7 +100,7 @@ public DefaultArtifactDescriptorReader(
this.modelCacheFactory = Objects.requireNonNull(modelCacheFactory, "modelCacheFactory cannot be null");
this.artifactRelocationSources =
Objects.requireNonNull(artifactRelocationSources, "artifactRelocationSources cannot be null");
this.delegate = new ArtifactDescriptorReaderDelegate();
this.artifactDescriptorReaderSources = artifactDescriptorReaderSources;
}

@Override
Expand All @@ -110,14 +111,24 @@ public ArtifactDescriptorResult readArtifactDescriptor(
Model model = loadPom(session, request, result);
if (model != null) {
Map<String, Object> config = session.getConfigProperties();
ArtifactDescriptorReaderDelegate delegate =
(ArtifactDescriptorReaderDelegate) config.get(ArtifactDescriptorReaderDelegate.class.getName());

// similar logic as before: if configuration contains ArtifactDescriptorReaderSource, use that
ArtifactDescriptorReaderSource delegate =
(ArtifactDescriptorReaderSource) config.get(ArtifactDescriptorReaderSource.class.getName());
if (delegate == null) {
delegate = this.delegate;
// fallback to legacy
delegate =
(ArtifactDescriptorReaderSource) config.get(ArtifactDescriptorReaderDelegate.class.getName());
}

delegate.populateResult(session, result, model);
if (delegate != null) {
delegate.populateResult(session, result, model);
} else {
// the "normal" way is to ask all to populate
for (ArtifactDescriptorReaderSource source : artifactDescriptorReaderSources.values()) {
source.populateResult(session, result, model);
}
}
}

return result;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.repository.internal.reader;

import java.util.*;

import org.apache.maven.model.*;
import org.apache.maven.repository.internal.ArtifactDescriptorReaderSource;
import org.eclipse.aether.artifact.*;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.graph.Exclusion;
import org.eclipse.aether.resolution.ArtifactDescriptorResult;

/**
* Support class for {@link ArtifactDescriptorReaderSource} implementations.
*
* @since TBD
*/
public abstract class ArtifactDescriptorReaderSourceSupport implements ArtifactDescriptorReaderSource {
protected Dependency convert(org.apache.maven.model.Dependency dependency, ArtifactTypeRegistry stereotypes) {
ArtifactType stereotype = stereotypes.get(dependency.getType());
if (stereotype == null) {
stereotype = new DefaultArtifactType(dependency.getType());
}

boolean system = dependency.getSystemPath() != null
&& !dependency.getSystemPath().isEmpty();

Map<String, String> props = null;
if (system) {
props = Collections.singletonMap(ArtifactProperties.LOCAL_PATH, dependency.getSystemPath());
}

Artifact artifact = new DefaultArtifact(
dependency.getGroupId(),
dependency.getArtifactId(),
dependency.getClassifier(),
null,
dependency.getVersion(),
props,
stereotype);

List<Exclusion> exclusions = new ArrayList<>(dependency.getExclusions().size());
for (org.apache.maven.model.Exclusion exclusion : dependency.getExclusions()) {
exclusions.add(convert(exclusion));
}

return new Dependency(
artifact,
dependency.getScope(),
dependency.getOptional() != null ? dependency.isOptional() : null,
exclusions);
}

protected Exclusion convert(org.apache.maven.model.Exclusion exclusion) {
return new Exclusion(exclusion.getGroupId(), exclusion.getArtifactId(), "*", "*");
}

protected void setArtifactProperties(ArtifactDescriptorResult result, Model model) {
String downloadUrl = null;
DistributionManagement distMgmt = model.getDistributionManagement();
if (distMgmt != null) {
downloadUrl = distMgmt.getDownloadUrl();
}
if (downloadUrl != null && !downloadUrl.isEmpty()) {
Artifact artifact = result.getArtifact();
Map<String, String> props = new HashMap<>(artifact.getProperties());
props.put(ArtifactProperties.DOWNLOAD_URL, downloadUrl);
result.setArtifact(artifact.setProperties(props));
}
}
}
Loading
Loading