[MNG-8410] API cleanup

* Move plugin api to maven-api-plugin * Rename maven-api-meta to maven-api-annotations
apache · Dec 8, 2024 · 9de37db · 9de37db
1 parent 8d4f455
commit 9de37db
Show file tree

Hide file tree

Showing 51 changed files with 93 additions and 106 deletions.
diff --git a/api/maven-api-meta/pom.xml → api/maven-api-annotations/pom.xml b/api/maven-api-meta/pom.xml → api/maven-api-annotations/pom.xml
@@ -26,7 +26,7 @@
     <version>4.0.0-rc-2-SNAPSHOT</version>
   </parent>
 
-  <artifactId>maven-api-meta</artifactId>
+  <artifactId>maven-api-annotations</artifactId>
   <name>Maven 4 API :: Meta annotations</name>
   <description>Maven 4 API - Java meta annotations.</description>
 

diff --git a/.../apache/maven/api/annotations/Config.java → .../apache/maven/api/annotations/Config.java b/.../apache/maven/api/annotations/Config.java → .../apache/maven/api/annotations/Config.java
diff --git a/...pache/maven/api/annotations/Consumer.java → ...pache/maven/api/annotations/Consumer.java b/...pache/maven/api/annotations/Consumer.java → ...pache/maven/api/annotations/Consumer.java
diff --git a/...e/maven/api/annotations/Experimental.java → ...e/maven/api/annotations/Experimental.java b/...e/maven/api/annotations/Experimental.java → ...e/maven/api/annotations/Experimental.java
diff --git a/...ache/maven/api/annotations/Generated.java → ...ache/maven/api/annotations/Generated.java b/...ache/maven/api/annotations/Generated.java → ...ache/maven/api/annotations/Generated.java
diff --git a/...ache/maven/api/annotations/Immutable.java → ...ache/maven/api/annotations/Immutable.java b/...ache/maven/api/annotations/Immutable.java → ...ache/maven/api/annotations/Immutable.java
diff --git a/...apache/maven/api/annotations/Nonnull.java → ...apache/maven/api/annotations/Nonnull.java b/...apache/maven/api/annotations/Nonnull.java → ...apache/maven/api/annotations/Nonnull.java
diff --git a/.../maven/api/annotations/NotThreadSafe.java → .../maven/api/annotations/NotThreadSafe.java b/.../maven/api/annotations/NotThreadSafe.java → .../maven/api/annotations/NotThreadSafe.java
diff --git a/...pache/maven/api/annotations/Nullable.java → ...pache/maven/api/annotations/Nullable.java b/...pache/maven/api/annotations/Nullable.java → ...pache/maven/api/annotations/Nullable.java
diff --git a/...pache/maven/api/annotations/Provider.java → ...pache/maven/api/annotations/Provider.java b/...pache/maven/api/annotations/Provider.java → ...pache/maven/api/annotations/Provider.java
diff --git a/...che/maven/api/annotations/ThreadSafe.java → ...che/maven/api/annotations/ThreadSafe.java b/...che/maven/api/annotations/ThreadSafe.java → ...che/maven/api/annotations/ThreadSafe.java
diff --git a/...e/maven/api/annotations/package-info.java → ...e/maven/api/annotations/package-info.java b/...e/maven/api/annotations/package-info.java → ...e/maven/api/annotations/package-info.java
diff --git a/api/maven-api-meta/src/site/site.xml → api/maven-api-annotations/src/site/site.xml b/api/maven-api-meta/src/site/site.xml → api/maven-api-annotations/src/site/site.xml
diff --git a/api/maven-api-cli/pom.xml b/api/maven-api-cli/pom.xml
@@ -33,7 +33,7 @@
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/api/maven-api-core/pom.xml b/api/maven-api-core/pom.xml
@@ -33,7 +33,7 @@
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Constants.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Constants.java
@@ -19,6 +19,10 @@
 package org.apache.maven.api;
 
 import org.apache.maven.api.annotations.Config;
