[MNG-7553] New clean API with immutable model

apache-maven/src/assembly/maven/bin/m2.conf

@@ -7,4 +7,5 @@ load ${maven.conf}/logging
 optionally ${maven.home}/lib/ext/redisson/*.jar
 optionally ${maven.home}/lib/ext/hazelcast/*.jar
 optionally ${maven.home}/lib/ext/*.jar
+load ${maven.home}/lib/maven-*.jar
 load ${maven.home}/lib/*.jar

apache-maven/src/test/java/org/apache/maven/settings/GlobalSettingsTest.java

@@ -25,7 +25,7 @@
 import java.io.Reader;
 import java.nio.charset.StandardCharsets;
 
-import org.apache.maven.settings.io.xpp3.SettingsXpp3Reader;
+import org.apache.maven.settings.v4.SettingsXpp3Reader;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertTrue;

api/maven-api-core/pom.xml

@@ -0,0 +1,55 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+ 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-api</artifactId>
+ <version>4.0.0-alpha-1-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>maven-api-core</artifactId>
+ <name>Apache Maven Core API</name>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-api-meta</artifactId>
+ <version>4.0.0-alpha-1-SNAPSHOT</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-api-model</artifactId>
+ <version>4.0.0-alpha-1-SNAPSHOT</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-api-settings</artifactId>
+ <version>4.0.0-alpha-1-SNAPSHOT</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven</groupId>
+ <artifactId>maven-api-toolchain</artifactId>
+ <version>4.0.0-alpha-1-SNAPSHOT</version>
+ </dependency>
+ </dependencies>
+
+</project>

api/maven-api-core/src/main/java/org/apache/maven/api/Artifact.java

@@ -0,0 +1,119 @@
+package org.apache.maven.api;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.api.annotations.Experimental;
+import org.apache.maven.api.annotations.Nonnull;
+import org.apache.maven.api.annotations.Immutable;
+
+import java.nio.file.Path;
+import java.util.Optional;
+
+/**
+ * TODO: split between Coordinates / AttachedArtifact / ResolvedArtifact ?
+ * Coordinate: version range
+ * <resolver-version-artifact> : version
+ * ResolvedArtifact: version + file
+ * AttachedArtifact:
+ */
+@Experimental
+@Immutable
+public interface Artifact
+{
+
+ /**
+ * The groupId of the artifact.
+ *
+ * @return The groupId.
+ */
+ @Nonnull
+ String getGroupId();
+
+ /**
+ * The artifactId of the artifact.
+ *
+ * @return The artifactId.
+ */
+ @Nonnull
+ String getArtifactId();
+
+ /**
+ * The classifier of the artifact.
+ *
+ * @return The classifier or an empty string if none, never {@code null}.
+ */
+ @Nonnull
+ String getClassifier();
+
+ /**
+ * The version of the artifact.
+ *
+ * @return The version.
+ */
+ @Nonnull
+ String getVersion();
+
+ /**
+ * The file extension of the artifact.
+ *
+ * @return The extension.
+ */
+ @Nonnull
+ String getExtension();
+
+ /**
+ * Gets the base version of this artifact, for example "1.0-SNAPSHOT". In contrast to the {@link #getVersion()}, the
+ * base version will always refer to the unresolved version.
+ *
+ * @return The base version, never {@code null}.
+ */
+ @Nonnull
+ String getBaseVersion();
+
+ /**
+ * Determines whether this artifact uses a snapshot version.
+ *
+ * @return {@code true} if the artifact is a snapshot, {@code false} otherwise.
+ * @see org.apache.maven.api.Session#isVersionSnapshot(String)
+ */
+ boolean isSnapshot();
+
+ /**
+ * Gets the file of this artifact. Note that only resolved artifacts have a file associated with them. In general,
+ * callers must not assume any relationship between an artifact's filename and its coordinates.
+ *
+ * @return The file or {@link Optional#empty()} if the artifact isn't resolved.
+ */
+ @Nonnull
+ Optional<Path> getPath();
+
+ /**
+ * Unique id identifying this artifact
+ */
+ default String getId()
+ {
+ return getGroupId()
+ + ":" + getArtifactId()
+ + ":" + getExtension()
+ + ( getClassifier().isEmpty() ? "" : ":" + getClassifier() )
+ + ":" + getBaseVersion();
+ }
+
+}

