Skip to content

Commit

Permalink
[MNG-8043] document new default types, replacing artifact handlers
Browse files Browse the repository at this point in the history
  • Loading branch information
hboutemy committed Apr 23, 2024
1 parent ce87334 commit 860310b
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 5 deletions.
12 changes: 7 additions & 5 deletions maven-core/src/site/apt/artifact-handlers.apt
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,23 @@
~~ under the License.

---
Default Artifact Handlers Reference
Legacy Artifact Handlers Reference
---
Hervé Boutemy
---
2013-08-02
---

Default Artifact Handlers Reference
Legacy Artifact Handlers Reference

Artifact handlers (see {{{../maven-artifact/apidocs/org/apache/maven/artifact/handler/ArtifactHandler.html} API}})
Maven 3 artifact handlers (see {{{../maven-artifact/apidocs/org/apache/maven/artifact/handler/ArtifactHandler.html} API}})
define for each {{{../maven-model/maven.html#class_dependency}dependency type}} information on the artifact
(classifier, extension, language) and how to manage it as dependency (add to classpath, include dependencies).

Some artifact handlers
are configured by default in {{{./apidocs/org/apache/maven/artifact/handler/providers/package-summary.html}<<<org.apache.maven.artifact.handler.providers>>>}} package:
They are replaced in Maven 4 with Maven 4 API Core's {{{../api/maven-api-core/apidocs/org/apache/maven/api/Type.html}Dependency Types}},
with default values defined in {{{../maven-resolver-provider/apidocs/org/apache/maven/repository/internal/type/DefaultTypeProvider.html}DefaultTypeProvider}}.

For compatibility, legacy Maven 3 artifact handlers are still provided:

*--------------------+---------------+------------+------------+-----------+---------------------+-----------------------+
|| type || classifier || extension || packaging || language || added to classpath || includesDependencies ||
Expand Down
74 changes: 74 additions & 0 deletions maven-resolver-provider/src/site/apt/dependency-types.apt
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
~~ 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.

---
Default Dependency Types
---
Hervé Boutemy
---
2024-04-02
---

Default Dependency Types Reference

Defined in <<<DefaultTypeProvider>>>
({{{./apidocs/org/apache/maven/repository/internal/type/DefaultTypeProvider.html}javadoc}},
{{{./xref/org/apache/maven/repository/internal/type/DefaultTypeProvider.html}source}}):

*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
|| type || classifier || extension || language || path types || includesDependencies ||
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
|| Maven || || || || || ||
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<pom>>> | | <= type> | none | | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<bom>>> * | | <<<pom>>> | none | | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<maven-plugin>>> | | <<<jar>>> | java | classes | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
|| Java || || || || || ||
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<jar>>> | | <= type> | java | classes, modules | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<java-source>>> | <<<sources>>> | <<<jar>>> | java | | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<javadoc>>> | <<<javadoc>>> | <<<jar>>> | java | classes | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<test-jar>>> | <<<tests>>> | <<<jar>>> | java | classes, patch module | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<modular-jar>>> * | <<<tests>>> | <<<jar>>> | java | modules | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<classpath-jar>>> * | <<<tests>>> | <<<jar>>> | java | classes | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<fatjar>>> * | <<<tests>>> | <<<jar>>> | java | classes | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
|| Java/Jakarta EE || || || || || ||
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<ejb>>> | | <<<jar>>> | java | classes | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<ejb-client>>> | <<<client>>> | <<<jar>>> | java | classes | |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<war>>> | | <= type> | java | | <<<true>>> |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<ear>>> | | <= type> | java | | <<<true>>> |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<rar>>> | | <= type> | java | | <<<true>>> |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+
| <<<par>>> * | | <= type> | java | | <<<true>>> |
*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+

* = new in Maven 4
2 changes: 2 additions & 0 deletions maven-resolver-provider/src/site/apt/index.apt
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ Maven Artifact Resolver Provider
Main component is <<<MavenRepositorySystemUtils>>>
({{{./apidocs/org/apache/maven/repository/internal/MavenRepositorySystemUtils.html}javadoc}},
{{{./xref/org/apache/maven/repository/internal/MavenRepositorySystemUtils.html}source}}).

See also {{{./dependency-types.html}dependency types}}.

0 comments on commit 860310b

Please sign in to comment.