Package org.eclipse.aether
Class ConfigurationProperties
java.lang.Object
org.eclipse.aether.ConfigurationProperties
The keys and defaults for common configuration properties.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
A flag indicating whether the created ordered components should be cached in session.static final String
The priority to use for a certain extension class.static final String
The maximum amount of time (in milliseconds) to wait for a successful connection to a remote server.static final boolean
The default caching of priority components ifCACHED_PRIORITIES
isn't set.static final int
The default connect timeout to use ifCONNECT_TIMEOUT
isn't set.static final int
The default value to use ifHTTP_CONNECTION_MAX_TTL
isn't set (300 seconds).static final String
The default encoding/charset to use ifHTTP_CREDENTIAL_ENCODING
isn't set.static final int
The default value to use ifHTTP_MAX_CONNECTIONS_PER_ROUTE
isn't set (50 connections).static final boolean
The default value to use ifHTTP_PREEMPTIVE_AUTH
isn't set (false).static final boolean
Default value ifHTTP_PREEMPTIVE_PUT_AUTH
is not set:true
.static final int
The default number of retries to use ifHTTP_RETRY_HANDLER_COUNT
isn't set.static final long
The default initial retry interval to use ifHTTP_RETRY_HANDLER_INTERVAL
isn't set.static final long
The default retry interval maximum to use ifHTTP_RETRY_HANDLER_INTERVAL_MAX
isn't set.static final String
The default HTTP codes of remote server responses that should be handled as "too many requests".static final boolean
The default value to use ifHTTP_REUSE_CONNECTIONS
isn't set (true).static final boolean
Default value to use ifHTTP_SUPPORT_WEBDAV
is not set:false
.static final boolean
The default extension priority mode ifIMPLICIT_PRIORITIES
isn't set.static final boolean
The default interactive mode ifINTERACTIVE
isn't set.static final int
The default request timeout to use ifREQUEST_TIMEOUT
isn't set.static final String
The default user agent to use ifUSER_AGENT
isn't set.static final String
Total time to live in seconds for an HTTP connection, after that time, the connection will be dropped (no matter for how long it was idle).static final String
The encoding/charset to use when exchanging credentials with HTTP servers.static final String
Boolean flag should the HTTP transport use expect-continue handshake for PUT requests.static final String
The request headers to use for HTTP-based repository connectors.static final String
The local address (interface) to use with HTTP transport.static final String
The maximum concurrent connections per route HTTP client is allowed to use.static final String
Should HTTP client use preemptive-authentication for all HTTP verbs (works only w/ BASIC).static final String
Boolean flag should the HTTP transport use preemptive-auth for PUT requests.static final String
The maximum number of times a request to a remote server should be retried in case of an error.static final String
The initial retry interval in millis of request to a remote server should be waited in case of "too many requests" (HTTP codes 429 and 503).static final String
The maximum retry interval in millis of request to a remote server above which the request should be aborted instead.static final String
The HTTP codes of remote server responses that should be handled as "too many requests" (examples: HTTP codes 429 and 503).static final String
Should HTTP client reuse connections (in other words, pool connections) or not?static final String
Boolean flag should the HTTP transport support WebDAV remote.static final String
The mode that sets HTTPS transport "security mode": to ignore any SSL errors (certificate validity checks, hostname verification).static final String
The default HTTPS security mode.static final String
The insecure HTTPS security mode (certificate validation, hostname verification are all ignored).static final String
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.static final String
A flag indicating whether interaction with the user is allowed.static final String
Prefix for all configurations.static final String
Prefix for checksum related configurations.static final String
Prefix for connector related configurations.static final String
Prefix for generator related configurations.static final String
Prefix for layout related configurations.static final String
Prefix for local repository manager related configurations.static final String
The prefix for properties that control the priority of pluggable extensions like transporters.static final String
Prefix for sync context related configurations.static final String
Prefix for repository system related configurations.static final String
Prefix for transport related configurations.static final String
Prefix for HTTP protocol related configurations.static final String
Prefix for HTTPS protocol related configurations.static final String
A flag indicating which visitor should be used to "flatten" the dependency graph into list.static final String
The visitor strategy "levelOrder".static final String
The visitor strategy "postOrder".static final String
The visitor strategy "preOrder".static final String
The maximum amount of time (in milliseconds) to wait for remaining data to arrive from a remote server.static final String
The user agent that repository connectors should report to servers. -
Method Summary
-
Field Details
-
PREFIX_AETHER
Prefix for all configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_SYSTEM
Prefix for repository system related configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_SYNC_CONTEXT
Prefix for sync context related configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_CONNECTOR
Prefix for connector related configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_LAYOUT
Prefix for layout related configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_CHECKSUMS
Prefix for checksum related configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_LRM
Prefix for local repository manager related configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_GENERATOR
Prefix for generator related configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_TRANSPORT
Prefix for transport related configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_TRANSPORT_HTTP
Prefix for HTTP protocol related configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_TRANSPORT_HTTPS
Prefix for HTTPS protocol related configurations. For internal use only.- Since:
- 2.0.0
- See Also:
-
PREFIX_PRIORITY
The prefix for properties that control the priority of pluggable extensions like transporters. For example, for an extension with the fully qualified class name "org.eclipse.MyExtensionFactory", the configuration properties "aether.priority.org.eclipse.MyExtensionFactory", "aether.priority.MyExtensionFactory" and "aether.priority.MyExtension" will be consulted for the priority, in that order (obviously, the last key is only tried if the class name ends with "Factory"). The corresponding value is a float and the special valueFloat.NaN
or "NaN" (case-sensitive) can be used to disable the extension.- See Also:
-
IMPLICIT_PRIORITIES
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 correspondingaether.priority.*
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.- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Boolean
- Default value:
DEFAULT_IMPLICIT_PRIORITIES
- Supports Repo ID Suffix:
- No
-
DEFAULT_IMPLICIT_PRIORITIES
The default extension priority mode ifIMPLICIT_PRIORITIES
isn't set.- See Also:
-
CACHED_PRIORITIES
A flag indicating whether the created ordered components should be cached in session.- Since:
- 2.0.0
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Boolean
- Default value:
DEFAULT_CACHED_PRIORITIES
- Supports Repo ID Suffix:
- No
-
CLASS_PRIORITIES
The priority to use for a certain extension class.<class>
can either be the fully qualified name or the simple name of a class. If the class name ends with Factory that suffix could optionally be left out. This configuration is used byorg.eclipse.aether.internal.impl.PrioritizedComponents
internal utility to sort classes by priority. This is reusable utility (so an extension can make use of it), but by default in "vanilla" Resolver following classes are sorted:org.eclipse.aether.spi.localrepo.LocalRepositoryManagerFactory
org.eclipse.aether.spi.connector.RepositoryConnectorFactory
org.eclipse.aether.spi.connector.layout.RepositoryLayoutFactory
org.eclipse.aether.spi.connector.transport.TransporterFactory
org.eclipse.aether.spi.artifact.decorator.ArtifactDecoratorFactory
org.eclipse.aether.spi.artifact.generator.ArtifactGeneratorFactory
org.eclipse.aether.impl.MetadataGeneratorFactory
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Float
- Supports Repo ID Suffix:
- No
-
DEFAULT_CACHED_PRIORITIES
The default caching of priority components ifCACHED_PRIORITIES
isn't set. Default value istrue
.- Since:
- 2.0.0
- See Also:
-
INTERACTIVE
A flag indicating whether interaction with the user is allowed.- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Boolean
- Default value:
DEFAULT_INTERACTIVE
- Supports Repo ID Suffix:
- No
-
DEFAULT_INTERACTIVE
The default interactive mode ifINTERACTIVE
isn't set.- See Also:
-
USER_AGENT
The user agent that repository connectors should report to servers.- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
String
- Default value:
DEFAULT_USER_AGENT
- Supports Repo ID Suffix:
- No
-
DEFAULT_USER_AGENT
The default user agent to use ifUSER_AGENT
isn't set.- See Also:
-
CONNECT_TIMEOUT
The maximum amount of time (in milliseconds) to wait for a successful connection to a remote server. Non-positive values indicate no timeout.- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Integer
- Default value:
DEFAULT_CONNECT_TIMEOUT
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_CONNECT_TIMEOUT
The default connect timeout to use ifCONNECT_TIMEOUT
isn't set.- See Also:
-
REQUEST_TIMEOUT
The maximum amount of time (in milliseconds) to wait for remaining data to arrive from a remote server. Note that this timeout does not restrict the overall duration of a request, it only restricts the duration of inactivity between consecutive data packets. Non-positive values indicate no timeout.- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Integer
- Default value:
DEFAULT_REQUEST_TIMEOUT
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_REQUEST_TIMEOUT
The default request timeout to use ifREQUEST_TIMEOUT
isn't set.- See Also:
-
HTTP_HEADERS
The request headers to use for HTTP-based repository connectors. The headers are specified using aMap<String, String>
, mapping a header name to its value. Besides this general key, clients may also specify headers for a specific remote repository by appending the suffix.<repoId>
to this key when storing the headers map. The repository-specific headers map is supposed to be complete, i.e. is not merged with the general headers map.- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Map
- Supports Repo ID Suffix:
- Yes
-
HTTP_CREDENTIAL_ENCODING
The encoding/charset to use when exchanging credentials with HTTP servers. Besides this general key, clients may also specify the encoding for a specific remote repository by appending the suffix.<repoId>
to this key when storing the charset name.- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
String
- Default value:
DEFAULT_HTTP_CREDENTIAL_ENCODING
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_CREDENTIAL_ENCODING
The default encoding/charset to use ifHTTP_CREDENTIAL_ENCODING
isn't set.- See Also:
-
HTTP_RETRY_HANDLER_COUNT
The maximum number of times a request to a remote server should be retried in case of an error.- Since:
- 1.9.6
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Integer
- Default value:
DEFAULT_HTTP_RETRY_HANDLER_COUNT
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_RETRY_HANDLER_COUNT
The default number of retries to use ifHTTP_RETRY_HANDLER_COUNT
isn't set.- Since:
- 1.9.6
- See Also:
-
HTTP_RETRY_HANDLER_INTERVAL
The initial retry interval in millis of request to a remote server should be waited in case of "too many requests" (HTTP codes 429 and 503). Accepts long as milliseconds. This value is used if remote server does not useRetry-After
header, in which case Server value is obeyed.- Since:
- 1.9.16
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Long
- Default value:
DEFAULT_HTTP_RETRY_HANDLER_INTERVAL
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_RETRY_HANDLER_INTERVAL
The default initial retry interval to use ifHTTP_RETRY_HANDLER_INTERVAL
isn't set. Default value 5000ms.- Since:
- 1.9.16
- See Also:
-
HTTP_RETRY_HANDLER_INTERVAL_MAX
The maximum retry interval in millis of request to a remote server above which the request should be aborted instead. In theory, a malicious server could tell Maven "come back after 100 years" that would stall the build for some. Using this parameter Maven will fail the request instead, if interval is above this value.- Since:
- 1.9.16
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Long
- Default value:
DEFAULT_HTTP_RETRY_HANDLER_INTERVAL_MAX
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_RETRY_HANDLER_INTERVAL_MAX
The default retry interval maximum to use ifHTTP_RETRY_HANDLER_INTERVAL_MAX
isn't set. Default value 5 minutes.- Since:
- 1.9.16
- See Also:
-
HTTP_RETRY_HANDLER_SERVICE_UNAVAILABLE
The HTTP codes of remote server responses that should be handled as "too many requests" (examples: HTTP codes 429 and 503). Accepts comma separated list of HTTP response codes.- Since:
- 1.9.16
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
String
- Default value:
DEFAULT_HTTP_RETRY_HANDLER_SERVICE_UNAVAILABLE
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_RETRY_HANDLER_SERVICE_UNAVAILABLE
The default HTTP codes of remote server responses that should be handled as "too many requests". Default value: "429,503".- Since:
- 1.9.16
- See Also:
-
HTTP_PREEMPTIVE_AUTH
Should HTTP client use preemptive-authentication for all HTTP verbs (works only w/ BASIC). By default, is disabled, as it is considered less secure.- Since:
- 1.9.6
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Boolean
- Default value:
DEFAULT_HTTP_PREEMPTIVE_AUTH
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_PREEMPTIVE_AUTH
The default value to use ifHTTP_PREEMPTIVE_AUTH
isn't set (false).- Since:
- 1.9.6
- See Also:
-
HTTP_REUSE_CONNECTIONS
Should HTTP client reuse connections (in other words, pool connections) or not?- Since:
- 1.9.8
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Boolean
- Default value:
DEFAULT_HTTP_REUSE_CONNECTIONS
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_REUSE_CONNECTIONS
The default value to use ifHTTP_REUSE_CONNECTIONS
isn't set (true).- Since:
- 1.9.8
- See Also:
-
HTTP_CONNECTION_MAX_TTL
Total time to live in seconds for an HTTP connection, after that time, the connection will be dropped (no matter for how long it was idle).- Since:
- 1.9.8
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Integer
- Default value:
DEFAULT_HTTP_CONNECTION_MAX_TTL
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_CONNECTION_MAX_TTL
The default value to use ifHTTP_CONNECTION_MAX_TTL
isn't set (300 seconds).- Since:
- 1.9.8
- See Also:
-
HTTP_MAX_CONNECTIONS_PER_ROUTE
The maximum concurrent connections per route HTTP client is allowed to use.- Since:
- 1.9.8
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Integer
- Default value:
DEFAULT_HTTP_MAX_CONNECTIONS_PER_ROUTE
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_MAX_CONNECTIONS_PER_ROUTE
The default value to use ifHTTP_MAX_CONNECTIONS_PER_ROUTE
isn't set (50 connections).- Since:
- 1.9.8
- See Also:
-
HTTP_LOCAL_ADDRESS
The local address (interface) to use with HTTP transport. Not all transport supports this option.- Since:
- 2.0.0
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
String
- Supports Repo ID Suffix:
- Yes
-
HTTP_SUPPORT_WEBDAV
Boolean flag should the HTTP transport support WebDAV remote. Not all transport support this option.- Since:
- 2.0.0 (moved out from maven-resolver-transport-http).
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Boolean
- Default value:
DEFAULT_HTTP_SUPPORT_WEBDAV
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_SUPPORT_WEBDAV
Default value to use ifHTTP_SUPPORT_WEBDAV
is not set:false
.- Since:
- 2.0.0
- See Also:
-
HTTP_PREEMPTIVE_PUT_AUTH
Boolean flag should the HTTP transport use preemptive-auth for PUT requests. Not all transport support this option.- Since:
- 2.0.0 (moved out from maven-resolver-transport-http).
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Boolean
- Default value:
DEFAULT_HTTP_PREEMPTIVE_PUT_AUTH
- Supports Repo ID Suffix:
- Yes
-
DEFAULT_HTTP_PREEMPTIVE_PUT_AUTH
Default value ifHTTP_PREEMPTIVE_PUT_AUTH
is not set:true
.- Since:
- 2.0.0
- See Also:
-
HTTP_EXPECT_CONTINUE
Boolean flag should the HTTP transport use expect-continue handshake for PUT requests. Not all transport support this option. This option may be needed for some broken HTTP servers. Default value corresponds to given transport default one (resolver does not override those), but if configuration IS given, it will replace given transport own default value.- Since:
- 1.9.17
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
Boolean
- Supports Repo ID Suffix:
- Yes
-
HTTPS_SECURITY_MODE
The mode that sets HTTPS transport "security mode": to ignore any SSL errors (certificate validity checks, hostname verification). The default value isHTTPS_SECURITY_MODE_DEFAULT
.- Since:
- 1.9.6
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
String
- Default value:
HTTPS_SECURITY_MODE_DEFAULT
- Supports Repo ID Suffix:
- Yes
-
HTTPS_SECURITY_MODE_DEFAULT
The default HTTPS security mode.- Since:
- 1.9.6
- See Also:
-
HTTPS_SECURITY_MODE_INSECURE
The insecure HTTPS security mode (certificate validation, hostname verification are all ignored).- Since:
- 1.9.6
- See Also:
-
REPOSITORY_SYSTEM_DEPENDENCY_VISITOR
A flag indicating which visitor should be used to "flatten" the dependency graph into list. Default is same as in older resolver versions "preOrder", while it can accept values like "postOrder" and "levelOrder".- Since:
- 2.0.0
- See Also:
- Sourced from:
RepositorySystemSession.getConfigProperties()
- Value type:
String
- Default value:
REPOSITORY_SYSTEM_DEPENDENCY_VISITOR_PREORDER
- Supports Repo ID Suffix:
- No
-
REPOSITORY_SYSTEM_DEPENDENCY_VISITOR_PREORDER
The visitor strategy "preOrder".- Since:
- 2.0.0
- See Also:
-
REPOSITORY_SYSTEM_DEPENDENCY_VISITOR_POSTORDER
The visitor strategy "postOrder". This was the only one supported in Resolver 1.x and is hence the default as well.- Since:
- 2.0.0
- See Also:
-
REPOSITORY_SYSTEM_DEPENDENCY_VISITOR_LEVELORDER
The visitor strategy "levelOrder".- Since:
- 2.0.0
- See Also:
-