+import org.apache.maven.api.annotations.Nonnull;
+import org.apache.maven.api.annotations.Nullable;
+
+import java.util.Map;
 
 /**
  * Configuration constants.
@@ -432,5 +436,48 @@ public final class Constants {
     @Config(type = "java.lang.Integer")
     public static final String MAVEN_DEPLOY_SNAPSHOT_BUILD_NUMBER = "maven.deploy.snapshot.buildNumber";
 
+
+    /**
+     * Check if the given feature is active.
+     */
+    public static boolean isEnabled(@Nullable Map<String, String> userProperties, @Nonnull String key) {
+        return doGet(userProperties, key, false);
+    }
+
+    /**
+     * Check if the given feature is active.
+     */
+    public static boolean isEnabled(@Nullable Map<?, ?> userProperties, @Nonnull String key, boolean def) {
+        return doGet(userProperties, key, def);
+    }
+
+    /**
+     * Check if the consumer POM feature is active.
+     */
+    public static boolean isEnabled(@Nullable Session session, @Nonnull String key) {
+        return isEnabled(session != null ? session.getUserProperties() : null, key);
+    }
+
+    /**
+     * Check if the consumer POM feature is active.
+     */
+    public static boolean isEnabled(@Nullable Session session, @Nonnull String key, boolean def) {
+        return isEnabled(session != null ? session.getUserProperties() : null, key, def);
+    }
+
+    private static boolean doGet(Map<?, ?> userProperties, String key, boolean def) {
+        return doGet(userProperties != null ? userProperties.get(key) : null, def);
+    }
+
+    private static boolean doGet(Object val, boolean def) {
+        if (val instanceof Boolean) {
+            return (Boolean) val;
+        } else if (val != null) {
+            return Boolean.parseBoolean(val.toString());
+        } else {
+            return def;
+        }
+    }
+
     private Constants() {}
 }
diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/feature/Features.java b/api/maven-api-core/src/main/java/org/apache/maven/api/feature/Features.java
diff --git a/api/maven-api-metadata/pom.xml b/api/maven-api-metadata/pom.xml
@@ -33,7 +33,7 @@ under the License.
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
   </dependencies>
 

diff --git a/api/maven-api-model/pom.xml b/api/maven-api-model/pom.xml
@@ -34,7 +34,7 @@ under the License.
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/api/maven-api-plugin/pom.xml b/api/maven-api-plugin/pom.xml
@@ -33,7 +33,7 @@ under the License.
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/...e/maven/api/plugin/LifecycleProvider.java → ...e/maven/api/plugin/LifecycleProvider.java b/...e/maven/api/plugin/LifecycleProvider.java → ...e/maven/api/plugin/LifecycleProvider.java
diff --git a/...java/org/apache/maven/api/plugin/Log.java → ...java/org/apache/maven/api/plugin/Log.java b/...java/org/apache/maven/api/plugin/Log.java → ...java/org/apache/maven/api/plugin/Log.java
diff --git a/...ava/org/apache/maven/api/plugin/Mojo.java → ...ava/org/apache/maven/api/plugin/Mojo.java b/...ava/org/apache/maven/api/plugin/Mojo.java → ...ava/org/apache/maven/api/plugin/Mojo.java
diff --git a/...pache/maven/api/plugin/MojoException.java → ...pache/maven/api/plugin/MojoException.java b/...pache/maven/api/plugin/MojoException.java → ...pache/maven/api/plugin/MojoException.java
diff --git a/...e/maven/api/plugin/annotations/After.java → ...e/maven/api/plugin/annotations/After.java b/...e/maven/api/plugin/annotations/After.java → ...e/maven/api/plugin/annotations/After.java
diff --git a/...maven/api/plugin/annotations/Execute.java → ...maven/api/plugin/annotations/Execute.java b/...maven/api/plugin/annotations/Execute.java → ...maven/api/plugin/annotations/Execute.java
diff --git a/...he/maven/api/plugin/annotations/Mojo.java → ...he/maven/api/plugin/annotations/Mojo.java b/...he/maven/api/plugin/annotations/Mojo.java → ...he/maven/api/plugin/annotations/Mojo.java
diff --git a/...ven/api/plugin/annotations/Parameter.java → ...ven/api/plugin/annotations/Parameter.java b/...ven/api/plugin/annotations/Parameter.java → ...ven/api/plugin/annotations/Parameter.java
diff --git a/...en/api/plugin/annotations/Resolution.java → ...en/api/plugin/annotations/Resolution.java b/...en/api/plugin/annotations/Resolution.java → ...en/api/plugin/annotations/Resolution.java
diff --git a/api/maven-api-plugin/src/main/java/org/apache/maven/api/plugin/annotations/package-info.java b/api/maven-api-plugin/src/main/java/org/apache/maven/api/plugin/annotations/package-info.java
@@ -0,0 +1,5 @@
+// CHECKSTYLE_OFF: RegexpHeader
+/**
+ * Maven Plugin Annotations.
+ */
+package org.apache.maven.api.plugin.annotations;
diff --git a/api/maven-api-plugin/src/main/java/org/apache/maven/api/plugin/package-info.java b/api/maven-api-plugin/src/main/java/org/apache/maven/api/plugin/package-info.java
@@ -0,0 +1,5 @@
+// CHECKSTYLE_OFF: RegexpHeader
+/**
+ * Maven Plugin API.
+ */
+package org.apache.maven.api.plugin;
diff --git a/api/maven-api-settings/pom.xml b/api/maven-api-settings/pom.xml
@@ -34,7 +34,7 @@ under the License.
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/api/maven-api-spi/pom.xml b/api/maven-api-spi/pom.xml
@@ -33,7 +33,7 @@
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/api/maven-api-toolchain/pom.xml b/api/maven-api-toolchain/pom.xml
@@ -33,7 +33,7 @@ under the License.
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/api/maven-api-xml/pom.xml b/api/maven-api-xml/pom.xml
@@ -33,7 +33,7 @@
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
   </dependencies>
 

