Package org.eclipse.aether

Class ConfigurationProperties

java.lang.Object

org.eclipse.aether.ConfigurationProperties

public final class ConfigurationProperties
extends Object

The keys and defaults for common configuration properties.

See Also:

• RepositorySystemSession.getConfigProperties()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECT_TIMEOUT	The maximum amount of time (in milliseconds) to wait for a successful connection to a remote server.
static final int	DEFAULT_CONNECT_TIMEOUT	The default connect timeout to use if CONNECT_TIMEOUT isn't set.
static final int	DEFAULT_HTTP_CONNECTION_MAX_TTL	The default value to use if HTTP_CONNECTION_MAX_TTL isn't set (300 seconds).
static final String	DEFAULT_HTTP_CREDENTIAL_ENCODING	The default encoding/charset to use if HTTP_CREDENTIAL_ENCODING isn't set.
static final int	DEFAULT_HTTP_MAX_CONNECTIONS_PER_ROUTE	The default value to use if HTTP_MAX_CONNECTIONS_PER_ROUTE isn't set (50 connections).
static final boolean	DEFAULT_HTTP_PREEMPTIVE_AUTH	The default value to use if HTTP_PREEMPTIVE_AUTH isn't set (false).
static final int	DEFAULT_HTTP_RETRY_HANDLER_COUNT	The default number of retries to use if HTTP_RETRY_HANDLER_COUNT isn't set.
static final long	DEFAULT_HTTP_RETRY_HANDLER_INTERVAL	The default initial retry interval to use if HTTP_RETRY_HANDLER_INTERVAL isn't set.
static final long	DEFAULT_HTTP_RETRY_HANDLER_INTERVAL_MAX	The default retry interval maximum to use if HTTP_RETRY_HANDLER_INTERVAL_MAX isn't set.
static final String	DEFAULT_HTTP_RETRY_HANDLER_SERVICE_UNAVAILABLE	The default HTTP codes of remote server responses that should be handled as "too many requests".
static final boolean	DEFAULT_HTTP_REUSE_CONNECTIONS	The default value to use if HTTP_REUSE_CONNECTIONS isn't set (true).
static final boolean	DEFAULT_IMPLICIT_PRIORITIES	The default extension priority mode if IMPLICIT_PRIORITIES isn't set.
static final boolean	DEFAULT_INTERACTIVE	The default interactive mode if INTERACTIVE isn't set.
static final boolean	DEFAULT_PERSISTED_CHECKSUMS	The default checksum persistence mode if PERSISTED_CHECKSUMS isn't set.
static final int	DEFAULT_REQUEST_TIMEOUT	The default request timeout to use if REQUEST_TIMEOUT isn't set.
static final String	DEFAULT_USER_AGENT	The default user agent to use if USER_AGENT isn't set.
static final String	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).
static final String	HTTP_CREDENTIAL_ENCODING	The encoding/charset to use when exchanging credentials with HTTP servers.
static final String	HTTP_EXPECT_CONTINUE	Boolean flag should the HTTP transport use expect-continue handshake for PUT requests.
static final String	HTTP_HEADERS	The request headers to use for HTTP-based repository connectors.
static final String	HTTP_MAX_CONNECTIONS_PER_ROUTE	The maximum concurrent connections per route HTTP client is allowed to use.
static final String	HTTP_PREEMPTIVE_AUTH	Should HTTP client use preemptive auth (w/ BASIC) or not?
static final String	HTTP_RETRY_HANDLER_COUNT	The maximum number of times a request to a remote server should be retried in case of an error.
static final String	HTTP_RETRY_HANDLER_INTERVAL	The initial retry interval of request to a remote server should be waited in case of "too many requests" (HTTP codes 429 and 503).
static final String	HTTP_RETRY_HANDLER_INTERVAL_MAX	The maximum retry interval of request to a remote server above which the request should be aborted instead.
static final String	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).
static final String	HTTP_REUSE_CONNECTIONS	Should HTTP client reuse connections (in other words, pool connections) or not?
static final String	HTTPS_SECURITY_MODE	The mode that sets HTTPS transport "security mode": to ignore any SSL errors (certificate validity checks, hostname verification).
static final String	HTTPS_SECURITY_MODE_DEFAULT	The default HTTPS security mode.
static final String	HTTPS_SECURITY_MODE_INSECURE	The insecure HTTPS security mode (certificate validation, hostname verification are all ignored).
static final String	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.
static final String	INTERACTIVE	A flag indicating whether interaction with the user is allowed.
static final String	PERSISTED_CHECKSUMS	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.
static final String	PREFIX_PRIORITY	The prefix for properties that control the priority of pluggable extensions like transporters.
static final String	REQUEST_TIMEOUT	The maximum amount of time (in milliseconds) to wait for remaining data to arrive from a remote server.
static final String	USER_AGENT	The user agent that repository connectors should report to servers.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PREFIX_PRIORITY

