Skip to content

Advised and Enforced Management #1815

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.

Sign up for GitHub

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

Open
cstamas wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Advised and Enforced Management #1815

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f362ddf
Advised and Enforced Management
cstamas Mar 27, 2026
2ab1352
Use EnumMap for less resource hunger
cstamas Mar 27, 2026
afd8410
Align semantic
cstamas Mar 27, 2026
a14abd6
No need for "empty", use `null`
cstamas Mar 27, 2026
cd189d8
Make exclusions applied as before, enforcing.
cstamas Mar 27, 2026
73f1b9e
Merge remote-tracking branch 'upstream/master' into dep-mgmt-advised
cstamas Mar 27, 2026
edfb4b1
Introduce helper method and use it.
cstamas Mar 27, 2026
17497d2
Add tests for advised/enforced management and fix isRootManager()
gnodet Mar 27, 2026
8895131
Merge remote-tracking branch 'origin/master' into dep-mgmt-advised
cstamas Apr 17, 2026
7d3936b
Merge remote-tracking branch 'upstream/master' into dep-mgmt-advised
cstamas Jun 19, 2026
e61adbb
Apply PR comments, fix since tags
cstamas Jun 19, 2026
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
163 changes: 139 additions & 24 deletions maven-resolver-api/src/main/java/org/eclipse/aether/collection/DependencyManagement.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
package org.eclipse.aether.collection;

import java.util.Collection;
import java.util.EnumMap;
import java.util.EnumSet;
import java.util.Map;

