An RDBMS Extension represents a Datasource to access the RDBMS. RDBMS Extension stores the login details and the parameters required for configuring a connection pool.
Parent Component
The RDBMS Extension component inherits from the Extension
Relations From this Component
The following components have a direct AGGREGATION relation FROM RDBMS Extensions :
Specifies the fully-qualified name of the Java class that provides the JDBC driver implementation for the RDBMS vendor.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No
jdbc-url
Description
JDBC URL for connecting to the database.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No
rdbms-password
Description
The password with which connections have to be obtained. This attribute is used to specify the rdbms password which is used to obtain connections. Password can also be provided in a file by using file URL syntax such as file:///tmp/pw.txt.
Default Value
Allowed Values
Unknown
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
rdbms-username
Description
The user name with which connections have to be obtained.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No
target-database
Description
Specify the Target Database in the backend.
Default Value
No Database specific customizations will be done
Allowed Values
db2 - DB2 is a family of relational database management system (RDBMS) products from IBM
db2mainframe - DB2 mainframe is a consolidated Database from IBM
derby - Derby is a relational database management system, can be embedded in Java programs and used for online transaction processing
mysql - mysql is a open source relational database management system from Oracle
mysql4 - mysql4 is a open source relational database management system from Oracle
oracle - Oracle Relational database and it can be any version
oracle10g - Oracle 10g is a version of the Oracle Database and the g stands for Grid
oracle11 - Oracle 11 is a version of the Oracle Database and the theme for this release is Consolidate Compress Control
oracle8i - Oracle 8i is a Oracle Database and i stands for Internet
oracle9i - Oracle 9i is a version of the Oracle Database and the i stands for Internet ready
postgresql - Postgres is an open source object-relational database management system (ORDBMS) with an emphasis on extensibility and standards compliance
sqlserver - Microsoft SQL Server is a relational database management system developed by Microsoft Inc.
timesten - TimesTen is an in-memory, relational database management system with persistence and recoverability
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
Advanced Properties
connection-pool-provider
Description
The connection pool implementation to use for this extension. By default we use Universal Connection Pool (UCP). NOTE: In case Simple_Pool is used then the RDBMS Extension cannot be shared across multiple RDBMS WorkflowElements.
Default Value
universal-connection-pool
Allowed Values
simple-pool -
universal-connection-pool -
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
connection-reuse-count
Description
Sets the maximum connection reuse count property. This property specifies the maximum number of times any connection can be reused after which the pool removes and closes a connection. The value must be greater than 0 for this feature to be enabled. For example, if the specified value is 100, then when a connection is reused or borrowed 100 times from the pool, it is closed and removed from the pool. Connections are closed gracefully after they are returned to the pool and the property value has been exceeded. Default is 0, which means this feature is not enabled.
Default Value
0
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
ignored-ldap-controls
Description
Specifies the OIDs of the supported LDAP controls which should be ignored in an LDAP request. A list of OIDs of supported LDAP controls can be specified here. If any of the LDAP request received contains such LDAP controls then those controls will be ignored.
Default Value
None
Allowed Values
A String
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
inactive-connection-timeout
Description
Sets the inactive connection timeout. This timeout determines how long an available connection remains in the connection pool before it is removed from the pool. The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0. Setting the value to 0 disables inactive connection timeout processing.
Default Value
0
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
initial-connection-pool-size
Description
The initial number of connections setup by the ConnectionPool. This is the number of connections that will be created and placed in the pool when the pool is started. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 0.
Default Value
0
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
java-class
Description
Specifies the fully-qualified name of the Java class that provides the RDBMS Extension implementation.
A java class that implements or extends the class(es) :
org.opends.server.api.Extension
Multi-valued
No
Required
Yes
Admin Action Required
The RDBMS Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No
jdbc-connection-properties
Description
Optional JDBC driver related connection properties as name value pair for DataSource connection factories that also support connection properties. Optional JDBC driver related connection properties as name value pair for DataSource connection factories that also support connection properties.
Default Value
None
Allowed Values
A String
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
jdbc-factory-properties
Description
Optional flag to specify if JDBC driver related connection properties need to be set as connection factory properties. Optional flag to specify if JDBC driver related connection properties need to be set as connection factory properties.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
jdbc-keystore-prop-name
Description
KeyStore property name for the JDBC driver. KeyStore property name for the JDBC driver.
Default Value
javax.net.ssl.keyStore
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
jdbc-keystore-pwd-prop-name
Description
KeyStore password property name for the JDBC driver. KeyStore password property name for the JDBC driver.
Default Value
javax.net.ssl.keyStorePassword
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
jdbc-keystore-type-prop-name
Description
KeyStore type property name for the JDBC driver. KeyStore type property name for the JDBC driver.
Default Value
javax.net.ssl.keyStoreType
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
jdbc-truststore-prop-name
Description
TrustStore property name for the JDBC driver. TrustStore property name for the JDBC driver.
Default Value
javax.net.ssl.trustStore
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
jdbc-truststore-pwd-prop-name
Description
TrustStore password property name for the JDBC driver. TrustStore password property name for the JDBC driver.
Default Value
javax.net.ssl.trustStorePassword
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
jdbc-truststore-type-prop-name
Description
TrustStore type property name for the JDBC driver. TrustStore type property name for the JDBC driver.
Default Value
javax.net.ssl.trustStoreType
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
login-timeout
Description
Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout.
Default Value
0
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
maximum-connection-pool-size
Description
The maximum number of connections that can be setup by the connection pool. The maximum number of connections includes the number of connections that are in use as well as the number of available connections. The range of valid values is 1 to Integer.MAX_VALUE. Defaults to 20.
Default Value
20
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
minimum-connection-pool-size
Description
Sets the minimum number of connections set up by the connection pool. If the number of available connections + the number of connections in use is less than the minimum then the connection is returned to the pool. Otherwise, the connection is closed. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 10.
Default Value
10
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
ssl-key-manager-provider
Description
Specifies key manager provider to use with RDBMS Extension. This key manager provider is not mandatory and may be used if the remote server is configured for client authentication. The referenced key manager provider must be enabled.
Specifies trust manager provider to use with RDBMS Extension. This trust manager provider is mandatory when secure connection needs to be established with the remote backend. The referenced trust manager provider must be enabled.