public static final String 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 value Float.NaN or "NaN" (case-sensitive) can be used to disable the extension.

See Also:

• Constant Field Values

IMPLICIT_PRIORITIES

public static final String 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 corresponding aether.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:

• DEFAULT_IMPLICIT_PRIORITIES
• Constant Field Values

DEFAULT_IMPLICIT_PRIORITIES

public static final boolean DEFAULT_IMPLICIT_PRIORITIES

The default extension priority mode if IMPLICIT_PRIORITIES isn't set.

See Also:

• Constant Field Values

INTERACTIVE

public static final String INTERACTIVE

A flag indicating whether interaction with the user is allowed.

See Also:

• DEFAULT_INTERACTIVE
• Constant Field Values

DEFAULT_INTERACTIVE

public static final boolean DEFAULT_INTERACTIVE

The default interactive mode if INTERACTIVE isn't set.

See Also:

• Constant Field Values

USER_AGENT

public static final String USER_AGENT

The user agent that repository connectors should report to servers.

See Also:

• DEFAULT_USER_AGENT
• Constant Field Values

DEFAULT_USER_AGENT

public static final String DEFAULT_USER_AGENT

The default user agent to use if USER_AGENT isn't set.

See Also:

• Constant Field Values

CONNECT_TIMEOUT

public static final String 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:

• DEFAULT_CONNECT_TIMEOUT
• Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

The default connect timeout to use if CONNECT_TIMEOUT isn't set.

See Also:

• Constant Field Values

REQUEST_TIMEOUT

public static final String 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:

• DEFAULT_REQUEST_TIMEOUT
• Constant Field Values

DEFAULT_REQUEST_TIMEOUT

public static final int DEFAULT_REQUEST_TIMEOUT

The default request timeout to use if REQUEST_TIMEOUT isn't set.

See Also:

• Constant Field Values

HTTP_HEADERS

public static final String HTTP_HEADERS

The request headers to use for HTTP-based repository connectors. The headers are specified using a Map<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:

• Constant Field Values

HTTP_CREDENTIAL_ENCODING

public static final String 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:

• DEFAULT_HTTP_CREDENTIAL_ENCODING
• Constant Field Values

DEFAULT_HTTP_CREDENTIAL_ENCODING

public static final String DEFAULT_HTTP_CREDENTIAL_ENCODING

The default encoding/charset to use if HTTP_CREDENTIAL_ENCODING isn't set.

See Also:

• Constant Field Values

HTTP_RETRY_HANDLER_COUNT

public static final String 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:

• DEFAULT_HTTP_RETRY_HANDLER_COUNT
• Constant Field Values

DEFAULT_HTTP_RETRY_HANDLER_COUNT

public static final int DEFAULT_HTTP_RETRY_HANDLER_COUNT

The default number of retries to use if HTTP_RETRY_HANDLER_COUNT isn't set.

Since:

1.9.6

See Also:

• Constant Field Values

HTTP_RETRY_HANDLER_INTERVAL

public static final String HTTP_RETRY_HANDLER_INTERVAL

The initial retry interval 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 use Retry-After header, in which case Server value is obeyed.

Since:

1.9.16

See Also:

• DEFAULT_HTTP_RETRY_HANDLER_INTERVAL
• Constant Field Values

DEFAULT_HTTP_RETRY_HANDLER_INTERVAL

public static final long DEFAULT_HTTP_RETRY_HANDLER_INTERVAL

The default initial retry interval to use if HTTP_RETRY_HANDLER_INTERVAL isn't set. Default value 5000ms.

Since:

1.9.16

See Also:

• Constant Field Values

HTTP_RETRY_HANDLER_INTERVAL_MAX

public static final String HTTP_RETRY_HANDLER_INTERVAL_MAX

The maximum retry interval 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:

• DEFAULT_HTTP_RETRY_HANDLER_INTERVAL_MAX
• Constant Field Values

DEFAULT_HTTP_RETRY_HANDLER_INTERVAL_MAX

