You can use connection properties to customize the driver for your environment. This section organizes connection properties according to functionality. You can use connection properties with either the JDBC DriverManager or a JDBC data source. For a DriverManager connection, a property is expressed as a key value pair and takes the form property=value. For a data source connection, a property is expressed as a JDBC method and takes the form setproperty(value).

Note: Connection property names are case-insensitive. For example, Password is the same as password.
Note: setUser("abc@defcorp.com").

The following tables describe the connection properties by functionality.In a JDBC data source, string values must be enclosed in double quotation marks, for example,

OAuth 2.0 properties

The following table summarizes properties used for OAuth 2.0 authentication. The OAuth 2.0 properties you must specify depend on the grant type used in your environment. If you are unsure of the grant type or its requirements, contact your system administrator. For details on supported grant types, see OAuth 2.0 authentication.

Property Data Source Method Default
AccessToken getAccessToken()

setAccessToken(String)

 No default value
AuthenticationMethod getAuthenticationMethod()

setAuthenticationMethod(String)

 No default value
ClientID getClientId()

setClientId(String)

 No default value
ClientSecret getClientSecret()

setClientSecret(String)

 No default value
RefreshToken getRefreshToken()

setRefreshToken(String)

 No default value
Scope getScope()

setScope(String)

 No default value
TokenURI getTokenUri()

setTokenUri(String)

 No default value

API key properties

The following table summarizes the connection properties required for API key authentication.

Property Data Source Method Default
AuthenticationMethod getAuthenticationMethod()

setAuthenticationMethod(String)

 OAuth2
APIKey getApiKey()

setApiKey(String)

 No default value

Proxy server properties

The following table summarizes proxy server connection properties.

Property Data Source Method Default
ProxyHost getProxyHost()

setProxyHost(String)

 No default value
ProxyPassword getProxyPassword()

setProxyPassword(String)

 No default value
ProxyPort getProxyPort()

setProxyPort(Integer)

 No default value
ProxyUser getProxyUser()

setProxyUser(String)

 No default value

Web service and timeout properties

The following table summarizes web service connection properties, including those related to timeouts.

Property Data Source Method Default
WSRetryCount getWSRetryCount()

setWSRetryCount(Integer)

 5
WSTimeout getWSTimeout()

setWsTimeout(Integer)

 120 (seconds)

Additional properties

The following table summarizes additional connection properties.

Property Data Source Method Default
FetchSize getFetchSize()

setFetchSize(Integer)

 100 (rows)
LogConfigFile getLogConfigFile()

setLogConfigFile(String)

 ddlogging.properties