Purpose

Specifies the URI that the driver calls to confirm connectivity when using certain authentication methods.

Services using some authentication methods, such as Basic, Digest, URL Parameter-based, or HTTP header-based, do not perform an explicit action upon connection. Instead, authentication occurs only when query or update operations are executed. As a result, the driver does not receive feedback to determine whether a connection attempt was successful. You can work around this limitation by specifying a value for this property. At connection, when a value is specified, the driver issues a request to the specified URI, analyzes the result status, and then discards the result.

Valid Values

test_uri

where:

test_uri

is the absolute or relative URI against which the driver executes a query to test connectivity. For optimal performance, this value should be an endpoint that executes quickly and has a small response.

Notes

  • The driver performs a connectivity test at connection, when executing a test connect, or whenever the driver needs to confirm connectivity.

  • If no value is specified for this property, executing a test connect on the Configuration Manager will return a message that the connection was successful every time.

Data Source Methods

public URI getHealthUri()

public void setHealthUri(URI)

Default Value

No default value

Data Type

URI