improved env var javadocs

This commit is contained in:
Axel Uhl committed 2025-01-11 15:44:18 +01:00
1 parent 1a2ccb761d
commit ae52f3b0ff
1 file changed
+10 -10
@@ -10,24 +10,24 @@ public enum SailingProcessConfigurationVariables implements ProcessConfiguration
EXPEDITION_PORT,
/**
* The user data variable that sets the TCP port to listen on for Igtimi Riot (WindBot) connections;
* a typical port would be 6000 which is the default for the WindBot devices. If not specified, the
* Riot server will listen on any available, unused server port. Maps to the igtimi.riot.port property.
* The user data variable that sets the TCP port to listen on for Igtimi Riot (WindBot) connections; a typical port
* would be 6000 which is the default for the WindBot devices. If not specified, the Riot server will listen on any
* available, unused server port. Maps to the {@code igtimi.riot.port} property.
*/
IGTIMI_RIOT_PORT,
/**
* Use this variable to override the default {@code https://wind.sapsailing.com} base URL for obtaining
* wind data from Igtimi devices. Authentication to this service by default will assume shared security
* and therefore shared user bases with shared access tokens. If this does not apply to your set-up,
* consider using {@link #IGTIMI_BEARER_TOKEN} in addition.
* Use this variable to override the default {@code https://wind.sapsailing.com} base URL for obtaining wind data
* from Igtimi devices. Authentication to this service by default will assume shared security and therefore shared
* user bases with shared access tokens. If this does not apply to your set-up, consider using
* {@link #IGTIMI_BEARER_TOKEN} in addition. Maps to the {@code igtimi.base.url} property.
*/
IGTIMI_BASE_URL,
/**
* Overrides the default authentication scheme for requests against the remote "Riot" service for Igtimi
* wind connectivity whose base URL may be overridden using {@link #IGTIMI_BASE_URL}. Specify a bearer token
* valid in the context of the security service of the remote Riot service.
* Overrides the default authentication scheme for requests against the remote "Riot" service for Igtimi wind
* connectivity whose base URL may be overridden using {@link #IGTIMI_BASE_URL}. Specify a bearer token valid in the
* context of the security service of the remote Riot service. Maps to the {@code igtimi.bearer.token} property.
*/
IGTIMI_BEARER_TOKEN,