org.axonframework.updates.configuration

Class EnvironmentVariableUsagePropertyProvider

java.lang.Object

org.axonframework.updates.configuration.EnvironmentVariableUsagePropertyProvider

All Implemented Interfaces:

UsagePropertyProvider

public class EnvironmentVariableUsagePropertyProvider
extends Object
implements UsagePropertyProvider

A UsagePropertyProvider implementation that reads the usage properties from the environment variables. The priority is half of max integer value, meaning it will be overridden by the command-line properties provider.

Since:

4.12.0

Author:

Mitchell Herrijgers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EnvironmentVariableUsagePropertyProvider.EnvironmentVariableSupplier A functional interface to supply environment variables.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLED_KEY The environment variable key to check if the update checker is disabled.
static String	URL_KEY The environment variable key to retrieve the URL for the usage collection endpoint.

Constructor Summary

Constructors

Constructor and Description
EnvironmentVariableUsagePropertyProvider() Creates a new EnvironmentVariableUsagePropertyProvider that reads properties from the system environment.
EnvironmentVariableUsagePropertyProvider(EnvironmentVariableUsagePropertyProvider.EnvironmentVariableSupplier envSupplier) Creates a new EnvironmentVariableUsagePropertyProvider that reads properties from the provided EnvironmentVariableUsagePropertyProvider.EnvironmentVariableSupplier.

Method Summary

Modifier and Type	Method and Description
Boolean	getDisabled() Returns whether the Anonymous Usage Collection is disabled.
String	getUrl() Returns the URL for the Anonymous Usage Collection endpoint.
int	priority() Returns the priority of this property provider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.updates.configuration.UsagePropertyProvider

create

Field Detail

DISABLED_KEY

public static final String DISABLED_KEY

The environment variable key to check if the update checker is disabled.

See Also:

Constant Field Values

URL_KEY

public static final String URL_KEY

The environment variable key to retrieve the URL for the usage collection endpoint.

See Also:

Constant Field Values

Constructor Detail

EnvironmentVariableUsagePropertyProvider

public EnvironmentVariableUsagePropertyProvider()

Creates a new EnvironmentVariableUsagePropertyProvider that reads properties from the system environment. This constructor uses System.getenv() as the default supplier for environment variables.

EnvironmentVariableUsagePropertyProvider

public EnvironmentVariableUsagePropertyProvider(EnvironmentVariableUsagePropertyProvider.EnvironmentVariableSupplier envSupplier)

Creates a new EnvironmentVariableUsagePropertyProvider that reads properties from the provided EnvironmentVariableUsagePropertyProvider.EnvironmentVariableSupplier. This allows for custom implementations to provide environment variable values, which can be useful for testing or when the default System.getenv() is not suitable.

Parameters:

envSupplier - The supplier to use for retrieving environment variables.

Method Detail

getDisabled

public Boolean getDisabled()

Description copied from interface: UsagePropertyProvider

Returns whether the Anonymous Usage Collection is disabled.

Specified by:

getDisabled in interface UsagePropertyProvider

Returns:

true if the collection is disabled, null if not specified, or false if enabled.

getUrl

public String getUrl()

Description copied from interface: UsagePropertyProvider

Returns the URL for the Anonymous Usage Collection endpoint.

Specified by:

getUrl in interface UsagePropertyProvider

Returns:

The URL as a String, or null if not specified.

priority

public int priority()

Description copied from interface: UsagePropertyProvider

Returns the priority of this property provider. Higher values indicate higher priority. Providers with higher priority will be checked first when retrieving properties.

Specified by:

priority in interface UsagePropertyProvider

Returns:

An int representing the priority of this provider.