api/maven-api-core/src/main/java/org/apache/maven/api/Dependency.java

@@ -0,0 +1,76 @@
+package org.apache.maven.api;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.api.annotations.Experimental;
+import org.apache.maven.api.annotations.Nonnull;
+import org.apache.maven.api.annotations.Nullable;
+import org.apache.maven.api.annotations.Immutable;
+
+import java.util.Collection;
+
+@Experimental
+@Immutable
+public interface Dependency
+{
+ @Nonnull
+ Artifact getArtifact();
+
+ @Nonnull
+ String getScope();
+
+ @Nullable
+ Boolean getOptional();
+
+ @Nonnull
+ Collection<Exclusion> getExclusions();
+
+ @Nonnull
+ default String getGroupId()
+ {
+ return getArtifact().getGroupId();
+ }
+
+ @Nonnull
+ default String getArtifactId()
+ {
+ return getArtifact().getArtifactId();
+ }
+
+ @Nonnull
+ default String getVersion()
+ {
+ return getArtifact().getVersion();
+ }
+
+ @Nonnull
+ default String getType()
+ {
+ // TODO
+ throw new UnsupportedOperationException( "Not implemented yet" );
+ }
+
+ @Nonnull
+ default String getClassifier()
+ {
+ return getArtifact().getClassifier();
+ }
+
+}

api/maven-api-core/src/main/java/org/apache/maven/api/Event.java

@@ -0,0 +1,75 @@
+package org.apache.maven.api;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.api.annotations.Experimental;
+import org.apache.maven.api.annotations.Nonnull;
+
+import java.util.Optional;
+
+/**
+ * Event sent by maven during various phases of the build process.
+ * Such events can be listened to using {@link Listener}s objects
+ * registered in the {@link Session}.
+ */
+@Experimental
+public interface Event
+{
+
+ /**
+ * Gets the type of the event.
+ *
+ * @return The type of the event, never {@code null}.
+ */
+ @Nonnull
+ EventType getType();
+
+ /**
+ * Gets the session from which this event originates.
+ *
+ * @return The current session, never {@code null}.
+ */
+ @Nonnull
+ Session getSession();
+
+ /**
+ * Gets the current project (if any).
+ *
+ * @return The current project or {@code empty()} if not applicable.
+ */
+ @Nonnull
+ Optional<Project> getProject();
+
+ /**
+ * Gets the current mojo execution (if any).
+ *
+ * @return The current mojo execution or {@code empty()} if not applicable.
+ */
+ @Nonnull
+ Optional<MojoExecution> getMojoExecution();
+
+ /**
+ * Gets the exception that caused the event (if any).
+ *
+ * @return The exception or {@code empty()} if none.
+ */
+ Optional<Exception> getException();
+
+}

api/maven-api-core/src/main/java/org/apache/maven/api/EventType.java

@@ -0,0 +1,51 @@
+package org.apache.maven.api;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.api.annotations.Experimental;
+
+/**
+ * The possible types of execution events.
+ *
+ * TODO: those values are lower cased, while other events are upper-case
+ * we need to align on one strategy
+ * see also {@link MetadataStorage} and {@link org.apache.maven.api.services.ResolutionScope}
+ */
+@Experimental
+public enum EventType
+{
+ ProjectDiscoveryStarted,
+ SessionStarted,
+ SessionEnded,
+ ProjectSkipped,
+ ProjectStarted,
+ ProjectSucceeded,
+ ProjectFailed,
+ MojoSkipped,
+ MojoStarted,
+ MojoSucceeded,
+ MojoFailed,
+ ForkStarted,
+ ForkSucceeded,
+ ForkFailed,
+ ForkedProjectStarted,
+ ForkedProjectSucceeded,
+ ForkedProjectFailed,
+}