OvokConfig

public final class OvokConfig

Settings for an Ovok client; build one with builder().

OvokConfig config = OvokConfig.builder()
        .baseUrl("https://api.sandbox.ovok.com")
        .tenantCode("my-tenant")
        .clientId("my-client-id")
        .build();
Ovok ovok = new Ovok(config);

Set clientSecret too for a machine client; without it the client signs in users.

MethodsCopy Anchor Link

builderCopy Anchor Link

public static OvokConfig.Builder builder()

Starts a new configuration.

Returns: a builder with the defaults

OvokConfig.BuilderCopy Anchor Link

public static final class Builder

Builds an OvokConfig. baseUrl and tenantCode are required.

Builder.baseUrlCopy Anchor Link

public OvokConfig.Builder baseUrl(String value)

Sets the API base URL.

Parameters:

• value: an absolute http(s) URL

Returns: this builder

Throws:

• OvokConfigException: if the value is not a valid URI

public OvokConfig.Builder baseUrl(URI value)

Sets the API base URL.

Parameters:

• value: an absolute http(s) URL

Returns: this builder

Builder.tenantCodeCopy Anchor Link

public OvokConfig.Builder tenantCode(String value)

Sets the tenant (project) code.

Parameters:

• value: the tenant code

Returns: this builder

Builder.fhirPathCopy Anchor Link

public OvokConfig.Builder fhirPath(String value)

Sets the path of the FHIR API under the base URL; the default is fhir.

Parameters:

• value: the path, such as fhir/R4

Returns: this builder

Builder.storageCopy Anchor Link

public OvokConfig.Builder storage(OvokStorage value)

Sets where the user session is stored; the default keeps it in memory.

Parameters:

• value: the storage

Returns: this builder

Builder.clientIdCopy Anchor Link

public OvokConfig.Builder clientId(String value)

Sets the OAuth client id.

Parameters:

• value: the client id

Returns: this builder

Builder.clientSecretCopy Anchor Link

public OvokConfig.Builder clientSecret(String value)

Sets the OAuth client secret, which makes this a machine client using client credentials.

Parameters:

• value: the client secret; requires a client id

Returns: this builder

Builder.transportCopy Anchor Link

public OvokConfig.Builder transport(HttpClient value)

Sets the HTTP client used for every request; the default is HttpClient.newHttpClient().

Parameters:

• value: the HTTP client

Returns: this builder

Builder.timeoutCopy Anchor Link

public OvokConfig.Builder timeout(Duration value)

Sets the default request timeout; the default is 30 seconds.

Parameters:

• value: a positive duration

Returns: this builder

Builder.maxNetworkRetriesCopy Anchor Link

public OvokConfig.Builder maxNetworkRetries(int value)

Sets how often a failed request is retried; the default is 2.

Parameters:

• value: the retry count, at least 0

Returns: this builder

Builder.onUnauthenticatedCopy Anchor Link

public OvokConfig.Builder onUnauthenticated(Consumer<UnauthenticatedReason> value)

Sets the callback run when the user session ends and the user must sign in again.

Parameters:

• value: the callback

Returns: this builder

Builder.buildCopy Anchor Link

public OvokConfig build()

Validates the settings and builds the configuration.

Returns: the configuration

Throws:

• OvokConfigException: if a setting is missing or invalid