diff --git a/api/pom.xml b/api/pom.xml
@@ -32,7 +32,7 @@
   <description>A new immutable API for Maven 4 to better manage what plugins and extensions can influence.</description>
 
   <modules>
-    <module>maven-api-meta</module>
+    <module>maven-api-annotations</module>
     <module>maven-api-di</module>
     <module>maven-api-xml</module>
     <module>maven-api-model</module>

diff --git a/compat/maven-model-builder/pom.xml b/compat/maven-model-builder/pom.xml
@@ -53,7 +53,7 @@ under the License.
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/compat/maven-model/pom.xml b/compat/maven-model/pom.xml
@@ -44,7 +44,7 @@ under the License.
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/compat/maven-plugin-api/pom.xml b/compat/maven-plugin-api/pom.xml
@@ -40,7 +40,7 @@ under the License.
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/compat/maven-repository-metadata/pom.xml b/compat/maven-repository-metadata/pom.xml
@@ -36,7 +36,7 @@ under the License.
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/compat/maven-settings/pom.xml b/compat/maven-settings/pom.xml
@@ -44,7 +44,7 @@ under the License.
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

diff --git a/compat/maven-toolchain-model/pom.xml b/compat/maven-toolchain-model/pom.xml
@@ -43,7 +43,7 @@ under the License.
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
     <dependency>
       <groupId>org.codehaus.plexus</groupId>

diff --git a/impl/maven-core/src/main/java/org/apache/maven/ReactorReader.java b/impl/maven-core/src/main/java/org/apache/maven/ReactorReader.java
@@ -39,11 +39,12 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Properties;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import org.apache.maven.api.feature.Features;
+import org.apache.maven.api.Constants;
 import org.apache.maven.api.model.Model;
 import org.apache.maven.api.services.Lookup;
 import org.apache.maven.eventspy.EventSpy;
