Class NessieConfigConstants
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringNetwork level connect timeout in milliseconds, default is 5000.static final StringEnables API compatibility check when creating the Nessie client.static final StringDeprecated.static final StringToken used forBEARERauthentication.static final StringID of the authentication provider to use, default is no authentication.static final StringAWS profile name used forAWSauthentication (optional).static final StringAWS region used forAWSauthentication, must be configured to the same region as the Nessie setver.static final StringExplicitly specify the Nessie API version number to use.static final StringDeprecated.Prefer using Nessie client implementation names, configured via "nessie.client-builder-name".static final StringName of the Nessie client to use.static final StringSet/override the author of all commits.static final StringOverride all commit messages with the configured value.static final StringSet/override the signed-off-by of all commits.static final StringConfig property name ("nessie.transport.disable-compression") to disable compression on the network layer, if set totrue.static final StringOptional, allow HTTP/2 upgrade, if set totrue.static final StringOptional, specify how redirects are handled.static final StringURL of the OAuth2 authorization endpoint.static final StringDefines how long the client should wait for the authorization code flow to complete.static final StringPort of the OAuth2 authorization code flow web server.static final StringDefines how long the background thread should be kept running if the client is not being actively used, or no token refreshes are being executed.static final StringClient ID to use when authenticating against the OAuth2 server.static final StringSpace-separated list of scopes to include in each request to the OAuth2 server.static final StringClient secret to use when authenticating against the OAuth2 server.static final StringDefault access token lifespan; if the OAuth2 server returns an access token without specifying its expiration time, this value will be used.static final StringDefault refresh token lifespan.static final StringURL of the OAuth2 device authorization endpoint.static final StringDefines how often the client should poll the OAuth2 server for the device code flow to complete.static final StringDefines how long the client should wait for the device code flow to complete.static final StringExtra parameters to include in each request to the token endpoint.static final StringThe grant type to use when authenticating against the OAuth2 server.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringFor impersonation only.static final StringFor impersonation only.static final StringWhether to enable "impersonation" mode.static final StringFor impersonation only.static final StringFor impersonation only.static final StringFor impersonation only.static final StringOAuth2 issuer URL.static final StringPassword to use when authenticating against the OAuth2 server.static final StringDefines for how long the OAuth2 provider should keep the tokens fresh, if the client is not being actively used.static final StringRefresh safety window to use; a new token will be fetched when the current token's remaining lifespan is less than this value.static final StringURL of the OAuth2 token endpoint.static final StringFor token exchanges only.static final StringFor token exchanges only.static final StringFor token exchanges only.static final StringFor token exchanges only.static final StringFor token exchanges only.static final StringFor token exchanges only.static final StringUsername to use when authenticating against the OAuth2 server.static final StringDeprecated."basic" HTTP authentication is not considered secure.static final StringName of the initial Nessie reference, usuallymain.static final StringCommit ID (hash) on "nessie.ref", usually not specified.static final StringOptional, comma-separated list of SNI host names for SSL connections.static final StringOptional, a single SNI matcher for SSL connections.static final StringOptional, list of comma-separated cipher suites for SSL connections.static final StringOptional, disables certificate verifications, if set totrue.static final StringOptional, list of comma-separated protocols for SSL connections.static final StringEnable adding the HTTP headers of an active OpenTracing span to all Nessie requests.static final StringConfig property name ("nessie.uri") for the Nessie service URL.static final StringDeprecated."basic" HTTP authentication is not considered secure.static final StringNetwork level read timeout in milliseconds.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final intstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final intstatic final Stringstatic final String -
Method Summary
-
Field Details
-
CONF_NESSIE_URI
Config property name ("nessie.uri") for the Nessie service URL.- See Also:
-
CONF_NESSIE_USERNAME
Deprecated."basic" HTTP authentication is not considered secure. UseCONF_NESSIE_AUTH_TOKENinstead.Username used for the insecureBASICauthentication.- See Also:
-
CONF_NESSIE_PASSWORD
Deprecated."basic" HTTP authentication is not considered secure. UseCONF_NESSIE_AUTH_TOKENinstead.Password used for the insecureBASICauthentication.- See Also:
-
CONF_NESSIE_AUTH_TOKEN
Token used forBEARERauthentication.- See Also:
-
CONF_NESSIE_OAUTH2_ISSUER_URL
OAuth2 issuer URL.The root URL of the OpenID Connect identity issuer provider, which will be used for discovering supported endpoints and their locations. For Keycloak, this is typically the realm URL:
https://<keycloak-server>/realms/<realm-name>.Endpoint discovery is performed using the OpenID Connect Discovery metadata published by the issuer. See OpenID Connect Discovery 1.0 for more information.
Either this property or
CONF_NESSIE_OAUTH2_TOKEN_ENDPOINTmust be set.- See Also:
-
CONF_NESSIE_OAUTH2_TOKEN_ENDPOINT
URL of the OAuth2 token endpoint. For Keycloak, this is typicallyhttps://<keycloak-server>/realms/<realm-name>/protocol/openid-connect/token.Either this property or
CONF_NESSIE_OAUTH2_ISSUER_URLmust be set. In case it is not set, the token endpoint will be discovered from theissuer URL, using the OpenID Connect Discovery metadata published by the issuer.- See Also:
-
CONF_NESSIE_OAUTH2_AUTH_ENDPOINT
URL of the OAuth2 authorization endpoint. For Keycloak, this is typicallyhttps://<keycloak-server>/realms/<realm-name>/protocol/openid-connect/auth.If using the "authorization_code" grant type, either this property or
CONF_NESSIE_OAUTH2_ISSUER_URLmust be set. In case it is not set, the authorization endpoint will be discovered from theissuer URL, using the OpenID Connect Discovery metadata published by the issuer.- See Also:
-
CONF_NESSIE_OAUTH2_DEVICE_AUTH_ENDPOINT
URL of the OAuth2 device authorization endpoint. For Keycloak, this is typicallyhttp://<keycloak-server>/realms/<realm-name>/protocol/openid-connect/auth/device.If using the "Device Code" grant type, either this property or
CONF_NESSIE_OAUTH2_ISSUER_URLmust be set.- See Also:
-
CONF_NESSIE_OAUTH2_GRANT_TYPE_CLIENT_CREDENTIALS
- See Also:
-
CONF_NESSIE_OAUTH2_GRANT_TYPE_PASSWORD
- See Also:
-
CONF_NESSIE_OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE
- See Also:
-
CONF_NESSIE_OAUTH2_GRANT_TYPE_DEVICE_CODE
- See Also:
-
CONF_NESSIE_OAUTH2_GRANT_TYPE_TOKEN_EXCHANGE
- See Also:
-
CONF_NESSIE_OAUTH2_GRANT_TYPE
The grant type to use when authenticating against the OAuth2 server. Valid values are: Optional, defaults to "client_credentials".- See Also:
-
CONF_NESSIE_OAUTH2_CLIENT_ID
Client ID to use when authenticating against the OAuth2 server. Required if using OAuth2 authentication, ignored otherwise.- See Also:
-
CONF_NESSIE_OAUTH2_CLIENT_SECRET
Client secret to use when authenticating against the OAuth2 server. Required if using OAuth2 authentication, ignored otherwise.- See Also:
-
CONF_NESSIE_OAUTH2_EXTRA_PARAMS
Extra parameters to include in each request to the token endpoint. This is useful for custom parameters that are not covered by the standard OAuth2.0 specification. Optional, defaults to empty.The format of this field is a comma-separated list of key-value pairs, separated by an equal sign. The values must NOT be URL-encoded. Example:
For example, Auth0 requires thenessie.authentication.oauth2.extra-params = "custom_param1=custom_value1,custom_param2=custom_value2"audienceparameter to be set to the API identifier. This can be done by setting the following configuration:nessie.authentication.oauth2.extra-params = "audience=https://nessie-catalog/api"- See Also:
-
CONF_NESSIE_OAUTH2_USERNAME
Username to use when authenticating against the OAuth2 server. Required if using OAuth2 authentication and "password" grant type, ignored otherwise.- See Also:
-
CONF_NESSIE_OAUTH2_PASSWORD
Password to use when authenticating against the OAuth2 server. Required if using OAuth2 authentication and the "password" grant type, ignored otherwise.- See Also:
-
DEFAULT_DEFAULT_ACCESS_TOKEN_LIFESPAN
- See Also:
-
CONF_NESSIE_OAUTH2_DEFAULT_ACCESS_TOKEN_LIFESPAN
Default access token lifespan; if the OAuth2 server returns an access token without specifying its expiration time, this value will be used.Optional, defaults to "PT1M". Must be a valid ISO-8601 duration.
- See Also:
-
DEFAULT_DEFAULT_REFRESH_TOKEN_LIFESPAN
- See Also:
-
CONF_NESSIE_OAUTH2_DEFAULT_REFRESH_TOKEN_LIFESPAN
Default refresh token lifespan. If the OAuth2 server returns a refresh token without specifying its expiration time, this value will be used.Optional, defaults to "PT30M". Must be a valid ISO-8601 duration.
- See Also:
-
DEFAULT_REFRESH_SAFETY_WINDOW
- See Also:
-
CONF_NESSIE_OAUTH2_REFRESH_SAFETY_WINDOW
Refresh safety window to use; a new token will be fetched when the current token's remaining lifespan is less than this value. Optional, defaults to "PT10S". Must be a valid ISO-8601 duration.- See Also:
-
DEFAULT_PREEMPTIVE_TOKEN_REFRESH_IDLE_TIMEOUT
- See Also:
-
CONF_NESSIE_OAUTH2_PREEMPTIVE_TOKEN_REFRESH_IDLE_TIMEOUT
Defines for how long the OAuth2 provider should keep the tokens fresh, if the client is not being actively used. Setting this value too high may cause an excessive usage of network I/O and thread resources; conversely, when setting it too low, if the client is used again, the calling thread may block if the tokens are expired and need to be renewed synchronously. Optional, defaults to "PT30S". Must be a valid ISO-8601 duration.- See Also:
-
DEFAULT_BACKGROUND_THREAD_IDLE_TIMEOUT
- See Also:
-
CONF_NESSIE_OAUTH2_BACKGROUND_THREAD_IDLE_TIMEOUT
Defines how long the background thread should be kept running if the client is not being actively used, or no token refreshes are being executed. Optional, defaults to "PT30S". Setting this value too high will cause the background thread to keep running even if the client is not used anymore, potentially leaking thread and memory resources; conversely, setting it too low could cause the background thread to be restarted too often. Must be a valid ISO-8601 duration.- See Also:
-
CONF_NESSIE_OAUTH2_CLIENT_SCOPES
Space-separated list of scopes to include in each request to the OAuth2 server. Optional, defaults to empty (no scopes).The scope names will not be validated by the Nessie client; make sure they are valid according to RFC 6749 Section 3.3.
- See Also:
-
CONF_NESSIE_OAUTH2_TOKEN_EXCHANGE_RESOURCE
For token exchanges only. A URI that indicates the target service or resource where the client intends to use the requested security token. Optional.- See Also:
-
CONF_NESSIE_OAUTH2_TOKEN_EXCHANGE_AUDIENCE
For token exchanges only. The logical name of the target service where the client intends to use the requested security token. This serves a purpose similar to the resource parameter but with the client providing a logical name for the target service.- See Also:
-
CURRENT_ACCESS_TOKEN
- See Also:
-
CURRENT_REFRESH_TOKEN
- See Also:
-
NO_TOKEN
- See Also:
-
CONF_NESSIE_OAUTH2_TOKEN_EXCHANGE_SUBJECT_TOKEN
For token exchanges only. The subject token to exchange. This can take 3 kinds of values:- The value "current_access_token", if the client should use its current access token;
- The value "current_refresh_token", if the client should use its current refresh token (a refresh token must be available in this case);
- An arbitrary token: in this case, the client will always use the static token provided here.
- See Also:
-
CONF_NESSIE_OAUTH2_TOKEN_EXCHANGE_SUBJECT_TOKEN_TYPE
For token exchanges only. The type of the subject token. Must be a valid URN. The default is eitherurn:ietf:params:oauth:token-type:access_tokenorurn:ietf:params:oauth:token-type:refresh_token, depending on the value of "nessie.authentication.oauth2.token-exchange.subject-token".If the client is configured to use its access or refresh token as the subject token, please note that if an incorrect token type is provided here, the token exchange could fail.
- See Also:
-
CONF_NESSIE_OAUTH2_TOKEN_EXCHANGE_ACTOR_TOKEN
For token exchanges only. The actor token to exchange. This can take 4 kinds of values:- The value "no_token", if the client should not include any actor token in the exchange request;
- The value "current_access_token", if the client should use its current access token;
- The value "current_refresh_token", if the client should use its current refresh token (if available);
- An arbitrary token: in this case, the client will always use the static token provided here.
- See Also:
-
CONF_NESSIE_OAUTH2_TOKEN_EXCHANGE_ACTOR_TOKEN_TYPE
For token exchanges only. The type of the actor token. Must be a valid URN. The default is eitherurn:ietf:params:oauth:token-type:access_tokenorurn:ietf:params:oauth:token-type:refresh_token, depending on the value of "nessie.authentication.oauth2.token-exchange.actor-token".If the client is configured to use its access or refresh token as the actor token, please note that if an incorrect token type is provided here, the token exchange could fail.
- See Also:
-
CONF_NESSIE_OAUTH2_IMPERSONATION_ENABLED
Whether to enable "impersonation" mode. If enabled, each access token obtained from the OAuth2 server using the configured initial grant type will be exchanged for a new token, using the token exchange grant type.- See Also:
-
CONF_NESSIE_OAUTH2_IMPERSONATION_ISSUER_URL
For impersonation only. The root URL of an alternate OpenID Connect identity issuer provider, to use when exchanging tokens only.If neither this property nor "nessie.authentication.oauth2.impersonation.token-endpoint" are defined, the global token endpoint will be used. This means that the same authorization server will be used for both the initial token request and the token exchange.
Endpoint discovery is performed using the OpenID Connect Discovery metadata published by the issuer. See OpenID Connect Discovery 1.0 for more information.
- See Also:
-
CONF_NESSIE_OAUTH2_IMPERSONATION_TOKEN_ENDPOINT
For impersonation only. The URL of an alternate OAuth2 token endpoint to use when exchanging tokens only.If neither this property nor "nessie.authentication.oauth2.impersonation.issuer-url" are defined, the global token endpoint will be used. This means that the same authorization server will be used for both the initial token request and the token exchange.
- See Also:
-
CONF_NESSIE_OAUTH2_IMPERSONATION_CLIENT_ID
For impersonation only. An alternate client ID to use. If not provided, the global client ID will be used. If provided, and if the client is confidential, then its secret must be provided as well with "nessie.authentication.oauth2.impersonation.client-secret" – the global client secret will NOT be used.- See Also:
-
CONF_NESSIE_OAUTH2_IMPERSONATION_CLIENT_SECRET
For impersonation only. The client secret to use, if "nessie.authentication.oauth2.impersonation.client-id" is defined and the token exchange client is confidential.- See Also:
-
CONF_NESSIE_OAUTH2_IMPERSONATION_SCOPES
For impersonation only. Space-separated list of scopes to include in each token exchange request to the OAuth2 server. Optional. If undefined, the global scopes configured through "nessie.authentication.oauth2.client-scopes" will be used. If defined and null or empty, no scopes will be used.The scope names will not be validated by the Nessie client; make sure they are valid according to RFC 6749 Section 3.3.
- See Also:
-
CONF_NESSIE_OAUTH2_AUTHORIZATION_CODE_FLOW_WEB_PORT
Port of the OAuth2 authorization code flow web server.When running a client inside a container make sure to specify a port and forward the port to the container host.
The port used for the internal web server that listens for the authorization code callback. This is only used if the grant type to use is "authorization_code".
Optional; if not present, a random port will be used.
- See Also:
-
CONF_NESSIE_OAUTH2_AUTHORIZATION_CODE_FLOW_TIMEOUT
Defines how long the client should wait for the authorization code flow to complete. This is only used if the grant type to use is "authorization_code". Optional, defaults to "PT5M".- See Also:
-
DEFAULT_AUTHORIZATION_CODE_FLOW_TIMEOUT
- See Also:
-
CONF_NESSIE_OAUTH2_DEVICE_CODE_FLOW_TIMEOUT
Defines how long the client should wait for the device code flow to complete. This is only used if the grant type to use is "device_code". Optional, defaults to "PT5M".- See Also:
-
DEFAULT_DEVICE_CODE_FLOW_TIMEOUT
- See Also:
-
CONF_NESSIE_OAUTH2_DEVICE_CODE_FLOW_POLL_INTERVAL
Defines how often the client should poll the OAuth2 server for the device code flow to complete. This is only used if the grant type to use is "device_code". Optional, defaults to "PT5S".- See Also:
-
DEFAULT_DEVICE_CODE_FLOW_POLL_INTERVAL
- See Also:
-
CONF_NESSIE_AWS_REGION
AWS region used forAWSauthentication, must be configured to the same region as the Nessie setver.- See Also:
-
CONF_NESSIE_AWS_PROFILE
AWS profile name used forAWSauthentication (optional).- See Also:
-
CONF_NESSIE_AUTH_TYPE
ID of the authentication provider to use, default is no authentication.Valid values are
BASIC,BEARER,OAUTH2andAWS.The value is matched against the values returned as the supported auth-type by implementations of
NessieAuthenticationProvideracross all available authentication providers.Note that "basic" HTTP authentication is not considered secure, use
BEARERinstead.- See Also:
-
CONF_NESSIE_REF
Name of the initial Nessie reference, usuallymain.- See Also:
-
CONF_NESSIE_REF_HASH
Commit ID (hash) on "nessie.ref", usually not specified.- See Also:
-
CONF_NESSIE_TRACING
Enable adding the HTTP headers of an active OpenTracing span to all Nessie requests. Disabled by default.- See Also:
-
CONF_READ_TIMEOUT
Network level read timeout in milliseconds. When running with Java 11, this becomes a request timeout. Default is 25000 ms.- See Also:
-
CONF_CONNECT_TIMEOUT
Network level connect timeout in milliseconds, default is 5000.- See Also:
-
CONF_NESSIE_DISABLE_COMPRESSION
Config property name ("nessie.transport.disable-compression") to disable compression on the network layer, if set totrue.- See Also:
-
CONF_NESSIE_CLIENT_NAME
Name of the Nessie client to use. If not specified, the implementation prefers the new Java HTTP client (JavaHttp), if running on Java 11 or newer, or the JavaURLConnectionclient. The Apache HTTP client (ApacheHttp) can be used, if it has been made available on the classpath.- See Also:
-
CONF_NESSIE_CLIENT_BUILDER_IMPL
Deprecated.Prefer using Nessie client implementation names, configured via "nessie.client-builder-name".Similar to "nessie.client-builder-name", but uses a class name.- See Also:
-
CONF_NESSIE_SSL_NO_CERTIFICATE_VERIFICATION
Optional, disables certificate verifications, if set totrue. Can be useful for testing purposes, not recommended for production systems.- See Also:
-
CONF_NESSIE_SSL_CIPHER_SUITES
Optional, list of comma-separated cipher suites for SSL connections.This parameter only works on Java 11 and newer with the Java HTTP client.
- See Also:
-
CONF_NESSIE_SSL_PROTOCOLS
Optional, list of comma-separated protocols for SSL connections.This parameter only works on Java 11 and newer with the Java HTTP client.
- See Also:
-
CONF_NESSIE_SNI_HOSTS
Optional, comma-separated list of SNI host names for SSL connections.This parameter only works on Java 11 and newer with the Java HTTP client.
- See Also:
-
CONF_NESSIE_SNI_MATCHER
Optional, a single SNI matcher for SSL connections.Takes a single SNI hostname matcher, a regular expression representing the SNI hostnames to match.
This parameter only works on Java 11 and newer with the Java HTTP client.
- See Also:
-
CONF_NESSIE_HTTP_2
Optional, allow HTTP/2 upgrade, if set totrue.This parameter only works on Java 11 and newer with the Java HTTP client.
- See Also:
-
CONF_NESSIE_HTTP_REDIRECT
Optional, specify how redirects are handled.NEVER: Never redirect.ALWAYS: Always redirect.NORMAL: Always redirect, except from HTTPS URLs to HTTP URLs.
This parameter only works on Java 11 and newer with the Java HTTP client.
- See Also:
-
CONF_FORCE_URL_CONNECTION_CLIENT
Deprecated.UseCONF_NESSIE_CLIENT_NAMEwith the valueURLConnection.Optional, when running on Java 11 force the use of the oldURLConnectionbased client for HTTP, if set totrue.- See Also:
-
CONF_ENABLE_API_COMPATIBILITY_CHECK
Enables API compatibility check when creating the Nessie client. The default istrue.You can also control this setting by setting the system property
nessie.client.enable-api-compatibility-checktotrueorfalse.- See Also:
-
CONF_NESSIE_CLIENT_API_VERSION
Explicitly specify the Nessie API version number to use. The default for this setting depends on the client being used.- See Also:
-
CONF_NESSIE_COMMIT_MESSAGE
Override all commit messages with the configured value. The corresponding HTTP header isNessie-Commit-Message.- See Also:
-
CONF_NESSIE_COMMIT_AUTHORS
Set/override the author of all commits. The corresponding HTTP header isNessie-Commit-Authors. Multiple authors can be specified, separated with,.- See Also:
-
CONF_NESSIE_COMMIT_SIGNED_OFF_BY
Set/override the signed-off-by of all commits. The corresponding HTTP header isNessie-Commit-SignedOffBy. Multiple signed-off-by can be specified, separated with,.- See Also:
-
DEFAULT_READ_TIMEOUT_MILLIS
public static final int DEFAULT_READ_TIMEOUT_MILLIS- See Also:
-
DEFAULT_CONNECT_TIMEOUT_MILLIS
public static final int DEFAULT_CONNECT_TIMEOUT_MILLIS- See Also:
-
CONF_NESSIE_CLIENT_NAMEwith the valueURLConnection.