Oracle® Database JDBC Developer's Guide and Reference 10g Release 2 (10.2) Part Number B14355-02 |
|
|
View PDF |
This chapter discusses connecting applications to databases using Java Database Connectivity (JDBC) data sources, as well as the URLs that describe databases. This chapter contains the following sections:
Data sources are standard, general-use objects for specifying databases or other resources to use. The JDBC 2.0 extension application programming interface (API) introduced the concept of data sources. For convenience and portability, data sources can be bound to Java Naming and Directory Interface (JNDI) entities, so that you can access databases by logical names.
The data source facility provides a complete replacement for the previous JDBC DriverManager
facility. You can use both facilities in the same application, but it is recommended that you transition your application to data sources.
This section covers the following topics:
The JNDI standard provides a way for applications to find and access remote services and resources. These services can be any enterprise services. However, for a JDBC application, these services would include database connections and services.
JNDI allows an application to use logical names in accessing these services, removing vendor-specific syntax from application code. JNDI has the functionality to associate a logical name with a particular source for a desired service.
All Oracle JDBC data sources are JNDI-referenceable. The developer is not required to use this functionality, but accessing databases through JNDI logical names makes the code more portable.
Note:
Using JNDI functionality requires the filejndi.jar
to be in the CLASSPATH
. This file is included with the Java products on the installation CD, but is not included in the classes12.jar
or ojdbc14.jar
file. You must add it to the CLASSPATH
separately. You can also obtain it from the Sun Microsystems Web site, but it is advisable to use the version from Oracle, because it has been tested with the Oracle drivers.By using the data source functionality with JNDI, you do not need to register the vendor-specific JDBC driver class name and you can use logical names for URLs and other properties. This ensures that the code for opening database connections is portable to other environments.
The DataSource Interface and Oracle Implementation
A JDBC data source is an instance of a class that implements the standard javax.sql.DataSource
interface:
public interface DataSource { Connection getConnection() throws SQLException; Connection getConnection(String username, String password) throws SQLException; ... }
Oracle implements this interface with the OracleDataSource
class in the oracle.jdbc.pool
package. The overloaded getConnection
method returns a physical connection to the database.
To use other values, you can set properties using appropriate setter methods. For alternative user names and passwords, you can also use the getConnection
method that takes these parameters as input. This would take priority over the property settings.
Note:
TheOracleDataSource
class and all subclasses implement the java.io.Serializable
and javax.naming.Referenceable
interfaces.The
OracleDataSource
class, as with any class that implements the DataSource
interface, provides a set of properties that can be used to specify a database to connect to. These properties follow the JavaBeans design pattern.
Table 9-1 and Table 9-2 list OracleDataSource
properties. The properties in Table 9-1 are standard properties according to the Sun Microsystems specification. The properties in Table 9-2 are Oracle extensions.
Note:
Oracle does not implement the standardroleName
property.Table 9-1 Standard Data Source Properties
Name | Type | Description |
---|---|---|
|
|
Name of the particular database on the server. Also known as the SID in Oracle terminology. |
|
|
Name of the underlying data source class. For connection pooling, this is an underlying pooled connection data source class. For distributed transactions, this is an underlying XA data source class. |
|
|
Description of the data source. |
|
|
Network protocol for communicating with the server. For Oracle, this applies only to the JDBC Oracle Call Interface (OCI) drivers and defaults to |
|
|
Password for the connecting user. |
|
|
Number of the port where the server listens for requests |
|
|
Name of the database server |
|
|
Name for the login |
The OracleDataSource
class implements the following setter and getter methods for the standard properties:
public synchronized void setDatabaseName(String dbname)
public synchronized String getDatabaseName()
public synchronized void setDataSourceName(String dsname)
public synchronized String getDataSourceName()
public synchronized void setDescription(String desc)
public synchronized String getDescription()
public synchronized void setNetworkProtocol(String np)
public synchronized String getNetworkProtocol()
public synchronized void setPassword(String pwd)
public synchronized void setPortNumber(int pn)
public synchronized int getPortNumber()
public synchronized void setServerName(String sn)
public synchronized String getServerName()
public synchronized void setUser(String user)
public synchronized String getUser()
Table 9-2 Oracle Extended Data Source Properties
Name | Type | Description |
---|---|---|
|
|
Specifies the name of the cache. This cannot be changed after the cache has been created. |
|
|
Specifies properties for implicit connection cache. |
|
|
Specifies whether implicit connection cache is in use. |
|
|
Specifies the connection properties. |
|
Specifies the Oracle JDBC driver type. It can be one of |
|
|
|
Specifies whether Fast Connection Failover is in use. |
|
|
Specifies whether the implicit statement connection cache is enabled. |
|
|
Specifies the maximum time in seconds that this data source will wait while attempting to connect to a database. |
|
|
Specifies the log writer for this data source. |
|
|
Specifies the maximum number of statements in the application cache. |
|
|
Specifies the database service name for this data source. |
|
Specifies the TNS entry name, relevant only for the OCI driver. The TNS entry name corresponds to the TNS entry specified in the Enable this |
|
|
Specifies the URL of the database connect string. Provided as a convenience, it can help you migrate from an older Oracle Database. You can use this property in place of the Oracle |
|
|
Allows an This |
|
|
|
Specifies the ONS configuration string that is used to remotely subscribe to FaN/ONS events. |
Notes:
This table omits properties that supported the deprecated connection cache based on OracleConnectionCache
.
Because Native XA performs better than Java XA, use Native XA whenever possible.
The OracleDataSource
class implements the following set
XXX
and get
XXX
methods for the Oracle extended properties:
String getConnectionCacheName()
java.util.Properties getConnectionCacheProperties()
void setConnectionCacheProperties(java.util.Properties cp)
java.util.Properties getConnectionProperties()
void setConnectionProperties(java.util.Properties cp)
boolean getConnectionCachingEnabled()
void setImplicitCachingEnabled()
String getDriverType()
void setDriverType(String dt)
String getURL()
void setURL(String url)
String getTNSEntryName()
void setTNSEntryName(String tns)
boolean getNativeXA()
void setNativeXA(boolean nativeXA)
String getONSConfiguration()
void setONSConfiguration(String onsConfig)
If you are using the server-side internal driver, that is, the driverType
property is set to kprb
, then any other property settings are ignored.
If you are using the JDBC Thin or OCI driver, then note the following:
A URL setting can include settings for user
and password
, as in the following example, in which case this takes precedence over individual user
and password
property settings:
jdbc:oracle:thin:scott/tiger@localhost:1521:orcl
Settings for user
and password
are required, either directly through the URL setting or through the getConnection
call. The user
and password
settings in a getConnection
call take precedence over any property settings.
If the url
property is set, then any tnsEntry
, driverType
, portNumber
, networkProtocol
, serverName
, and databaseName
property settings are ignored.
If the tnsEntry
property is set, which presumes the url
property is not set, then any databaseName
, serverName
, portNumber
, and networkProtocol
settings are ignored.
If you are using an OCI driver, which presumes the driverType
property is set to oci
, and the networkProtocol
is set to ipc
, then any other property settings are ignored.
Also, note that getConnectionCacheName()
will return the name of the cache only if the ConnectionCacheName
property of the data source is set after caching is enabled on the data source.
This section shows an example of the most basic use of a data source to connect to a database, without using JNDI functionality. Note that this requires vendor-specific, hard-coded property settings.
Create an OracleDataSource
instance, initialize its connection properties as appropriate, and get a connection instance, as in the following example:
OracleDataSource ods = new OracleDataSource(); ods.setDriverType("oci"); ods.setServerName("dlsun999"); ods.setNetworkProtocol("tcp"); ods.setDatabaseName("816"); ods.setPortNumber(1521); ods.setUser("scott"); ods.setPassword("tiger"); Connection conn = ods.getConnection();
Or, optionally, override the user name and password, as follows:
Connection conn = ods.getConnection("bill", "lion");
This section exhibits JNDI functionality in using data sources to connect to a database. Vendor-specific, hard-coded property settings are required only in the portion of code that binds a data source instance to a JNDI logical name. From that point onward, you can create portable code by using the logical name in creating data sources from which you will get your connection instances.
Note:
Creating and registering data sources is typically handled by a JNDI administrator, not in a JDBC application.Initialize Data Source Properties
Create an OracleDataSource
instance, and then initialize its properties as appropriate, as in the following example:
OracleDataSource ods = new OracleDataSource(); ods.setDriverType("oci"); ods.setServerName("dlsun999"); ods.setNetworkProtocol("tcp"); ods.setDatabaseName("816"); ods.setPortNumber(1521); ods.setUser("scott"); ods.setPassword("tiger");
Once you have initialized the connection properties of the OracleDataSource
instance ods
, as shown in the preceding example, you can register this data source instance with JNDI, as in the following example:
Context ctx = new InitialContext(); ctx.bind("jdbc/sampledb", ods);
Calling the JNDI InitialContext()
constructor creates a Java object that references the initial JNDI naming context. System properties, which are not shown, instruct JNDI which service provider to use.
The ctx.bind
call binds the OracleDataSource
instance to a logical JNDI name. This means that anytime after the ctx.bind
call, you can use the logical name jdbc/sampledb
in opening a connection to the database described by the properties of the OracleDataSource
instance ods
. The logical name jdbc/sampledb
is logically bound to this database.
The JNDI namespace has a hierarchy similar to that of a file system. In this example, the JNDI name specifies the subcontext jdbc
under the root naming context and specifies the logical name sampledb
within the jdbc
subcontext.
The Context
interface and InitialContext
class are in the standard javax.naming
package.
Notes:
The JDBC 2.0 Specification requires that all JDBC data sources be registered in thejdbc
naming subcontext of a JNDI namespace or in a child subcontext of the jdbc
subcontext.To perform a lookup and open a connection to the database logically bound to the JNDI name, use the logical JNDI name. Doing this requires casting the lookup result, which is otherwise a Java Object
, to OracleDataSource
and then using its getConnection
method to open the connection.
OracleDataSource odsconn = (OracleDataSource)ctx.lookup("jdbc/sampledb"); Connection conn = odsconn.getConnection();
Table 9-3 provides the detailed list of connection properties that Oracle JDBC drivers support.
Table 9-3 Connection Properties Recognized by Oracle JDBC Drivers
Name | Type | Description |
---|---|---|
|
BooleanFoot 1 |
The value |
|
String |
Connect string for the database |
|
IntegerFootref 1 |
The default batch value that triggers an execution request. The default value is |
|
IntegerFootref 1 |
The default batch size when using Oracle batching. |
|
BooleanFootref 1 |
The value |
|
IntegerFootref 1 |
The default number of rows to prefetch from the server. The default value is |
|
BooleanFootref 1 |
The value This is highly recommended when using JDBC Thin driver, especially when the database character set contains four byte characters that expand to two UCS2 surrogate characters, for example, AL32UTF8. |
|
String |
Name of the Dynamic Monitoring Service (DMS) Noun that is the parent of all JDBC DMS metrics. |
|
String |
Type of the DMS Noun that is the parent of all JDBC DMS metrics. |
|
BooleanFootref 1 |
The value |
|
BooleanFootref 1 |
Set to |
|
String |
The user name used in an internal logon. Must be the role, such as |
|
BooleanFootref 1 |
The value |
|
BooleanFootref 1 |
The value |
|
String |
Name of the native library for the JDBC OCI driver. If not set, then the default name, |
|
String |
The password for logging into the database. |
|
BooleanFootref 1 |
|
|
BooleanFootref 1 |
|
|
BooleanFootref 1 |
The value |
|
BooleanFootref 1 |
The value |
|
String |
Name of the database host. |
|
BooleanFootref 1 |
Orders Oracle Net to preempt delays in buffer flushing within the TCP/IP protocol stack. |
|
BooleanFootref 1 |
The value Note: Oracle recommends the use of |
|
String |
The user name for logging into the database. |
Footnote 1 All these entries are actually strings containing a value of the type listed.
To specify the role for the SYS
login, use the internal_logon
connection property. To logon as SYS
, set the internal_logon
connection property to SYSDBA
or SYSOPER
.
Note:
The ability to specify a role is supported only for thesys
user name.For a bequeath connection, we can get a connection as SYS
by setting the internal_logon
property. For a remote connection, we need additional password file setting procedures.
Before the JDBC Thin driver can connect to the database as SYSDBA
, you must configure the user, because the Oracle Database security system requires a password file for remote connections as an administrator. Perform the following:
Set a password file on the server side or on the remote database, using the orapwd
password utility. You can add a password file for user sys
as follows:
In UNIX
orapwd file=$ORACLE_HOME/dbs/orapw password=sys entries=200
In Microsoft Windows
orapwd file=%ORACLE_HOME%\database\PWDsid_name.ora password=sys entries=200
file
must be the name of the password file. password
is the password for the user SYS
. It can be altered using the ALTER USER
statement in SQL Plus. You should set entries
to a value higher than the number of entries you expect.
The syntax for the password file name is different on Microsoft Windows and UNIX.
See Also:
Oracle Database Administrator's GuideEnable remote login as sysdba
. This step grants SYSDBA
and SYSOPER
system privileges to individual users and lets them connect as themselves.
Stop the database, and add the following line to init
service_name
.ora
, in UNIX, or init.ora
, in Microsoft Windows:
remote_login_passwordfile=exclusive
The init
service_name
.ora
file is located at ORACLE_HOME
/dbs/
and also at ORACLE_HOME
/admin/db_name/pfile/
. Ensure that you keep the two files synchronized.
The init.ora
file is located at %ORACLE_BASE%\ADMIN\db_name\pfile\
.
Change the password for the SYS
user. This is an optional step.
SQL> alter user sys identified by sys;
Verify whether SYS
has the SYSDBA
privilege.
SQL> select * from v$pwfile_users; USERNAME SYSDB SYSOP ---------------------- --------- --------- SYS TRUE TRUE
Restart the remote database.
Example 9-1 Using SYS Login To Make a Remote Connection
//This example works regardless of language settings of the database. /** case of remote connection using sys **/ import java.sql.*; import oracle.jdbc.*; import oracle.jdbc.pool.*; // create an OracleDataSource OracleDataSource ods = new OracleDataSource(); // set connection properties java.util.Properties prop = new java.util.Properties(); prop.put("user", "sys"); prop.put("password", "sys"); prop.put("internal_logon", "sysoper"); ods.setConnectionProperties(prop); // set the url // the url can use oci driver as well as: // url = "jdbc:oracle:oci8:@inst1"; the inst1 is a remote database String url = "jdbc:oracle:thin:@//myHost:1521/service_name"; ods.setURL(url); // get the connection Connection conn = ods.getConnection(); ...
The following example illustrates how to use the internal_logon
and SYSDBA
arguments to specify the SYS
login. This example works regardless of the database's national-language settings of the database.
/** Example of bequeath connection **/ import java.sql.*; import oracle.jdbc.*; import oracle.jdbc.pool.*; // create an OracleDataSource instance OracleDataSource ods = new OracleDataSource(); // set neccessary properties java.util.Properties prop = new java.util.Properties(); prop.put("user", "sys"); prop.put("password", "sys"); prop.put("internal_logon", "sysdba"); ods.setConnectionProperties(prop); // the url for bequeath connection String url = "jdbc:oracle:oci8:@"; ods.setURL(url); // retrieve the connection Connection conn = ods.getConnection(); ...
Some of the connection properties are for use with Oracle performance extensions. Setting these properties is equivalent to using corresponding methods on the OracleConnection
object, as follows:
Setting the defaultRowPrefetch
property is equivalent to calling setDefaultRowPrefetch
.
See Also:
"Oracle Row Prefetching"Setting the remarksReporting
property is equivalent to calling setRemarksReporting
.
Setting the defaultBatchValue
property is equivalent to calling setDefaultExecuteBatch
See Also:
"Oracle Update Batching"Example
The following example shows how to use the put
method of the java.util.Properties
class, in this case, to set Oracle performance extension parameters.
//import packages and register the driver import java.sql.*; import java.math.*; import oracle.jdbc.*; import oracle.jdbc.pool.OracleDataSource; //specify the properties object java.util.Properties info = new java.util.Properties(); info.put ("user", "scott"); info.put ("password", "tiger"); info.put ("defaultRowPrefetch","20"); info.put ("defaultBatchValue", "5"); //specify the datasource object OracleDataSource ods = new OracleDataSource(); ods.setURL("jdbc:oracle:thin:@//myhost:1521/orcl"); ods.setUser("scott"); ods.setPassword("tiger"); ods.setConnectionProperties(info); ...
The data source facility offers a way to register a character stream for JDBC to use as output for error logging and tracing information. This facility enables tracing specific to a particular data source instance. If you want all data source instances to use the same character stream, then you must register the stream with each data source instance individually.
The OracleDataSource
class implements the following standard data source methods for logging and tracing:
public synchronized void setLogWriter(PrintWriter pw)
public synchronized PrintWriter getLogWriter()
The PrintWriter
class is in the standard java.io
package.
Notes:
When a data source instance is created, logging is disabled by default. The log stream name is initially null
.
Messages written to a log stream registered to a data source instance are not written to the same log stream used by DriverManager
.
An OracleDataSource
instance obtained from a JNDI name lookup will not have its PrinterWriter
set, even if the PrintWriter
was set when a data source instance was first bound to this JNDI name.
Database URLs are strings. The complete URL syntax is:
jdbc:oracle:driver_type:[username/password]@database_specifier
Notes:
The brackets indicate that the username
/
password
pair is optional.
kprb
, the internal server-side driver, uses an implicit connection. Database URLs for the server-side driver end after the driver_type
.
The first part of the URL specifies which JDBC driver is to be used. The supported driver_type
values are thin
, oci
, and kprb
.
The remainder of the URL contains an optional user name and password separated by a slash, an @, and the database specifier, which uniquely identifies the database to which the application is connected. Some database specifiers are valid only for the JDBC Thin driver, some only for the JDBC OCI driver, and some for both.
Database Specifiers
Table 9-4, shows the possible database specifiers, listing which JDBC drivers support each specifier.
Notes:
Starting Oracle Database 10g, Oracle Service IDs are not supported.
Oracle Database 10g no longer supports Oracle Names as a naming method.
Table 9-4 Supported Database Specifiers
Specifier | Supported Drivers | Example |
---|---|---|
Oracle Net connection descriptor |
Thin, OCI |
Thin, using an address list: url="jdbc:oracle:thin:@(DESCRIPTION= (LOAD_BALANCE=on) (ADDRESS_LIST= (ADDRESS=(PROTOCOL=TCP)(HOST=host1) (PORT=1521)) (ADDRESS=(PROTOCOL=TCP)(HOST=host2)(PORT=1521))) (CONNECT_DATA=(SERVICE_NAME=service_name)))" OCI, using a cluster: "jdbc:oracle:oci:@(DESCRIPTION= (ADDRESS=(PROTOCOL=TCP)(HOST=cluster_alias) (PORT=1521)) (CONNECT_DATA=(SERVICE_NAME=service_name)))" |
Thin-style service name |
Thin |
Refer to "Thin-style Service Name Syntax" for details. "jdbc:oracle:thin:scott/tiger@//myhost:1521/myservicename" |
LDAP syntax |
Thin |
Refer to LDAP Syntax for details. |
Bequeath connection |
OCI |
Empty. That is, nothing after @ "jdbc:oracle:oci:scott/tiger/@" |
TNSNames alias |
Thin, OCI |
Refer to "TNSNames Alias Syntax" for details. |
Thin-style Service Name Syntax
Thin-style service names are supported only by the JDBC Thin driver. The syntax is:
@//
host_name
:
port_number
/
service_name
Notes:
host_name
can be the name of a single host or a cluster_alias
.
TNSNames Alias Syntax
You can find the available TNSNAMES
entries listed in the tnsnames.ora
file on the client computer from which you are connecting. On Windows, this file is located in the ORACLE_HOME
\NETWORK\ADMIN
directory. On UNIX systems, you can find it in the ORACLE_HOME
directory or the directory indicated in your TNS_ADMIN
environment variable.
For example, if you want to connect to the database on host myhost
as user scott
with password tiger
that has a TNSNAMES
entry of MyHostString
, then write the following:
OracleDataSource ods = new OracleDataSource(); ods.setTNSEntryName("MyTNSAlias"); ods.setUser("scott"); ods.setPassword("tiger"); ods.setDriverType("oci"); Connection conn = ods.getConnection();
The oracle.net.tns_admin
system property must be set to the location of the tnsnames.ora
file so that the JDBC Thin driver can locate the tnsnames.ora
file. For example:
System.setProperty("oracle.net.tns_admin", "c:\\Temp"); String url = "jdbc:oracle:thin:@tns_entry";
Note:
When using TNSNames with the JDBC Thin driver, you must set theoracle.net.tns_admin
property to the directory that contains your tnsnames.ora
file.
java -Doracle.net.tns_admin=$ORACLE_HOME/network/admin
An example of database specifier using the Lightweight Directory Access Protocol (LDAP) syntax is as follows:
"jdbc:oracle:thin:@ldap://ldap.acme.com:7777/sales,cn=OracleContext,dc=com"
When using SSL, change this to:
"jdbc:oracle:thin:@ldaps://ldap.acme.com:7777/sales,cn=OracleContext,dc=com"
Notes:
The JDBC Thin driver can use LDAP over SSL to communicate with Oracle Internet Directory if you substituteldaps:
for ldap:
in the database specifier. The LDAP server must be configured to use SSL. If it is not, then the connection attempt will hang.The JDBC Thin driver supports failover of a list of LDAP servers during the service name resolution process, without the need for a hardware load balancer. Also, client-side load balancing is supported for connecting to LDAP servers. A list of space separated LDAP URLs syntax is used to support failover and load balancing.
When a list of LDAP URLs is specified, both failover and load balancing are enabled by default. The oracle.net.ldap_loadbalance
connection property can be used to disable load balancing, and the oracle.net.ldap_failover
connection property can be used to disable failover.
An example, which uses failover, but with client-side load balancing disabled, is as follows:
Properties prop = new Properties(); String url = "jdbc:oracle:thin:@ldap://ldap1.acme.com:3500/cn=salesdept,cn=OracleContext,dc=com/salesdb " + "ldap://ldap2.acme.com:3500/cn=salesdept,cn=OracleContext,dc=com/salesdb " + "ldap://ldap3.acme.com:3500/cn=salesdept,cn=OracleContext,dc=com/salesdb"; prop.put("oracle.net.ldap_loadbalance", "OFF" ); OracleDataSource ods = new OracleDataSource(); ods.setURL(url); ods.setConnectionProperties(prop);
The JDBC Thin driver supports LDAP nonanonymous bind. A set of JNDI environment properties, which contains authentication information, can be specified for a data source. If a LDAP server is configured as not allowing anonymous bind, then authentication information must be provided to connect to the LDAP server. The following example shows a simple clear-text password authentication:
String url = "jdbc:oracle:thin:@ldap://ldap.acme.com:7777/sales,cn=salesdept,cn=OracleContext,dc=com"; Properties prop = new Properties(); prop.put("java.naming.security.authentication", "simple"); prop.put("java.naming.security.principal","cn=salesdept,cn=OracleContext,dc=com"); prop.put("java.naming.security.credentials", "mysecret"); OracleDataSource ods = new OracleDataSource(); ods.setURL(url); ods.setConnectionProperties(prop);
Since JDBC passes down the three properties to JNDI, the authentication mechanism chosen by client is consistent with how these properties are interpreted by JNDI. For example, if the client specifies authentication information without explicitly specifying the java.naming.security.authentication
property, then the default authentication mechanism is "simple". Please refer to relevant JDNI documentation for details.