You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by GitBox <gi...@apache.org> on 2020/06/12 17:41:30 UTC
[GitHub] [maven-resolver] kwin opened a new pull request #54: MRESOLVER-116 document configuration options
kwin opened a new pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on a change in pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on a change in pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#discussion_r443825556
##########
File path: src/site/markdown/configuration.md
##########
@@ -2,41 +2,42 @@
Option | Type | Description | Default Value | Supports Repo ID Suffix
--- | --- | --- | --- | --- | --- | ---
-`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
-`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
-`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
-`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
-`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
-`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
-`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.smartChecksums` | Boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract it from the actual artifact requests's response header named `ETag` in format `SHA1{<checksum>}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA1. | `true` | no
`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
-`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) passed to [MessageDigest](https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html). for which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest) passed to [MessageDigest](hhttps://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html) with which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
`aether.dependencyCollector.maxExceptions` | Integer | Only exceptions up to the number given in this configuration property are emitted. Exceptions which exceed that number are swallowed. | `50` | no
`aether.dependencyCollector.maxCycles` | Integer | Only up to the given amount cyclic dependencies are emitted. | `10` | no
-`aether.artifactResolver.snapshotNormalization` | Boolean | ? | `true` | no
-`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4`| no
+`aether.dependencyManager.verbose` | Boolean | A flag controlling the verbose mode for dependency management. If enabled, the original attributes of a dependency before its update due to dependency managemnent will be recorded in the node's `DependencyNode#getData()` when building a dependency graph. | `false` | no
+`aether.artifactResolver.snapshotNormalization` | Boolean | It replaces the the timestamped snapshot file name with a filename containing SNAPSHOT only. This only affects resolving/retrieving artifacts but not uploading those. | `true` | no
Review comment:
> `SNAPSHOT` qualifier only.
##########
File path: src/site/markdown/configuration.md
##########
@@ -2,41 +2,42 @@
Option | Type | Description | Default Value | Supports Repo ID Suffix
--- | --- | --- | --- | --- | --- | ---
-`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
-`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
-`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
-`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
-`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
-`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
-`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.smartChecksums` | Boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract it from the actual artifact requests's response header named `ETag` in format `SHA1{<checksum>}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA1. | `true` | no
`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
-`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) passed to [MessageDigest](https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html). for which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest) passed to [MessageDigest](hhttps://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html) with which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
Review comment:
hhttps => hhttps
##########
File path: src/site/markdown/configuration.md
##########
@@ -2,41 +2,42 @@
Option | Type | Description | Default Value | Supports Repo ID Suffix
--- | --- | --- | --- | --- | --- | ---
-`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
-`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
-`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
-`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
-`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
-`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
-`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.smartChecksums` | Boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract it from the actual artifact requests's response header named `ETag` in format `SHA1{<checksum>}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA1. | `true` | no
Review comment:
I will look at this one again.
##########
File path: src/site/markdown/configuration.md
##########
@@ -2,41 +2,42 @@
Option | Type | Description | Default Value | Supports Repo ID Suffix
--- | --- | --- | --- | --- | --- | ---
-`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
-`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
-`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
-`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
-`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
-`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
-`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.smartChecksums` | Boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract it from the actual artifact requests's response header named `ETag` in format `SHA1{<checksum>}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA1. | `true` | no
`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
-`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) passed to [MessageDigest](https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html). for which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest) passed to [MessageDigest](hhttps://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html) with which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
`aether.dependencyCollector.maxExceptions` | Integer | Only exceptions up to the number given in this configuration property are emitted. Exceptions which exceed that number are swallowed. | `50` | no
`aether.dependencyCollector.maxCycles` | Integer | Only up to the given amount cyclic dependencies are emitted. | `10` | no
-`aether.artifactResolver.snapshotNormalization` | Boolean | ? | `true` | no
-`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4`| no
+`aether.dependencyManager.verbose` | Boolean | A flag controlling the verbose mode for dependency management. If enabled, the original attributes of a dependency before its update due to dependency managemnent will be recorded in the node's `DependencyNode#getData()` when building a dependency graph. | `false` | no
+`aether.artifactResolver.snapshotNormalization` | Boolean | It replaces the the timestamped snapshot file name with a filename containing SNAPSHOT only. This only affects resolving/retrieving artifacts but not uploading those. | `true` | no
+`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4` | no
`aether.enhancedLocalRepository.trackingFilename` | String | Filename of the file in which to track the remote repositories. | `"_remote.repositories"` | no
`aether.offline.protocols` | String | Comma-separated list of protocols which are supposed to be resolved offline. | - | no
`aether.offline.hosts` | String | Comma-separated list of hosts which are supposed to be resolved offline. | - | no
-`aether.updateCheckManager.sessionState` | String | ? | `true` | no
+`aether.updateCheckManager.sessionState` | String | Manages the session state, i.e. influences if the same download requests to artifacts/metadata will happen multiple times within the same RepositorySystemSession. If `"true"` will enable the session state. If `"bypass"` will enable bypassing (i.e. store all artifact ids/metadata ids which have been updates but not evaluating those). All other values lead to disabling the session state completely. | `"true"` | no
-All properties which have `yes` in the column `Supports Repo ID Suffix` can be optionally configured specifically for a repository id. In that case the configuration property needs to be suffixed with the repository id of the repository to configure.
+All properties which have `yes` in the column `Supports Repo ID Suffix` can be optionally configured specifically for a repository id. In that case the configuration property needs to be suffixed with a comma followed by the repository id of the repository to configure, e.g. `aether.connector.http.headers.central` for repository with id `central`.
Review comment:
You obviously meant period and not comma, didn't you?
##########
File path: src/site/markdown/configuration.md
##########
@@ -2,41 +2,42 @@
Option | Type | Description | Default Value | Supports Repo ID Suffix
--- | --- | --- | --- | --- | --- | ---
-`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
-`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
-`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
-`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
-`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
-`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
-`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.smartChecksums` | Boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract it from the actual artifact requests's response header named `ETag` in format `SHA1{<checksum>}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA1. | `true` | no
`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
-`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) passed to [MessageDigest](https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html). for which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest) passed to [MessageDigest](hhttps://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html) with which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
`aether.dependencyCollector.maxExceptions` | Integer | Only exceptions up to the number given in this configuration property are emitted. Exceptions which exceed that number are swallowed. | `50` | no
`aether.dependencyCollector.maxCycles` | Integer | Only up to the given amount cyclic dependencies are emitted. | `10` | no
-`aether.artifactResolver.snapshotNormalization` | Boolean | ? | `true` | no
-`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4`| no
+`aether.dependencyManager.verbose` | Boolean | A flag controlling the verbose mode for dependency management. If enabled, the original attributes of a dependency before its update due to dependency managemnent will be recorded in the node's `DependencyNode#getData()` when building a dependency graph. | `false` | no
+`aether.artifactResolver.snapshotNormalization` | Boolean | It replaces the the timestamped snapshot file name with a filename containing SNAPSHOT only. This only affects resolving/retrieving artifacts but not uploading those. | `true` | no
+`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4` | no
`aether.enhancedLocalRepository.trackingFilename` | String | Filename of the file in which to track the remote repositories. | `"_remote.repositories"` | no
`aether.offline.protocols` | String | Comma-separated list of protocols which are supposed to be resolved offline. | - | no
`aether.offline.hosts` | String | Comma-separated list of hosts which are supposed to be resolved offline. | - | no
-`aether.updateCheckManager.sessionState` | String | ? | `true` | no
+`aether.updateCheckManager.sessionState` | String | Manages the session state, i.e. influences if the same download requests to artifacts/metadata will happen multiple times within the same RepositorySystemSession. If `"true"` will enable the session state. If `"bypass"` will enable bypassing (i.e. store all artifact ids/metadata ids which have been updates but not evaluating those). All other values lead to disabling the session state completely. | `"true"` | no
Review comment:
Don't quote boolean as you didn't quote them throughout.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#issuecomment-647048930
How did you determine the list of properties?
At least these are missing:
* `aether.connector.basic.threads`
* `aether.dependencyManager.verbose`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] kwin commented on a change in pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
kwin commented on a change in pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#discussion_r443979555
##########
File path: src/site/markdown/configuration.md
##########
@@ -2,41 +2,42 @@
Option | Type | Description | Default Value | Supports Repo ID Suffix
--- | --- | --- | --- | --- | --- | ---
-`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
-`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
-`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
-`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
-`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
-`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
-`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.smartChecksums` | Boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract it from the actual artifact requests's response header named `ETag` in format `SHA1{<checksum>}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA1. | `true` | no
`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
-`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) passed to [MessageDigest](https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html). for which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest) passed to [MessageDigest](hhttps://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html) with which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
`aether.dependencyCollector.maxExceptions` | Integer | Only exceptions up to the number given in this configuration property are emitted. Exceptions which exceed that number are swallowed. | `50` | no
`aether.dependencyCollector.maxCycles` | Integer | Only up to the given amount cyclic dependencies are emitted. | `10` | no
-`aether.artifactResolver.snapshotNormalization` | Boolean | ? | `true` | no
-`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4`| no
+`aether.dependencyManager.verbose` | Boolean | A flag controlling the verbose mode for dependency management. If enabled, the original attributes of a dependency before its update due to dependency managemnent will be recorded in the node's `DependencyNode#getData()` when building a dependency graph. | `false` | no
+`aether.artifactResolver.snapshotNormalization` | Boolean | It replaces the the timestamped snapshot file name with a filename containing SNAPSHOT only. This only affects resolving/retrieving artifacts but not uploading those. | `true` | no
+`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4` | no
`aether.enhancedLocalRepository.trackingFilename` | String | Filename of the file in which to track the remote repositories. | `"_remote.repositories"` | no
`aether.offline.protocols` | String | Comma-separated list of protocols which are supposed to be resolved offline. | - | no
`aether.offline.hosts` | String | Comma-separated list of hosts which are supposed to be resolved offline. | - | no
-`aether.updateCheckManager.sessionState` | String | ? | `true` | no
+`aether.updateCheckManager.sessionState` | String | Manages the session state, i.e. influences if the same download requests to artifacts/metadata will happen multiple times within the same RepositorySystemSession. If `"true"` will enable the session state. If `"bypass"` will enable bypassing (i.e. store all artifact ids/metadata ids which have been updates but not evaluating those). All other values lead to disabling the session state completely. | `"true"` | no
Review comment:
It really is a string here!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#issuecomment-647046258
As far as I understand the code for `aether.connector.smartChecksums` it instructs Resolver to validate the checksums from remote with the checksums calculated by Resolver.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#issuecomment-647048109
`sessionState` is used in `DefaultUpdateCheckManager`. Have a look at the code.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] kwin commented on pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
kwin commented on pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#issuecomment-643402830
Help appreciated for the configuration properties marked with `?`
1. `aether.connector.smartChecksums`
1. `aether.artifactResolver.snapshotNormalization`
1. `aether.updateCheckManager.sessionState`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on a change in pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on a change in pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#discussion_r444049553
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,46 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
+`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
+`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
+`aether.connector.smartChecksums` | Boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract it from the actual artifact requests's response header named `ETag` in format `SHA1{<checksum>}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA1. | `true` | no
+`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
+`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest) passed to [MessageDigest](hhttps://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html) with which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.dependencyCollector.maxExceptions` | Integer | Only exceptions up to the number given in this configuration property are emitted. Exceptions which exceed that number are swallowed. | `50` | no
+`aether.dependencyCollector.maxCycles` | Integer | Only up to the given amount cyclic dependencies are emitted. | `10` | no
+`aether.dependencyManager.verbose` | Boolean | A flag controlling the verbose mode for dependency management. If enabled, the original attributes of a dependency before its update due to dependency managemnent will be recorded in the node's `DependencyNode#getData()` when building a dependency graph. | `false` | no
+`aether.artifactResolver.snapshotNormalization` | Boolean | It replaces the the timestamped snapshot file name with a filename containing SNAPSHOT only. This only affects resolving/retrieving artifacts but not uploading those. | `true` | no
+`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4` | no
+`aether.enhancedLocalRepository.trackingFilename` | String | Filename of the file in which to track the remote repositories. | `"_remote.repositories"` | no
+`aether.offline.protocols` | String | Comma-separated list of protocols which are supposed to be resolved offline. | - | no
+`aether.offline.hosts` | String | Comma-separated list of hosts which are supposed to be resolved offline. | - | no
+`aether.updateCheckManager.sessionState` | String | Manages the session state, i.e. influences if the same download requests to artifacts/metadata will happen multiple times within the same RepositorySystemSession. If `"true"` will enable the session state. If `"bypass"` will enable bypassing (i.e. store all artifact ids/metadata ids which have been updates but not evaluating those). All other values lead to disabling the session state completely. | `"true"` | no
Review comment:
Created #62
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] asfgit closed pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#issuecomment-643662741
This is up next after all other assigned tickets.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#issuecomment-647046620
`aether.artifactResolver.snapshotNormalization` is obvious in the code: It replaces the the timestamped snapshot file name with a filename containing `SNAPSHOT` only.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on a change in pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on a change in pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#discussion_r444035266
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,56 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`aether.artifactResolver.snapshotNormalization` | boolean | It replaces the timestamped snapshot file name with a filename containing SNAPSHOT qualifier only. This only affects resolving/retrieving artifacts but not uploading those. | `true` | no
+`aether.checksums.forSignature` | boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest) passed to [MessageDigest](https://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html) with which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.conflictResolver.verbose` | boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | int | Number of threads to use for uploading/downloading. | `5` | no
+`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
+`aether.connector.connectTimeout` | long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.http.cacheState` | boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
+`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
+`aether.connector.persistedChecksums` | boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
+`aether.connector.resumeDownloads` | boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.smartChecksums` | boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract the reference checksum from the actual artifact requests's response header named `ETag` in format `{SHA1{<checksum>}}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA-1. | `true` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.dependencyCollector.maxCycles` | int | Only up to the given amount cyclic dependencies are emitted. | `10` | no
+`aether.dependencyCollector.maxExceptions` | int | Only exceptions up to the number given in this configuration property are emitted. Exceptions which exceed that number are swallowed. | `50` | no
+`aether.dependencyManager.verbose` | boolean | A flag controlling the verbose mode for dependency management. If enabled, the original attributes of a dependency before its update due to dependency managemnent will be recorded in the node's `DependencyNode#getData()` when building a dependency graph. | `false` | no
+`aether.enhancedLocalRepository.trackingFilename` | String | Filename of the file in which to track the remote repositories. | `"_remote.repositories"` | no
+`aether.interactive` | boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.metadataResolver.threads` | int | Number of threads to use in parallel for resolving metadata. | `4` | no
+`aether.offline.protocols` | String | Comma-separated list of protocols which are supposed to be resolved offline. | - | no
+`aether.offline.hosts` | String | Comma-separated list of hosts which are supposed to be resolved offline. | - | no
+`aether.priority.<class>` | float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.snapshotFilter` | boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.updateCheckManager.sessionState` | String | Manages the session state, i.e. influences if the same download requests to artifacts/metadata will happen multiple times within the same RepositorySystemSession. If `"true"` will enable the session state. If `"bypass"` will enable bypassing (i.e. store all artifact ids/metadata ids which have been updates but not evaluating those). All other values lead to disabling the session state completely. | `"true"` | no
+
+All properties which have `yes` in the column `Supports Repo ID Suffix` can be optionally configured specifically for a repository id. In that case the configuration property needs to be suffixed with a period followed by the repository id of the repository to configure, e.g. `aether.connector.http.headers.central` for repository with id `central`.
+
+## Property Type Conversion
+
+If the value is not given in the target type the following conversions are applied.
+
+From | To | With
+--- | --- | ---
+`String` | `boolean` | [`Boolean.parseBoolean(...)`](https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html#parseBoolean(java.lang.String))
+`String` | `int` | [`Integer.valueOf(...)`](https://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html#valueOf(java.lang.String))
+`String` | `long` | [`Long.valueOf(...)`](https://docs.oracle.com/javase/7/docs/api/java/lang/Long.html#valueOf(java.lang.String))
+`String` | `float` | [`Float.valueOf(...)`](https://docs.oracle.com/javase/7/docs/api/java/lang/Float.html#valueOf(java.lang.String))
Review comment:
This does not correspond to #61 anymore.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#issuecomment-647622014
>
>
> > Please use a consistent Java version which we support as a minimum.
>
> I don't get this remark as this is only about a documentation update. I changed nothing about java versions. Please elaborate.
The Java security links refer to Java 11 which we don't use/require. Our minimum version is 7. Therefore, the links shall use this one.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] kwin commented on a change in pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
kwin commented on a change in pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#discussion_r443665135
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,45 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
Review comment:
You are right, IMHO those are configurable from Maven either. Will create a dedicated bug report to make both Map<> and List<> work with the system properties used by Maven.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] kwin commented on pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
kwin commented on pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#issuecomment-647609484
> Please use a consistent Java version which we support as a minimum.
I don't get this remark as this is only about a documentation update. I changed nothing about java versions. Please elaborate.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on a change in pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on a change in pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#discussion_r443844634
##########
File path: src/site/markdown/configuration.md
##########
@@ -2,41 +2,42 @@
Option | Type | Description | Default Value | Supports Repo ID Suffix
--- | --- | --- | --- | --- | --- | ---
-`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
-`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
-`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
-`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
-`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
-`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
-`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.smartChecksums` | Boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract it from the actual artifact requests's response header named `ETag` in format `SHA1{<checksum>}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA1. | `true` | no
Review comment:
* This is almost correct, but the format is for Nexus 2.14.18: `"{SHA1{<checksum>}}"`.
* Correct SHA1 to SHA-1 in the last sentence.
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,46 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
+`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
+`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
+`aether.connector.smartChecksums` | Boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract it from the actual artifact requests's response header named `ETag` in format `SHA1{<checksum>}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA1. | `true` | no
+`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
+`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest) passed to [MessageDigest](hhttps://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html) with which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.dependencyCollector.maxExceptions` | Integer | Only exceptions up to the number given in this configuration property are emitted. Exceptions which exceed that number are swallowed. | `50` | no
+`aether.dependencyCollector.maxCycles` | Integer | Only up to the given amount cyclic dependencies are emitted. | `10` | no
+`aether.dependencyManager.verbose` | Boolean | A flag controlling the verbose mode for dependency management. If enabled, the original attributes of a dependency before its update due to dependency managemnent will be recorded in the node's `DependencyNode#getData()` when building a dependency graph. | `false` | no
+`aether.artifactResolver.snapshotNormalization` | Boolean | It replaces the the timestamped snapshot file name with a filename containing SNAPSHOT only. This only affects resolving/retrieving artifacts but not uploading those. | `true` | no
+`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4` | no
+`aether.enhancedLocalRepository.trackingFilename` | String | Filename of the file in which to track the remote repositories. | `"_remote.repositories"` | no
+`aether.offline.protocols` | String | Comma-separated list of protocols which are supposed to be resolved offline. | - | no
+`aether.offline.hosts` | String | Comma-separated list of hosts which are supposed to be resolved offline. | - | no
+`aether.updateCheckManager.sessionState` | String | Manages the session state, i.e. influences if the same download requests to artifacts/metadata will happen multiple times within the same RepositorySystemSession. If `"true"` will enable the session state. If `"bypass"` will enable bypassing (i.e. store all artifact ids/metadata ids which have been updates but not evaluating those). All other values lead to disabling the session state completely. | `"true"` | no
Review comment:
This in an interesting one. I think `true` makes no sense here. It should be `enabled`. I will spawn a ticket to support this too.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] kwin commented on a change in pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
kwin commented on a change in pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#discussion_r443979725
##########
File path: src/site/markdown/configuration.md
##########
@@ -2,41 +2,42 @@
Option | Type | Description | Default Value | Supports Repo ID Suffix
--- | --- | --- | --- | --- | --- | ---
-`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.basic.threads` or `maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
-`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
-`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
-`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.wagon.config` | Object | The configuration to use for the Wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | `Map<String, String>` | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes. | `true` | no
`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
-`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
-`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
-`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#ciphersuites) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain Wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain Wagon providers. | - | no
`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
-`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.smartChecksums` | Boolean | A flag indicating that instead of comparing the explicit checksum from the remote repo with the calculated one it will try to extract it from the actual artifact requests's response header named `ETag` in format `SHA1{<checksum>}`. This only works for HTTP(S) requests and certain transport extensions. In addition it only supports SHA1. | `true` | no
`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
-`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) passed to [MessageDigest](https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html). for which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#MessageDigest) passed to [MessageDigest](hhttps://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html) with which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
`aether.dependencyCollector.maxExceptions` | Integer | Only exceptions up to the number given in this configuration property are emitted. Exceptions which exceed that number are swallowed. | `50` | no
`aether.dependencyCollector.maxCycles` | Integer | Only up to the given amount cyclic dependencies are emitted. | `10` | no
-`aether.artifactResolver.snapshotNormalization` | Boolean | ? | `true` | no
-`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4`| no
+`aether.dependencyManager.verbose` | Boolean | A flag controlling the verbose mode for dependency management. If enabled, the original attributes of a dependency before its update due to dependency managemnent will be recorded in the node's `DependencyNode#getData()` when building a dependency graph. | `false` | no
+`aether.artifactResolver.snapshotNormalization` | Boolean | It replaces the the timestamped snapshot file name with a filename containing SNAPSHOT only. This only affects resolving/retrieving artifacts but not uploading those. | `true` | no
+`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4` | no
`aether.enhancedLocalRepository.trackingFilename` | String | Filename of the file in which to track the remote repositories. | `"_remote.repositories"` | no
`aether.offline.protocols` | String | Comma-separated list of protocols which are supposed to be resolved offline. | - | no
`aether.offline.hosts` | String | Comma-separated list of hosts which are supposed to be resolved offline. | - | no
-`aether.updateCheckManager.sessionState` | String | ? | `true` | no
+`aether.updateCheckManager.sessionState` | String | Manages the session state, i.e. influences if the same download requests to artifacts/metadata will happen multiple times within the same RepositorySystemSession. If `"true"` will enable the session state. If `"bypass"` will enable bypassing (i.e. store all artifact ids/metadata ids which have been updates but not evaluating those). All other values lead to disabling the session state completely. | `"true"` | no
-All properties which have `yes` in the column `Supports Repo ID Suffix` can be optionally configured specifically for a repository id. In that case the configuration property needs to be suffixed with the repository id of the repository to configure.
+All properties which have `yes` in the column `Supports Repo ID Suffix` can be optionally configured specifically for a repository id. In that case the configuration property needs to be suffixed with a comma followed by the repository id of the repository to configure, e.g. `aether.connector.http.headers.central` for repository with id `central`.
Review comment:
Indeed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on a change in pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on a change in pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#discussion_r443159247
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,45 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
Review comment:
`Wagon`. It's a name.
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,45 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
Review comment:
Trailing full stop missing.
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,45 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
+`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
+`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
+`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) passed to [MessageDigest](https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html). for which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
Review comment:
Remove full stop before `for which`.
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,45 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
+`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
+`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
+`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) passed to [MessageDigest](https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html). for which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.dependencyCollector.maxExceptions` | Integer | Only exceptions up to the number given in this configuration property are emitted. Exceptions which exceed that number are swallowed. | `50` | no
+`aether.dependencyCollector.maxCycles` | Integer | Only up to the given amount cyclic dependencies are emitted. | `10` | no
+`aether.artifactResolver.snapshotNormalization` | Boolean | ? | `true` | no
+`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4`| no
+`aether.enhancedLocalRepository.trackingFilename` | String | Filename of the file in which to track the remote repositories. | `"_remote.repositories"` | no
+`aether.offline.protocols` | String | Comma-separated list of protocols which are supposed to be resolved offline. | - | no
+`aether.offline.hosts` | String | Comma-separated list of hosts which are supposed to be resolved offline. | - | no
+`aether.updateCheckManager.sessionState` | String | ? | `true` | no
+
+All properties which have `yes` in the column `Supports Repo ID Suffix` can be optionally configured specifically for a repository id. In that case the configuration property needs to be suffixed with the repository id of the repository to configure.
Review comment:
I think this should provide a config how such a property name should look like.
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,45 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
+`aether.connector.perms.group` | String | The group which should own newly created directories/artifacts. Only considered by certain wagon providers. | - | no
+`aether.connector.persistedChecksums` | Boolean | A flag indicating whether checksums which are retrieved during checksum validation should be persisted in the local filesystem next to the file they provide the checksum for. | `true` | no
+`aether.connector.smartChecksums` | Boolean | ? | `true` | no
+`aether.connector.classpath.loader` | ClassLoader | `ClassLoader` from which resources should be retrieved which start with the `classpath:` protocol. | `Thread.currentThread().getContextClassLoader()` | no
+`aether.checksums.forSignature` | Boolean | Flag indicating if signature artifacts (`.asc`) should have checksums. | `false` | no
+`aether.checksums.algorithms` | String | List of [algorithms](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) passed to [MessageDigest](https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html). for which checksums are validated (downloaded) and generated (uploaded). | `"SHA-512,SHA-256,SHA-1,MD5"` | no
+`aether.dependencyCollector.maxExceptions` | Integer | Only exceptions up to the number given in this configuration property are emitted. Exceptions which exceed that number are swallowed. | `50` | no
+`aether.dependencyCollector.maxCycles` | Integer | Only up to the given amount cyclic dependencies are emitted. | `10` | no
+`aether.artifactResolver.snapshotNormalization` | Boolean | ? | `true` | no
+`aether.metadataResolver.threads` | Integer | Number of threads to use in parallel for resolving metadata. | `4`| no
Review comment:
Space missing after `4`.
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,45 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
Review comment:
Same here.
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,45 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
+`aether.connector.http.cacheState` | Boolean | A flag indicating whether a memory-based cache is used for user tokens, connection managers, expect continue requests and authentication schemes | `true` | no
+`aether.connector.http.credentialEncoding` | String | The encoding/charset to use when exchanging credentials with HTTP servers. | `"ISO-8859-1"` | yes
+`aether.connector.https.cipherSuites` | String | Comma-separated list of [Cipher Suites](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#jsse-cipher-suite-names) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.https.protocols` | String | Comma-separated list of [Protocols](https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2) which are enabled for HTTPS connections. | - (no restriction) | no
+`aether.connector.perms.fileMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created artifacts. Only considered by certain wagon providers. | - | no
+`aether.connector.perms.dirMode` | String | [Octal numerical notation of permissions](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) to set for newly created directories. Only considered by certain wagon providers. | - | no
Review comment:
Same here.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] kwin commented on pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
kwin commented on pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#issuecomment-647692255
@michael-o I checked once more all occurrences of `ConfigUtils` and I think now I collected all properties and also I have integrated your feedback. Please check again.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-resolver] michael-o commented on a change in pull request #54: MRESOLVER-116 document configuration options
Posted by GitBox <gi...@apache.org>.
michael-o commented on a change in pull request #54:
URL: https://github.com/apache/maven-resolver/pull/54#discussion_r443162400
##########
File path: src/site/markdown/configuration.md
##########
@@ -0,0 +1,45 @@
+# Configuration Options
+
+Option | Type | Description | Default Value | Supports Repo ID Suffix
+--- | --- | --- | --- | --- | --- | ---
+`maven.artifact.threads` | Integer | Number of threads to use for uploading/downloading. | `5` | no
+`aether.priority.<class>` | Float | The priority to use for a certain extension class. `class` can either be the fully qualified name or the simple name stands for fully qualified class name. If the class name ends with `Factory` that suffix could optionally be left out. | - | no
+`aether.priority.implicit` | Boolean | A flag indicating whether the priorities of pluggable extensions are implicitly given by their iteration order such that the first extension has the highest priority. If set, an extension's built-in priority as well as any corresponding `aether.priority.<class>` configuration properties are ignored when searching for a suitable implementation among the available extensions. This priority mode is meant for cases where the application will present/inject extensions in the desired search order. | `false` | no
+`aether.interactive` | Boolean | A flag indicating whether interaction with the user is allowed. | `false` | no
+`aether.snapshotFilter` | Boolean | A flag whether the `ContextualSnapshotVersionFilter` should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot. | `false` | no
+`aether.conflictResolver.verbose` | Boolean | A flag controlling the conflict resolver's verbose mode. | `false` | no
+`aether.connector.userAgent` | String | The user agent that repository connectors should report to servers. | `"Aether"` | no
+`aether.connector.resumeDownloads` | Boolean | Whether to resume partially downloaded files if the download has been interrupted. | `true` | yes
+`aether.connector.resumeThreshold` | Long | The size in bytes which a partial download needs to have at least to be resumed. Requires `aether.connector.resumeDownloads` to be `true` to be effective. | `64 * 1024` | yes
+`aether.connector.requestTimeout` | Long | Request timeout in milliseconds. | `1800000` | yes
+`aether.connector.connectTimeout` | Long | Connect timeout in milliseconds. | `10000` | yes
+`aether.connector.wagon.config` | Object | The configuration to use for the wagon provider. | - | yes (must be used)
+`aether.connector.http.headers` | String | The request headers to use for HTTP-based repository connectors. The headers are specified using a map of Strings mapping a header name to its value. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map. | - | yes
Review comment:
The type is incorrect. I have found `ConfigUtils.getMap()` with this property.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org