Oracle® Fusion Middleware Administering JDBC Data Sources for Oracle WebLogic Server 12c (12.2.1.4.0) E90814-06 October 2020 Oracle Fusion Middleware Administering JDBC Data Sources for Oracle WebLogic Server, 12c (12.2.1.4.0) E90814-06 Copyright © 2007, 2020, Oracle and/or its affiliates. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle. Contents Preface Documentation Accessibility xvi Conventions xvi 1 Introduction and Roadmap Document Scope and Audience 1-1 Guide to this Document 1-1 Related Documentation 1-2 JDBC Samples and Tutorials 1-3 Avitek Medical Records Application (MedRec) and Tutorials 1-3 JDBC Examples in the WebLogic Server Distribution 1-3 New and Changed JDBC Data Source Features in This Release 1-3 2 Configuring WebLogic JDBC Resources Understanding JDBC Resources in WebLogic Server 2-1 Ownership of Configured JDBC Resources 2-2 Data Source Configuration Files 2-2 JDBC System Modules 2-3 Generic Data Source Modules 2-3 Active GridLink Data Source System Modules 2-4 Multi Data Source System Modules 2-4 JDBC Application Modules 2-5 Standard Java EE Application Modules 2-5 Proprietary JDBC Application Modules 2-5 JDBC Module File Naming Requirements 2-7 JDBC Modules in Versioned Applications 2-7 JDBC Schema 2-8 JDBC Data Source Type 2-9 JMX and WLST Access for JDBC Resources 2-9 JDBC MBeans for System Resources 2-10 iii JDBC Management Objects in the Java EE Management Model (JSR-77 Support) 2-10 Using WLST to Create JDBC System Resources 2-11 How to Modify and Monitor JDBC Resources 2-13 Best Practices when Using WLST to Configure JDBC Resources 2-13 Creating High-Availability JDBC Resources 2-13 3 Configuring JDBC Data Sources Understanding JDBC Data Sources 3-1 Types of WebLogic Server JDBC Data Sources 3-1 Creating a JDBC Data Source 3-2 JDBC Data Source Properties 3-2 Data Source Names 3-3 Data Source Scope 3-3 JNDI Names 3-3 Selecting a Database Type 3-3 Selecting a JDBC Driver 3-3 Configure Transaction Options 3-6 Configure Connection Properties 3-7 Configuring Connection Properties for Oracle BI Server 3-7 Test Connections 3-7 Target the Data Source 3-7 Configuring Generic Connection Pool Features 3-7 Enabling JDBC Driver-Level Features 3-8 Enabling Connection-based System Properties 3-9 Enabling Connection-based Encrypted Properties 3-10 Initializing Database Connections with SQL Code 3-10 Advanced Connection Properties 3-11 Define Fatal Error Codes 3-11 Using Edition-Based Redefinition 3-12 Configuring Oracle Parameters 3-14 Configuring an ONS Client 3-14 Tuning Generic Data Source Connection Pools 3-15 Generic Data Source Handling for Oracle RAC Outages 3-15 Generic Data Source Handling of Driver-Level Failover 3-15 4 Using the Default Data Source What is the Default Data Source 4-1 Defining a Custom Default Data Source 4-2 iv Compatibility Limitations When Using a Default Data Source 4-3 5 Configuring JDBC Multi Data Sources Multi Data Source Features 5-1 Removing a Database Node 5-2 Adding a Database Node 5-2 Creating and Configuring Multi Data Sources 5-3 Choosing the Multi Data Source Algorithm 5-3 Failover 5-3 Load Balancing 5-4 Multi Data Source Fail-Over Limitations and Requirements 5-4 Test Connections on Reserve to Enable Fail-Over 5-4 No Fail-Over for In-Use Connections 5-4 Multi Data Source Failover Enhancements 5-5 Connection Request Routing Enhancements When a Generic Data Source Fails 5-5 Automatic Re-enablement on Recovery of a Failed Generic Data Source within a Multi Data Source 5-5 Enabling Failover for Busy Generic Data Sources in a Multi Data Source 5-6 Controlling Multi Data Source Failover with a Callback 5-6 Callback Handler Requirements 5-6 Callback Handler Configuration 5-7 How It Works—Failover 5-7 Controlling Multi Data Source Failback with a Callback 5-8 How It Works—Failback 5-9 Deploying JDBC Multi Data Sources on Servers and Clusters 5-10 Planned Database Maintenance with a Multi Data Source 5-10 Shutting Down the Data Source 5-11 6 Using Active GridLink Data Sources What is an Active GridLink Data Source 6-1 Fast Connection Failover 6-2 Runtime Connection Load Balancing 6-3 GridLink Affinity 6-4 Session Affinity Policy 6-5 XA Affinity Policy 6-6 SCAN Addresses 6-6 Secure Communication using Oracle Wallet with ONS Listener 6-7 Support for Active Data Guard 6-7 Creating an Active GridLink Data Source 6-7 JDBC Data Source Properties 6-8 v Data Source Names 6-8 Data Source Scope 6-8 JNDI Names 6-8 Select a Driver 6-8 Configure Transaction Options 6-9 Configure Connection Properties 6-9 Enter Connection Properties 6-10 Enter a Complete URL 6-10 Supported AGL Data Source URL Formats 6-11 Test Connections 6-12 ONS Client Configuration 6-12 Enabling FAN Events 6-12 Configure ONS Host and Port 6-12 Secure ONS Client Communication 6-13 Test ONS Client Configuration 6-14 Target the Data Source 6-14 Using Socket Direct Protocol 6-14 Configuring Runtime Load Balancing using SDP 6-14 Configuring Active GridLink Connection Pool Features 6-15 Enabling JDBC Driver-Level Features 6-15 Enabling Connection-based System Properties 6-16 Initializing Database Connections with SQL Code 6-16 Configuring Oracle Parameters 6-16 Configuring an ONS Client Using WLST 6-17 Tuning Active GridLink Data Source Connection Pools 6-17 Monitoring Active GridLink JDBC Resources 6-17 Viewing Run-Time Statistics 6-17 JDBCOracleDataSourceRuntimeMBean 6-17 JDBCOracleDataSourceInstanceRuntimeMBean 6-18 ONSDaemonRuntimeMBean 6-18 Debug Active GridLink Data Sources 6-18 JDBC Debugging Scopes 6-18 UCP JDK Logging 6-19 Enable Debugging Using the Command Line 6-19 Using Active GridLink Data Sources without FAN Notification 6-19 Understanding the ActiveGridlink Attribute 6-20 Best Practices for Active GridLink Data Sources 6-20 Catch and Handle Exceptions 6-20 Connection Creation with Active Gridlink Data Sources 6-21 Comparing Active GridLink