import org.eclipse.aether.graph.Exclusion;
Expand All @@ -29,22 +31,46 @@
* @see DependencyManager#manageDependency(org.eclipse.aether.graph.Dependency)
*/
public final class DependencyManagement {
/**
* Enumeration of manageable attributes, attributes that can be subjected to dependency management.
*
* @since 2.0.19
*/
public enum Subject {
VERSION,
SCOPE,
OPTIONAL,
EXCLUSIONS,
PROPERTIES

@gnodet gnodet Mar 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code on behalf of Guillaume Nodet

Replacing typed fields with Map<Subject, Object> loses compile-time type safety. A mistyped managedValues.put(Subject.VERSION, 42) would compile but fail at runtime with a ClassCastException here.

Consider using EnumMap (better memory for enum keys) and keeping typed fields alongside the enforcement tracking, or introducing a small typed record:

private record ManagedValue<T>(T value, boolean enforced) {}

@cstamas cstamas Mar 27, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maven Resolver 2.x is still Java 8 baseline, so no record yet. Using EnumMap

@gnodet gnodet Mar 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code on behalf of Guillaume Nodet

Good point about the Java 8 baseline. EnumMap is the right choice here. The remaining Map<Subject, Object> type erasure concern is minor given that all setters are type-safe and getters are the only cast points. Acceptable trade-off.

}

private String version;

private String scope;

private Boolean optional;

private Collection<Exclusion> exclusions;

private Map<String, String> properties;
private final EnumMap<Subject, Object> managedValues;
private final EnumSet<Subject> managedEnforced;

/**
* Creates an empty management update.
*/
public DependencyManagement() {
// enables default constructor
this.managedValues = new EnumMap<>(Subject.class);
this.managedEnforced = EnumSet.noneOf(Subject.class);
}

/**
* Returns {@code true} if passed in subject is managed.
*
* @since 2.0.19
*/
public boolean isManagedSubject(Subject subject) {
return managedValues.containsKey(subject);
}

/**
* Returns {@code true} if passed in subject is managed and is enforced.
*
* @since 2.0.19
*/
public boolean isManagedSubjectEnforced(Subject subject) {
return isManagedSubject(subject) && managedEnforced.contains(subject);
}

/**
Expand All @@ -54,18 +80,31 @@ public DependencyManagement() {
* remain unchanged.
*/
public String getVersion() {
return version;
return (String) managedValues.get(Subject.VERSION);
}

/**
* Sets the new version to apply to the dependency.
*
* @param version The new version, may be {@code null} if the version is not managed.
* @return This management update for chaining, never {@code null}.
* @deprecated Use {@link #setVersion(String, boolean)} instead.
*/
@Deprecated
public DependencyManagement setVersion(String version) {
this.version = version;
return this;
return setVersion(version, true);
}

/**
* Sets the new version to apply to the dependency.
*
* @param version The new version, may be {@code null} if the version is not managed.
* @param enforced The enforcement of new value.
* @return This management update for chaining, never {@code null}.
* @since 2.0.19
*/
public DependencyManagement setVersion(String version, boolean enforced) {
return set(Subject.VERSION, version, enforced);
}

/**
Expand All @@ -75,18 +114,31 @@ public DependencyManagement setVersion(String version) {
* unchanged.
*/
public String getScope() {
return scope;
return (String) managedValues.get(Subject.SCOPE);
}

/**
* Sets the new scope to apply to the dependency.
*
* @param scope The new scope, may be {@code null} if the scope is not managed.
* @return This management update for chaining, never {@code null}.
* @deprecated Use {@link #setScope(String, boolean)} instead.
*/
@Deprecated
public DependencyManagement setScope(String scope) {
this.scope = scope;
return this;
return setScope(scope, true);
}

/**
* Sets the new scope to apply to the dependency.
*
* @param scope The new scope, may be {@code null} if the scope is not managed.
* @param enforced The enforcement of new value.
* @return This management update for chaining, never {@code null}.
* @since 2.0.19
*/
public DependencyManagement setScope(String scope, boolean enforced) {
return set(Subject.SCOPE, scope, enforced);
}

/**
Expand All @@ -96,18 +148,31 @@ public DependencyManagement setScope(String scope) {
* dependency should remain unchanged.
*/
public Boolean getOptional() {
return optional;
return (Boolean) managedValues.get(Subject.OPTIONAL);
}

/**
* Sets the new optional flag to apply to the dependency.
*
* @param optional The optional flag, may be {@code null} if the flag is not managed.
* @return This management update for chaining, never {@code null}.
* @deprecated Use {@link #setOptional(Boolean, boolean)} instead.
*/
@Deprecated
public DependencyManagement setOptional(Boolean optional) {
this.optional = optional;
return this;
return setOptional(optional, true);
}

/**
* Sets the new optional flag to apply to the dependency.
*
* @param optional The optional flag, may be {@code null} if the flag is not managed.
* @param enforced The enforcement of new value.
* @return This management update for chaining, never {@code null}.
* @since 2.0.19
*/
public DependencyManagement setOptional(Boolean optional, boolean enforced) {
return set(Subject.OPTIONAL, optional, enforced);
}

/**
Expand All @@ -118,8 +183,9 @@ public DependencyManagement setOptional(Boolean optional) {
* @return The new exclusions or {@code null} if the exclusions are not managed and the existing dependency
* exclusions should remain unchanged.
*/
@SuppressWarnings("unchecked")
public Collection<Exclusion> getExclusions() {
return exclusions;
return (Collection<Exclusion>) managedValues.get(Subject.EXCLUSIONS);
}

/**
Expand All @@ -129,10 +195,25 @@ public Collection<Exclusion> getExclusions() {
*
* @param exclusions The new exclusions, may be {@code null} if the exclusions are not managed.
* @return This management update for chaining, never {@code null}.
* @deprecated Use {@link #setExclusions(Collection, boolean)} instead.
*/
@Deprecated
public DependencyManagement setExclusions(Collection<Exclusion> exclusions) {
this.exclusions = exclusions;
return this;
return setExclusions(exclusions, true);
}

/**
* Sets the new exclusions to apply to the dependency. Note that this collection denotes the complete set of
* exclusions for the dependency, i.e. the dependency manager controls whether any existing exclusions get merged
* with information from dependency management or overridden by it.
*
* @param exclusions The new exclusions, may be {@code null} if the exclusions are not managed.
* @param enforced The enforcement of new value.
* @return This management update for chaining, never {@code null}.
* @since 2.0.19
*/
public DependencyManagement setExclusions(Collection<Exclusion> exclusions, boolean enforced) {
return set(Subject.EXCLUSIONS, exclusions, enforced);
}

/**
Expand All @@ -143,8 +224,9 @@ public DependencyManagement setExclusions(Collection<Exclusion> exclusions) {
* @return The new artifact properties or {@code null} if the properties are not managed and the existing properties
* should remain unchanged.
*/
@SuppressWarnings("unchecked")
public Map<String, String> getProperties() {
return properties;
return (Map<String, String>) managedValues.get(Subject.PROPERTIES);
}

/**
Expand All @@ -154,9 +236,42 @@ public Map<String, String> getProperties() {
*
* @param properties The new artifact properties, may be {@code null} if the properties are not managed.
* @return This management update for chaining, never {@code null}.
* @deprecated Use {@link #setProperties(Map, boolean)} instead.
*/
@Deprecated
public DependencyManagement setProperties(Map<String, String> properties) {
this.properties = properties;
return setProperties(properties, true);
}

/**
* Sets the new properties to apply to the dependency. Note that this map denotes the complete set of properties,
* i.e. the dependency manager controls whether any existing properties get merged with the information from
* dependency management or overridden by it.
*
* @param properties The new artifact properties, may be {@code null} if the properties are not managed.
* @param enforced The enforcement of new value.
* @return This management update for chaining, never {@code null}.
* @since 2.0.19
*/
public DependencyManagement setProperties(Map<String, String> properties, boolean enforced) {
return set(Subject.PROPERTIES, properties, enforced);
}

/**
* Generic but private setter that applies common logic.
*/
private DependencyManagement set(Subject subject, Object value, boolean enforced) {
if (value == null) {
this.managedValues.remove(subject);
this.managedEnforced.remove(subject);
} else {
this.managedValues.put(subject, value);
if (enforced) {
this.managedEnforced.add(subject);
} else {
this.managedEnforced.remove(subject);
}
}
return this;
}
}
Loading