Progress DataDirect Autonomous REST Connector for JDBC User's Guide Release 6.0.1

Connection property descriptions

Save PDF

Connection property descriptions

Save PDF

Last Updated: December 4, 2025
3 minute read

DataDirect Connectors
JDBC
Autonomous REST Connector 6.0
Documentation

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:

In a JDBC data source, string values must be enclosed in double quotation marks, for example, setUser("abc@defcorp.com").
The data type listed for each connection property is the Java data type used for the property value in a JDBC data source.
Connection property names are case-insensitive. For example, Password is the same as password.
For connection properties that support string values, use the following escape sequence to specify values containing leading or trailing spaces and curly brackets: {value}. For example: User={hello } or Password={{hello}}.

The following tables describe the connection properties by functionality:

General properties

The following table summarizes connection properties which are that are used to connect to a REST service.

Table 1. General Properties
Property	Data Source Method	Default
Config	`getRestConfiguration()` `setRestConfiguration(URI)`	No default value
PortNumber	`getPortNumber()` `setPortNumber(Integer)`	No default value
Sample	`getSample()` `setSample(URI)`	No default value
ServerName	`getServerName()` `setServerName(String)`	No default value

Basic (user ID and password) authentication properties

The following table summarizes connection properties used for basic (user ID and password) authentication.

Table 2. Basic (user ID and password) authentication properties
Property	Data Source Method	Default
AuthenticationMethod	`getAuthenticationMethod()` `setAuthenticationMethod(String)`	`None`
AuthHeader	`getAuthHeader()` `setAuthHeader(String)`	`Authorization`
AuthParam	`getAuthParam()` `setAuthParam(String)`	No default value
HealthURI	`getHealthUri()` `setHealthUri(URI)`	No default value
Password	`getPassword()` `setPassword(String)`	No default value
User	`getUser()` `setUser(String)`	No default value

AWS authentication properties

The following table summarizes connection properties used for AWS credentials authentication.

Table 3. AWS authentication properties
Property	Data Source Method	Default
AuthenticationMethod	`getAuthenticationMethod()` `setAuthenticationMethod(String)`	`None`
AccessKey	`getAccessKey()` `setAccessKey(String)`	No default value
Region	`getRegionName()` `setRegionName(String)`	No default value
SecretKey	`getSecretKey()` `setSecretKey(String)`	No default value

Bearer token authentication properties

The following table summarizes connection properties used for bearer token authentication.

Table 4. Bearer token authentication properties
Property	Data Source Method	Default
AuthenticationMethod	`getAuthenticationMethod()` `setAuthenticationMethod(String)`	`None`
HealthURI	`getHealthUri()` `setHealthUri(URI)`	No default value
SecurityToken	`getSecurityToken()` `setSecurityToken(String)`	No default value

Custom authentication properties

The following table summarizes connection properties used for custom authentication.

Table 5. Custom authentication properties
Property	Data Source Method	Default
AuthenticationMethod	`getAuthenticationMethod()` `setAuthenticationMethod(String)`	`None`
CustomAuthParams	`getCustomAuthParams()` `setCustomAuthParams(String)`	No default value
HealthURI	`getHealthUri()` `setHealthUri(URI)`	No default value
Password	`getPassword()` `setPassword(String)`	No default value
User	`getUser()` `setUser(String)`	No default value

Digest authentication properties

The following table summarizes connection properties used for digest authentication.

Table 6. Digest authentication properties
Property	Data Source Method	Default
AuthenticationMethod	`getAuthenticationMethod()` `setAuthenticationMethod(String)`	`None`
HealthURI	`getHealthUri()` `setHealthUri(URI)`	No default value
Password	`getPassword()` `setPassword(String)`	No default value
User	`getUser()` `setUser(String)`	No default value

HTTP header authentication properties

The following table summarizes connection properties used for HTTP header authentication.

Table 7. HTTP header authentication properties
Property	Data Source Method	Default
AuthenticationMethod	`getAuthenticationMethod()` `setAuthenticationMethod(String)`	`None`
AuthHeader	`getAuthHeader()` `setAuthHeader(String)`	`Authorization`
HealthURI	`getHealthUri()` `setHealthUri(URI)`	No default value
SecurityToken	`getSecurityToken()` `setSecurityToken(String)`	No default value

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.