public static final long DEFAULT_HTTP_RETRY_HANDLER_INTERVAL_MAX

The default retry interval maximum to use if HTTP_RETRY_HANDLER_INTERVAL_MAX isn't set. Default value 5 minutes.

Since:

1.9.16

See Also:

• Constant Field Values

HTTP_RETRY_HANDLER_SERVICE_UNAVAILABLE

public static final String 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:

• DEFAULT_HTTP_RETRY_HANDLER_SERVICE_UNAVAILABLE
• Constant Field Values

DEFAULT_HTTP_RETRY_HANDLER_SERVICE_UNAVAILABLE

public static final String 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:

• Constant Field Values

HTTP_PREEMPTIVE_AUTH

public static final String HTTP_PREEMPTIVE_AUTH

Should HTTP client use preemptive auth (w/ BASIC) or not?

Since:

1.9.6

See Also:

• DEFAULT_HTTP_PREEMPTIVE_AUTH
• Constant Field Values

DEFAULT_HTTP_PREEMPTIVE_AUTH

public static final boolean DEFAULT_HTTP_PREEMPTIVE_AUTH

The default value to use if HTTP_PREEMPTIVE_AUTH isn't set (false).

Since:

1.9.6

See Also:

• Constant Field Values

HTTP_REUSE_CONNECTIONS

public static final String HTTP_REUSE_CONNECTIONS

Should HTTP client reuse connections (in other words, pool connections) or not?

Since:

1.9.8

See Also:

• DEFAULT_HTTP_REUSE_CONNECTIONS
• Constant Field Values

DEFAULT_HTTP_REUSE_CONNECTIONS

public static final boolean DEFAULT_HTTP_REUSE_CONNECTIONS

The default value to use if HTTP_REUSE_CONNECTIONS isn't set (true).

Since:

1.9.8

See Also:

• Constant Field Values

HTTP_CONNECTION_MAX_TTL

public static final String 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:

• DEFAULT_HTTP_CONNECTION_MAX_TTL
• Constant Field Values

DEFAULT_HTTP_CONNECTION_MAX_TTL

public static final int DEFAULT_HTTP_CONNECTION_MAX_TTL

The default value to use if HTTP_CONNECTION_MAX_TTL isn't set (300 seconds).

Since:

1.9.8

See Also:

• Constant Field Values

HTTP_MAX_CONNECTIONS_PER_ROUTE

public static final String HTTP_MAX_CONNECTIONS_PER_ROUTE

The maximum concurrent connections per route HTTP client is allowed to use.

Since:

1.9.8

See Also:

• DEFAULT_HTTP_MAX_CONNECTIONS_PER_ROUTE
• Constant Field Values

DEFAULT_HTTP_MAX_CONNECTIONS_PER_ROUTE

public static final int DEFAULT_HTTP_MAX_CONNECTIONS_PER_ROUTE

The default value to use if HTTP_MAX_CONNECTIONS_PER_ROUTE isn't set (50 connections).

Since:

1.9.8

See Also:

• Constant Field Values

HTTP_EXPECT_CONTINUE

public static final String 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:

• Constant Field Values

HTTPS_SECURITY_MODE

public static final String HTTPS_SECURITY_MODE

The mode that sets HTTPS transport "security mode": to ignore any SSL errors (certificate validity checks, hostname verification). The default value is HTTPS_SECURITY_MODE_DEFAULT.

Since:

1.9.6

See Also:

• HTTPS_SECURITY_MODE_DEFAULT
• HTTPS_SECURITY_MODE_INSECURE
• Constant Field Values

HTTPS_SECURITY_MODE_DEFAULT

public static final String HTTPS_SECURITY_MODE_DEFAULT

The default HTTPS security mode.

Since:

1.9.6

See Also:

• Constant Field Values

HTTPS_SECURITY_MODE_INSECURE

public static final String HTTPS_SECURITY_MODE_INSECURE

The insecure HTTPS security mode (certificate validation, hostname verification are all ignored).

Since:

1.9.6

See Also:

• Constant Field Values

PERSISTED_CHECKSUMS

public static final String PERSISTED_CHECKSUMS

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.

See Also:

• DEFAULT_PERSISTED_CHECKSUMS
• Constant Field Values

DEFAULT_PERSISTED_CHECKSUMS

public static final boolean DEFAULT_PERSISTED_CHECKSUMS

The default checksum persistence mode if PERSISTED_CHECKSUMS isn't set.

See Also:

• Constant Field Values