@@ -415,7 +416,8 @@ private boolean isRegularFile(Artifact artifact) {
     private void installIntoProjectLocalRepository(Artifact artifact) {
         String extension = artifact.getExtension();
         String classifier = artifact.getClassifier();
-        if (Features.consumerPom(session.getUserProperties())) {
+        Properties userProperties = session.getUserProperties();
+        if (Constants.isEnabled(userProperties, Constants.MAVEN_CONSUMER_POM, true)) {
             if ("pom".equals(extension)) {
                 if (classifier == null || classifier.isEmpty()) {
                     classifier = "build";

diff --git a/.../org/apache/maven/internal/transformation/impl/DefaultConsumerPomArtifactTransformer.java b/.../org/apache/maven/internal/transformation/impl/DefaultConsumerPomArtifactTransformer.java
@@ -31,10 +31,11 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.CopyOnWriteArraySet;
 
-import org.apache.maven.api.feature.Features;
+import org.apache.maven.api.Constants;
 import org.apache.maven.api.model.Model;
 import org.apache.maven.api.services.ModelBuilderException;
 import org.apache.maven.internal.transformation.ConsumerPomArtifactTransformer;
@@ -80,7 +81,8 @@ public void injectTransformedArtifacts(RepositorySystemSession session, MavenPro
             // If there is no build POM there is no reason to inject artifacts for the consumer POM.
             return;
         }
-        if (Features.consumerPom(session.getUserProperties())) {
+        Map<String, String> userProperties = session.getUserProperties();
+        if (Constants.isEnabled(userProperties, Constants.MAVEN_CONSUMER_POM, true)) {
             Path buildDir =
                     project.getBuild() != null ? Paths.get(project.getBuild().getDirectory()) : null;
             if (buildDir != null) {
@@ -133,14 +135,16 @@ private void doDeleteFiles() {
     }
 
     public InstallRequest remapInstallArtifacts(RepositorySystemSession session, InstallRequest request) {
-        if (Features.consumerPom(session.getUserProperties()) && consumerPomPresent(request.getArtifacts())) {
+        Map<String, String> userProperties = session.getUserProperties();
+        if (Constants.isEnabled(userProperties, Constants.MAVEN_CONSUMER_POM, true) && consumerPomPresent(request.getArtifacts())) {
             request.setArtifacts(replacePom(request.getArtifacts()));
         }
         return request;
     }
 
     public DeployRequest remapDeployArtifacts(RepositorySystemSession session, DeployRequest request) {
-        if (Features.consumerPom(session.getUserProperties()) && consumerPomPresent(request.getArtifacts())) {
+        Map<String, String> userProperties = session.getUserProperties();
+        if (Constants.isEnabled(userProperties, Constants.MAVEN_CONSUMER_POM, true) && consumerPomPresent(request.getArtifacts())) {
             request.setArtifacts(replacePom(request.getArtifacts()));
         }
         return request;

diff --git a/impl/maven-core/src/main/resources/META-INF/maven/extension.xml b/impl/maven-core/src/main/resources/META-INF/maven/extension.xml
@@ -144,9 +144,9 @@ under the License.
 
   <exportedArtifacts>
     <!-- maven 4 api -->
+    <exportedArtifact>org.apache.maven:maven-api-annotations</exportedArtifact>
     <exportedArtifact>org.apache.maven:maven-api-core</exportedArtifact>
     <exportedArtifact>org.apache.maven:maven-api-di</exportedArtifact>
-    <exportedArtifact>org.apache.maven:maven-api-meta</exportedArtifact>
     <exportedArtifact>org.apache.maven:maven-api-metadata</exportedArtifact>
     <exportedArtifact>org.apache.maven:maven-api-model</exportedArtifact>
     <exportedArtifact>org.apache.maven:maven-api-plugin</exportedArtifact>

diff --git a/impl/maven-di/pom.xml b/impl/maven-di/pom.xml
@@ -38,7 +38,7 @@ under the License.
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
     </dependency>
 
     <dependency>

diff --git a/impl/maven-executor/pom.xml b/impl/maven-executor/pom.xml
@@ -41,7 +41,7 @@ under the License.
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
-      <artifactId>maven-api-meta</artifactId>
+      <artifactId>maven-api-annotations</artifactId>
       <scope>provided</scope>
     </dependency>