Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
JDBC External Servers are used to specify connections to an RDBMS using JDBC (version 3.0 or higher).
JDBC External Servers provide the information needed to connect to a DBMS using JDBC. We strongly recommend using Type 4 JDBC drivers to get the maximum performance and predictable behavior. For convenience, we provide the basic driver selection for many common database systems which automatically creates a well-formed JDBC connection URL. In case you need special URL connection parameters, you should select the driver type of 'other' and supply your database connection URL. You will have to consult your database vendor documentation if you are not sure what connection parameters to select.
The JDBC External Server component inherits from the External Server
The following components have a direct aggregation relation from JDBC External Servers:
The following components have a direct aggregation relation to JDBC External Servers:
The properties supported by this managed object are as follows:
| Description | A description for this External Server |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies a supported database driver type. The driver class will be automatically selected based on this selection. We highly recommend using a JDBC 4 driver that is suitable for the current Java platform. If you want to specify your own JDBC connection URL, select 'other' for this property. |
| Default Value | None |
| Allowed Values | oraclethin - Use the Oracle pure Java thin client. The JDBC URL format uses Oracle Services rather than the SID. If you need to use SID support, please select driver type 'other' and supply the appropriate URL. oracleoci - Use the Oracle OCI driver which requires Oracle client software to be preinstalled. The JDBC URL format uses Oracle Services rather than the SID. If you need to use SID support, please select driver type 'other' and supply the appropriate URL. mysql - Use the MySQL pure Java JDBC client db2 - Use the DB2 Universal Driver sqlserver - Use the SQLServer pure Java JDBC client postgres - Use the PostgeSQL pure Java JDBC client other - Specify the JDBC URL using the jdbc-driver-url property. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specify the complete JDBC URL which will be used instead of the automatic URL format. You must select type 'other' for the jdbc-driver-type. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies which database to connect to. This is ignored if jdbc-driver-url is specified. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The host name of the database server. This is ignored if jdbc-driver-url is specified. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The port number where the database server listens for requests. This is ignored if jdbc-driver-url is specified |
| Default Value | None |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 65535 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The name of the login account to use when connecting to the database server. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The login password for the specified user name. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The passphrase provider to use to obtain the login password for the specified user. |
| Default Value | None |
| Allowed Values | The DN of any Passphrase Provider. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
validation-query (Advanced Property)
| Description | The SQL query that will be used to validate connections to the database before making them available to the Directory Server. If specified, this query MUST be an SQL SELECT statement that returns at least one row. This property is not required by all JDBC driver implementations. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
validation-query-timeout (Advanced Property)
| Description | Specifies the amount of time to wait for a response from the database when executing the validation query, if one is set. If the timeout is exceeded, the Directory Server will drop the connection and obtain a new one. A value of zero indicates no timeout. |
| Default Value | 10 s |
| Allowed Values | A duration. Lower limit is 0 seconds. Upper limit is 100000 seconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
jdbc-connection-properties (Advanced Property)
| Description | Specifies the connection properties for the JDBC datasource. The properties are specific to the JDBC driver you are using; refer to the documentation for the respective driver for a list of what properties are available. All types of values (literals, booleans, numbers, etc.) are interpreted as strings, so for example you might specify "internal_logon=SYSDBA" and also "processEscapes=false". |
| Default Value | None |
| Allowed Values | A 'key=value' property pair to specify on the JDBC data source. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
transaction-isolation-level (Advanced Property)
| Description | This property specifies the default transaction isolation level for connections to this JDBC External Server. This allows a user to specify how severely a transaction should be isolated from other transactions. For example, you can specify whether transaction A is allowed to make changes to data that has been viewed by transaction B before transaction B has been committed. JDBC specifies four levels of transaction isolation. The higher the transaction isolation, the more care is taken to avoid conflicts; avoiding conflicts sometimes means locking out transactions. Lower isolation levels thus allow greater concurrency. |
| Default Value | read-committed |
| Allowed Values | read-committed - Indicates that dirty reads are prevented; non-repeatable reads, and phantom reads can occur. read-uncommitted - Indicates that dirty reads, non-repeatable reads, and phantom reads can occur. repeatable-read - Indicates that dirty reads and non-repeatable reads are prevented; phantom reads can occur. serializable - Indicates that dirty reads, non-repeatable reads, and phantom reads are prevented. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured External Servers:
dsconfig list-external-servers
[--property {propertyName}] ...
To view the configuration for an existing External Server:
dsconfig get-external-server-prop
--server-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing External Server:
dsconfig set-external-server-prop
--server-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new JDBC External Server:
dsconfig create-external-server
--server-name {name}
--type jdbc
--set jdbc-driver-type:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing External Server:
dsconfig delete-external-server
--server-name {name}