Table 8. OAuth 2.0 properties
Property	Data Source Method	Default
AccessToken	`getAccessToken()` `setAccessToken(String)`	No default value
AuthenticationMethod	`getAuthenticationMethod()` `setAuthenticationMethod(String)`	`None`
AuthURI	`getAuthUri()` `setAuthUri(String)`	No default value
ClaimsIssuer	`getClaimsIssuer()` `setClaimsIssuer(String)`	No default value
ClaimsSubject	`getClaimsSubject()` `setClaimsSubject(String)`	No default value
ClientID	`getClientId()` `setClientId(String)`	No default value
ClientCredentialsMode	`getClientCredentialsMode()` `setClientCredentialsMode(String)`	`Default`
ClientSecret	`getClientSecret()` `setClientSecret(String)`	No default value
EnableLoginPrompt	`getEnableLoginPrompt()` `setEnableLoginPrompt(Boolean)`	`false`
HealthURI	`getHealthUri()` `setHealthUri(URI)`	No default value
JWTCertAlias	`getJwtCertAlias()` `setJwtCertAlias(String)`	No default value
JWTCertPassword	`getJwtCertPassword()` `setJwtCertPassword(String)`	No default value
JWTCertStore	`getJwtCertStore()` `setJwtCertStore(String)`	No default value
LogoffURI	`getLogoffUri()` `setLogoffUri(String)`	No default value
OAuthCode	`getCode()` `setCode(String)`	No default value
RedirectURI	`getRedirUri()` `setRedirUri(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

URL parameter authentication properties

The following table summarizes connection properties used for user URL parameter authentication.

Table 9. URL parameter authentication properties
Property	Data Source Method	Default
AuthenticationMethod	`getAuthenticationMethod()` `setAuthenticationMethod(String)`	`None`
AuthParam	`getAuthParam()` `setAuthParam(String)`	No default value
HealthURI	`getHealthUri()` `setHealthUri(URI)`	No default value
SecurityToken	`getSecurityToken()` `setSecurityToken(String)`	No default value
User	`getUser()` `setUser(String)`	No default value

Data encryption properties

The following table summarizes properties used for configuring data encryption.

Table 10. Data encryption properties
Property	Data Source Method	Default
CryptoProtocolVersion	`getCryptoProtocolVersion()` `setCryptoProtocolVersion(String)`	No default value
EncryptionMethod	`getEncryptionMethod()` `setEncryptionMethod(String)`	`NoEncryption`
HostNameInCertificate	`getHostNameInCertificate()` `setHostNameInCertificate(String)`	No default value
KeyPassword	`getKeyPassword()` `setKeyPassword(String)`	No default value
Keystore	`getKeystore()` `setKeystore(String)`	No default value
KeystorePassword	`getKeystorePassword()` `setKeystorePassword(String)`	No default value
Truststore	`getTruststore()` `setTruststore(String)`	No default value
TruststorePassword	`getTruststorePassword()` `setTruststorePassword(String)`	No default value
ValidateServerCertificate	`getValidateServerCert()` `setValidateServerCert(Boolean)`	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)`	`0` which means that the default value is determined by the ProxyHost property. For HTTP: `80` For HTTPS: `443`
ProxyUser	`getProxyUser()` `setProxyUser(String)`	No default value

Web service properties

The following table summarizes Web service connection properties.

Table 11. Timeout Properties
Property	Data Source Method	Default
StmtCallLimit	`getStmtCallLimit()` `setStmtCallLimit(Integer)`	`0` (no limit)
StmtCallLimitBehavior	`getStmtCallLimitBehavior()` `setStmtCallLimitBehavior(String)`	`ErrorAlways`
WSFetchSize	`getWSFetchSize()` `setWSFetchSize(Integer)`	`2000`
WSPoolSize	`getWsPoolSize()` `setWsPoolSize(Integer)`	`1`
WSRetryCount	`getWSRetryCount()` `setWSRetryCount(Integer)`	`5`
WSTimeout	`getWSTimeout()` `setWSTimeout(Integer)`	`120`

Data type properties

The following table summarizes connection properties which care related to data type behavior.


Property	Data Source Method	Default
ConvertNull	`getConvertNull()` `setConvertNull(Boolean)`	`true`
JDBCBehavior	`getJdbcBehavior()` `setJdbcBehavior(Integer)`	`1` (data types described using JDBC 3.0-equivalent data types)

Statement pooling properties

The following table summarizes statement pooling connection properties.

Table 12. Statement Pooling Properties
Property	Data Source Method	Default
ImportStatementPool	`getImportStatementPool()` `setImportStatementPool(String)`	No default value
MaxPooledStatements	`getMaxPooledStatements()` `setMaxPooledStatements(Integer)`	`0`
RegisterStatementPoolMonitorMBean	`getRegisterStatementPoolMonitorMbean()` `setRegisterStatementPoolMonitorMbean(Boolean)`	`false`

Additional properties

The following table summarizes additional connection properties.

Table 13. Additional Properties
Property	Data Source Method	Default
DebugRecord	`getDebugRecord()` `setDebugRecord(String)`	No default value
DefaultQueryOptions	`getDefaultQueryOptions()` `setDefaultQueryOptions(String)`	No default value
FetchSize	`getFetchSize()` `setFetchSize(Integer)`	`100` (rows)
FileTransferPartSize	`getFileTransferPartSize()` `setFileTransferPartSize(Integer)`	No default value
InsensitiveResultSetBufferSize	`getInsensitiveResultsetBufferSize()` `setInsensitiveResultsetBufferSize(Integer)`	`2048`
LogConfigFile	`getLogConfigFile()` `setLogConfigFile(String)`	`ddlogging.properties`
QualifyNormalizedNames	`public String getQualifyNormalizedNames()` `public void setQualifyNormalizedNames(String)`	`No`
ReadAhead	`getReadAheadThreads()` `setReadAheadThreads(Integer)`	`0`
RefreshDirtyCache	`getRefreshDirtyCache()` `setRefreshDirtyCache(Boolean)`	`true`
SamplingFailureTolerance	`getSamplingFailureTolerance()` `setSamplingFailureTolerance(Integer)`	`-1`
SpyAttributes	`getSpyAttributes()` `setSpyAttributes(String)`	No default value
Table	`getTable()` `setTable(String)`	No default value
TransactionMode	`getTransactionMode()` `setTransactionMode(String)`	`NoTransactions`

Progress DataDirect Autonomous REST Connector for JDBC User's Guide Release 6.0.1