Developing Enterprise JavaBeans for Oracle WebLogic Server c (12.1.3)

Transcription

1 [1]Oracle Fusion Middleware Developing Enterprise JavaBeans for Oracle WebLogic Server c (12.1.3) E August 2015 This document is a resource for software developers who develop applications that include WebLogic Server Enterprise JavaBeans (EJBs) using the Java Platform, Enterprise Edition 6.

2 Oracle Fusion Middleware Developing Enterprise JavaBeans for Oracle WebLogic Server , 12c (12.1.3) E Copyright 2007, 2015, Oracle and/or its affiliates. All rights reserved. Primary Author: Jeff Schieli 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 installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. 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 Xeon 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, Opteron, the AMD logo, and the AMD Opteron 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.

3 Contents Preface... xxxi Documentation Accessibility... Conventions... xxxi xxxi 1 Introduction and Roadmap 1.1 Document Scope and Audience Guide to this Document Related Documentation EJB Documentation in WebLogic Server Additional EJB Information Comprehensive Examples for the EJB Developer New EJB 3.1 Examples EJB 3.0 Example New and Changed Features in this Release Understanding Enterprise JavaBeans 2.1 New Features and Changes in EJB What Is New and Changed in EJB What Was New and Changed in EJB Understanding EJB Components Session EJBs Implement Business Logic Stateful Session Beans Stateless Session Beans Singleton Session Beans Message-Driven Beans Implement Loosely Coupled Business Logic EJB Anatomy and Environment EJB Components The EJB Container EJB Metadata Annotations Optional EJB Deployment Descriptors EJB Clients and Communications Accessing EJBs EJB Communications Securing EJBs iii

4 3 Simple Enterprise JavaBeans Examples 3.1 Simple Java Examples of 3.x EJBs Example of a Simple No-interface Stateless EJB Example of a Simple Business Interface Stateless EJB Example of a Simple Stateful EJB Example of an Interceptor Class Packaged EJB 3.1 Examples in WebLogic Server EJB 3.1: Example of a Singleton Session Bean EJB 3.1: Example of an Asynchronous Method EJB EJB 3.1: Example of a Calendar-based Timer EJB EJB 3.1: Example of Simplified No-interface Programming and Packaging in a WAR File EJB 3.1: Example of Using a Portable Global JNDI Name in an EJB EJB 3.1: Example of Using the Embeddable EJB Container in Java SE EJB 3.0: Example of Invoking an Entity From A Session Bean Iterative Development of Enterprise JavaBeans 4.1 Overview of the EJB Development Process Create a Source Directory Directory Structure for Packaging a JAR Directory Structure for Packaging a WAR Program the Annotated EJB Class Program the EJB Interface Accessing EJBs Using the No-Interface Client View Accessing EJBs Using the Business Interface Business Interface Application Exceptions Using Generics in EJBs Serializing and Deserializing Business Objects Optionally Program Interceptors Optionally Program the EJB Timer Service Overview of the Timer Service Calendar-based EJB Timers Automatically-created EJB Timers Non-persistent Timers Clustered Versus Local EJB Timer Services Clustered EJB Timer Services Local EJB Timer Services Configuring Clustered EJB Timers Using Java Programming Interfaces to Program Timer Objects EJB 3.1 Timer-related Programming Interfaces WebLogic Server-specific Timer-related Programming Interfaces Programming Access to EJB Clients Remote Clients Local Clients Looking Up EJBs From Clients Using Dependency Injection Using the JNDI Portable Syntax iv

5 Customizing JNDI Names Configuring EJBs to Send Requests to a URL Specifying an HTTP Resource by URL Specifying an HTTP Resource by Its JNDI Name Accessing HTTP Resources from Bean Code Configuring Network Communications for an EJB Programming and Configuring Transactions Programming Container-Managed Transactions Configuring Automatic Retry of Container-Managed Transactions Programming Bean-Managed Transactions Programming Transactions That Are Distributed Across EJBs Calling multiple EJBs from a client's transaction context Using an EJB "Wrapper" to Encapsulate a Cross-EJB Transaction Compile Java Source Optionally Create and Edit Deployment Descriptors Packaging EJBs Packaging EJBs in a JAR Packaging an EJB In a WAR Deploying EJBs Programming the Annotated EJB Class 5.1 Overview of Metadata Annotations and EJB Bean Files Programming the Bean File: Requirements and Changes From 2.x Bean Class Requirements and Changes From 2.x Bean Class Method Requirements Programming the Bean File Typical Steps When Programming the Bean File Specifying the Business and Other Interfaces Specifying the Business Interface Specifying the No-interface View Specifying the Bean Type (Stateless, Singleton, Stateful, or Message-Driven) Injecting Resource Dependency into a Variable or Setter Method Invoking a 3.0 Entity Injecting Persistence Context Using Metadata Annotations Finding an Entity Using the EntityManager API Creating and Updating an Entity Using EntityManager Specifying Interceptors for Business Methods or Life Cycle Callback Events Specifying Business or Life Cycle Interceptors: Typical Steps Programming the Interceptor Class Programming Business Method Interceptor Methods Programming Asynchronous Business Methods Programming Life Cycle Callback Interceptor Methods Specifying Default Interceptor Methods Saving State Across Interceptors With the InvocationContext API Programming Application Exceptions Securing Access to the EJB Specifying Transaction Management and Attributes v

6 5.4 Complete List of Metadata Annotations By Function Annotations to Specify the Bean Type Annotations to Specify the Local or Remote Interfaces Annotations to Support EJB 2.x Client View Annotations to Invoke a 3.0 Entity Bean Transaction-Related Annotations Annotations to Specify Interceptors Annotations to Specify Life Cycle Callbacks Security-Related Annotations Context Dependency Annotations Timeout and Exceptions Annotations Timer and Scheduling Annotations Deployment Guidelines for Enterprise JavaBeans 6.1 Before You Deploy an EJB Understanding and Performing Deployment Tasks Deployment Guidelines for EJBs Deploying Standalone EJBs as Part of an Enterprise Application Deploying EJBs as Part of an Web Application Deploying EJBs That Call Each Other in the Same Application Deploying EJBs That Use Dependency Injection Deploying Homogeneously to a Cluster Deploying Pinned EJBs to a Cluster Redeploying an EJB Using FastSwap Deployment to Minimize Deployment Understanding Warning Messages Disabling EJB Deployment Warning Messages Using an Embedded EJB Container in Oracle WebLogic Server 7.1 Overview of the Embeddable EJB Container Requirements for Using the Embedded EJB Container with WebLogic Server EJB 3.1 Lite Functionality Supported in the Embedded EJB Container Configuring the Persistence Provider in Oracle WebLogic Server 8.1 Overview of Oracle TopLink Specifying a Persistence Provider Setting the Default Provider for the Domain Specifying the Persistence Provider in an Application Using Oracle TopLink in Oracle WebLogic Server Using JPA 2.1 with Oracle TopLink in WebLogic Server Applying the Patch Using OPatch Applying the Patch Manually Using Oracle Kodo in Oracle WebLogic Server Using JPA 1.0 APIs Using.xml Updating Applications to Overcome Conflicts with JPA vi

7 8.6 Using a Newer Version of OpenJPA in Oracle WebLogic Server A EJB Metadata Annotations Reference A.1 Overview of EJB 3.x Annotations... A-1 A.2 Annotations for Stateless, Stateful, and Message-Driven Beans... A-1 A.2.1 javax.ejb.accesstimeout... A-2 A Description... A-2 A Attributes... A-3 A.2.2 javax.ejb.activationconfigproperty... A-3 A Description... A-3 A Attributes... A-4 A.2.3 javax.ejb.afterbegin... A-4 A Description... A-4 A.2.4 javax.ejb.aftercompletion... A-4 A Description... A-4 A.2.5 javax.ejb.applicationexception... A-5 A Description... A-5 A Attributes... A-5 A.2.6 javax.ejb.asynchronous... A-5 A Description... A-5 A.2.7 javax.ejb.beforecompletion... A-6 A Description... A-6 A.2.8 javax.ejb.concurrencymanagement... A-6 A Description... A-6 A Attributes... A-7 A.2.9 javax.ejb.dependson... A-7 A Description... A-7 A Attributes... A-7 A.2.10 javax.ejb.ejb... A-7 A Description... A-8 A Attributes... A-8 A.2.11 javax.ejb.ejbs... A-9 A Description... A-9 A Attribute... A-9 A.2.12 javax.ejb.init... A-9 A Description... A-9 A Attributes... A-10 A.2.13 javax.ejb.local... A-10 A Description... A-10 A Attributes... A-10 A.2.14 javax.ejb.localbean... A-10 A Description... A-11 A.2.15 javax.ejb.localhome... A-11 A Description... A-11 A Attributes... A-11 A.2.16 javax.ejb.lock... A-11 A Description... A-11 vii

8 viii A Attributes... A-11 A.2.17 javax.ejb.messagedriven... A-12 A Description... A-12 A Attributes... A-12 A.2.18 javax.ejb.postactivate... A-13 A Description... A-13 A.2.19 javax.ejb.prepassivate... A-13 A Description... A-14 A.2.20 javax.ejb.remote... A-14 A Description... A-14 A Attributes... A-14 A.2.21 javax.ejb.remotehome... A-15 A Description... A-15 A Attributes... A-15 A.2.22 javax.ejb.remove... A-15 A Description... A-15 A Attributes... A-15 A.2.23 javax.ejb.schedule... A-15 A Description... A-16 A Calendar-based Schedule Elements... A-16 A Forms of Supported Element Values... A-17 A Additional Rules for Schedule Specification Elements... A-18 A Attributes... A-18 A.2.24 javax.ejb.schedules... A-19 A Description... A-19 A Attributes... A-19 A.2.25 javax.ejb.singleton... A-19 A Description... A-19 A Attributes... A-20 A.2.26 javax.ejb.startup... A-20 A Description... A-20 A.2.27 javax.ejb.statefultimeout... A-20 A Description... A-20 A Attributes... A-20 A.2.28 javax.ejb.stateless... A-21 A Description... A-21 A Attributes... A-21 A.2.29 javax.ejb.timeout... A-22 A Description... A-22 A.2.30 javax.ejb.transactionattribute... A-22 A Description... A-22 A Attributes... A-23 A.2.31 javax.ejb.transactionmanagement... A-23 A Description... A-23 A Attributes... A-24 A.3 Annotations Used to Configure Interceptors... A-24 A.3.1 javax.interceptor.aroundinvoke... A-24

9 A Description... A-24 A.3.2 javax.interceptor.excludeclassinterceptors... A-24 A Description... A-25 A.3.3 javax.interceptor.excludedefaultinterceptors... A-25 A Description... A-25 A.3.4 javax.interceptor.interceptors... A-25 A Description... A-25 A Attributes... A-25 A.4 Annotations Used to Interact With Entity Beans... A-26 A.4.1 javax.persistence.persistencecontext... A-26 A Description... A-26 A Attributes... A-26 A.4.2 javax.persistence.persistencecontexts... A-27 A Description... A-27 A Attributes... A-27 A.4.3 javax.persistence.persistenceunit... A-27 A Description... A-28 A Attributes... A-28 A.4.4 javax.persistence.persistenceunits... A-28 A Description... A-29 A Attributes... A-29 A.5 Standard JDK Annotations Used By EJB 3.x... A-29 A.5.1 javax.annotation.postconstruct... A-29 A Description... A-29 A.5.2 javax.annotation.predestroy... A-29 A Description... A-30 A.5.3 javax.annotation.resource... A-30 A Description... A-30 A Attributes... A-30 A.5.4 javax.annotation.resources... A-31 A Description... A-31 A Attributes... A-31 A.6 Standard Security-Related JDK Annotations Used by EJB 3.x... A-32 A.6.1 javax.annotation.security.declareroles... A-32 A Description... A-32 A Attributes... A-32 A.6.2 javax.annotation.security.denyall... A-32 A Description... A-32 A.6.3 javax.annotation.security.permitall... A-33 A Description... A-33 A.6.4 javax.annotation.security.rolesallowed... A-33 A Description... A-33 A Attributes... A-33 A.6.5 javax.annotation.security.runas... A-33 A Description... A-33 A Attributes... A-33 A.7 WebLogic Annotations... A-34 ix

10 A.7.1 weblogic.javaee.allowremoveduringtransaction... A-34 A Description... A-34 A.7.2 weblogic.javaee.callbyreference... A-34 A Description... A-35 A.7.3 weblogic.javaee.disablewarnings... A-35 A Description... A-35 A Attributes... A-35 A.7.4 weblogic.javaee.ejbreference... A-36 A Description... A-36 A Attribute... A-36 A.7.5 weblogic.javaee.idempotent... A-36 A Description... A-36 A Attributes... A-36 A.7.6 weblogic.javaee.jmsclientid... A-37 A Description... A-37 A Attributes... A-37 A.7.7 weblogic.javaee.jndiname... A-37 A Description... A-37 A Attributes... A-38 A.7.8 weblogic.javaee.jndinames... A-38 A Description... A-38 A Attributes... A-38 A.7.9 weblogic.javaee.messagedestinationconfiguration... A-38 A Description... A-38 A Attributes... A-38 A.7.10 weblogic.javaee.transactionisolation... A-39 A Description... A-39 A Attributes... A-39 A.7.11 weblogic.javaee.transactiontimeoutseconds... A-39 A Description... A-40 A Attributes... A-40 B C Using Oracle Kodo with Oracle WebLogic Server B.1 Overview of Oracle Kodo... B-2 B.2 Creating an Oracle Kodo Application... B-2 B.3 Using Different Oracle Kodo Versions... B-2 B.4 Configuring Persistence... B-2 B.4.1 Editing the Configuration Property Files... B-2 B.4.2 Using the Configuration Files Together... B-3 B.4.3 Configuring Plug-ins... B-4 B.5 Deploying an Oracle Kodo Application... B-4 B.6 Configuring an Oracle Kodo Application... B-4 B.6.1 Using the Administration Console... B-4 B.6.2 Configuring Oracle Kodo Without Using the Administration Console... B-5 Oracle Kodo Persistence Configuration Schema Reference C.1.xml Namespace Declaration and Schema Location... C-1 x

11 C.2.xml Deployment Descriptor File Structure... C-2 C.3.xml Deployment Descriptor Elements... C-5 C.3.1 abstract-store-broker-factory... C-5 C Function... C-5 C Example... C-5 C.3.2 access-dictionary... C-5 C Function... C-6 C Example... C-6 C.3.3 access-unloaded... C-8 C Function... C-9 C Example... C-9 C.3.4 action... C-9 C Function... C-9 C Example... C-9 C.3.5 addresses... C-9 C Function... C-9 C Example... C-9 C.3.6 advanced-sql... C-10 C Function... C-10 C.3.7 aggregate-listeners... C-10 C Function... C-10 C Example... C-10 C.3.8 allocate... C-10 C Function... C-11 C Example... C-11 C.3.9 assert-allowed-type... C-11 C Function... C-11 C Example... C-11 C.3.10 auto-clear... C-11 C Function... C-11 C Example... C-12 C.3.11 auto-detach... C-12 C Function... C-12 C Example... C-12 C.3.12 auto-detaches... C-12 C Function... C-12 C Example... C-13 C.3.13 base-name... C-13 C Function... C-13 C Example... C-13 C.3.14 batching-operation-order-update-manager... C-13 C Function... C-13 C Example... C-13 C.3.15 buffer-size... C-13 C Function... C-14 C Example... C-14 C.3.16 cache-map... C-14 xi

12 xii C Function... C-14 C Example... C-14 C.3.17 cache-size... C-14 C Function... C-14 C Example... C-14 C.3.18 channel... C-15 C Function... C-15 C Example... C-15 C.3.19 class-table-jdbc-seq... C-15 C Function... C-15 C Example... C-15 C.3.20 classname... C-15 C Function... C-16 C.3.21 classpath-scan... C-16 C Function... C-17 C Example... C-17 C.3.22 clear-on-close... C-17 C Function... C-17 C Example... C-17 C.3.23 client-broker-factory... C-17 C Function... C-18 C Example... C-18 C.3.24 close-on-managed-commit... C-18 C Function... C-18 C Example... C-18 C.3.25 cluster-remote-commit-provider... C-18 C Function... C-18 C Example... C-18 C.3.26 commons-log-factory... C-19 C Function... C-19 C Example... C-19 C.3.27 compatibility... C-19 C Function... C-19 C Example... C-19 C.3.28 concurrent-hash-map... C-19 C Function... C-20 C Example... C-20 C.3.29 connection-decorators... C-20 C Function... C-20 C Example... C-20 C.3.30 connection-driver-name... C-20 C Function... C-21 C Example... C-21 C.3.31 connection-factory-mode... C-22 C Function... C-22 C Example... C-22 C.3.32 connection-factory-name... C-22

13 C Function... C-22 C Example... C-22 C.3.33 connection-factory-properties... C-22 C Function... C-22 C Example... C-23 C.3.34 connection-factory2-name... C-23 C Function... C-23 C Example... C-23 C.3.35 connection-factory2-properties... C-23 C Function... C-23 C Example... C-23 C.3.36 connection-password... C-24 C Function... C-24 C Example... C-24 C.3.37 connection-properties... C-24 C Function... C-24 C Example... C-24 C.3.38 connection-retain-mode... C-24 C Function... C-25 C Example... C-25 C.3.39 connection-url... C-25 C Function... C-25 C Example... C-26 C.3.40 connection-user-name... C-26 C Function... C-26 C Example... C-26 C.3.41 connection2-driver-name... C-27 C Function... C-27 C Example... C-27 C.3.42 connection2-password... C-27 C Function... C-27 C Example... C-27 C.3.43 connection2-properties... C-27 C Function... C-27 C Example... C-27 C.3.44 connection2-url... C-28 C Function... C-28 C Example... C-28 C.3.45 connection2-user-name... C-28 C Function... C-28 C Example... C-28 C.3.46 constraint-names... C-28 C Function... C-29 C Example... C-29 C.3.47 constraint-update-manager... C-29 C Function... C-29 C Example... C-29 xiii

14 xiv C.3.48 copy-object-ids... C-29 C Function... C-29 C Example... C-29 C.3.49 custom-aggregate-listener... C-30 C Function... C-30 C Example... C-30 C.3.50 custom-broker-factory... C-30 C Function... C-30 C Example... C-30 C.3.51 custom-broker-impl... C-30 C Function... C-30 C Example... C-31 C.3.52 custom-class-resolver... C-31 C Function... C-31 C Example... C-31 C.3.53 custom-compatibility... C-31 C Function... C-31 C Example... C-31 C.3.54 custom-connection-decorator... C-31 C Function... C-32 C Example... C-32 C.3.55 custom-data-cache... C-32 C Function... C-32 C Example... C-32 C.3.56 custom-data-cache-manager... C-32 C Function... C-32 C Example... C-32 C.3.57 custom-detach-state... C-33 C Function... C-33 C Example... C-33 C.3.58 custom-dictionary... C-33 C Function... C-33 C Example... C-33 C.3.59 custom-driver-data-source... C-33 C Function... C-34 C Example... C-34 C.3.60 custom-filter-listener... C-34 C Function... C-34 C Example... C-34 C.3.61 custom-jdbc-listener... C-34 C Function... C-34 C Example... C-34 C.3.62 custom-lock-manager... C-35 C Function... C-35 C Example... C-35 C.3.63 custom-log... C-35 C Function... C-35

15 C Example... C-35 C.3.64 custom-mapping-defaults... C-35 C Function... C-35 C Example... C-35 C.3.65 custom-mapping-factory... C-36 C Function... C-36 C Example... C-36 C.3.66 custom-meta-data-factory... C-36 C Function... C-36 C Example... C-36 C.3.67 custom-meta-data-repository... C-36 C Function... C-36 C Example... C-37 C.3.68 custom-orphaned-key-action... C-37 C Function... C-37 C Example... C-37 C.3.69 custom-persistence-server... C-37 C Function... C-37 C Example... C-37 C.3.70 custom-proxy-manager... C-37 C Function... C-38 C Example... C-38 C.3.71 custom-query-compilation-cache... C-38 C Function... C-38 C Example... C-38 C.3.72 custom-remote-commit-provider... C-38 C Function... C-38 C Example... C-38 C.3.73 custom-savepoint-manager... C-39 C Function... C-39 C Example... C-39 C.3.74 custom-schema-factory... C-39 C Function... C-39 C Example... C-39 C.3.75 custom-seq... C-39 C Function... C-39 C Example... C-39 C.3.76 custom-sql-factory... C-40 C Function... C-40 C Example... C-40 C.3.77 custom-update-manager... C-40 C Function... C-40 C Example... C-40 C.3.78 data-caches... C-40 C Function... C-41 C Example... C-41 C.3.79 data-cache-manager-impl... C-41 xv

16 xvi C Function... C-41 C Example... C-41 C.3.80 data-cache-timeout... C-41 C Function... C-41 C Example... C-41 C.3.81 db2-dictionary... C-41 C Function... C-42 C Example... C-42 C.3.82 default-access-type... C-42 C Function... C-42 C Example... C-42 C.3.83 default-broker-factory... C-42 C Function... C-42 C Example... C-43 C.3.84 default-broker-impl... C-43 C Function... C-43 C Example... C-43 C.3.85 default-class-resolver... C-43 C Function... C-43 C Example... C-43 C.3.86 default-compatibility... C-43 C Function... C-43 C Example... C-44 C.3.87 default-data-cache... C-44 C Function... C-44 C Example... C-44 C.3.88 default-detach-state... C-44 C Function... C-44 C Example... C-44 C.3.89 default-data-cache-manager... C-44 C Function... C-45 C Example... C-45 C.3.90 default-driver-data-source... C-45 C Function... C-45 C Example... C-45 C.3.91 default-level... C-45 C Function... C-45 C Example... C-45 C.3.92 default-lock-manager... C-45 C Function... C-46 C Example... C-46 C.3.93 default-mapping-defaults... C-46 C Function... C-46 C Example... C-46 C.3.94 default-meta-data-factory... C-46 C Function... C-46 C Example... C-46

17 C.3.95 default-meta-data-repository... C-46 C Function... C-47 C Example... C-47 C.3.96 default-orphaned-key-action... C-47 C Function... C-47 C Example... C-47 C.3.97 default-proxy-manager... C-47 C Function... C-47 C Example... C-47 C.3.98 default-query-compilation-cache... C-47 C Function... C-48 C Example... C-48 C.3.99 default-savepoint-manager... C-48 C Function... C-48 C Example... C-48 C default-schema-factory... C-48 C Function... C-48 C Example... C-49 C default-sql-factory... C-49 C Function... C-49 C Example... C-49 C default-update-manager... C-49 C Function... C-49 C Example... C-49 C deprecated-jdo-mapping-defaults... C-49 C Function... C-49 C Example... C-50 C deprecated-jdo-meta-data-factory... C-50 C Function... C-50 C Example... C-50 C derby-dictionary... C-50 C Function... C-50 C Example... C-50 C detach-options-all... C-51 C Function... C-51 C Example... C-51 C detach-options-fetch-groups... C-51 C Function... C-51 C Example... C-51 C detach-options-loaded... C-51 C Function... C-52 C Example... C-52 C detach-state... C-52 C Function... C-52 C Example... C-52 C detached-state-field... C-52 C Function... C-53 xvii

18 xviii C Example... C-53 C detached-state-manager... C-53 C Function... C-53 C Example... C-53 C detached-state-transient... C-53 C Function... C-54 C Example... C-54 C detached-new... C-54 C Function... C-54 C Example... C-54 C diagnostic-context... C-54 C Function... C-55 C Example... C-55 C dynamic-data-structs... C-55 C Function... C-55 C Example... C-55 C dynamic-schema-factory... C-55 C Function... C-55 C Example... C-56 C eager-fetch-mode... C-56 C Function... C-56 C Example... C-57 C empress-dictionary... C-57 C Function... C-57 C Example... C-57 C EnableLogMBean... C-58 C Function... C-58 C Example... C-58 C EnableRuntimeMBean... C-58 C Function... C-58 C Example... C-58 C evict-from-data-cache... C-58 C Function... C-58 C Example... C-59 C eviction-schedule... C-59 C Function... C-59 C Example... C-59 C exception-orphaned-key-action... C-59 C Function... C-60 C Example... C-60 C exception-reconnect-attempts... C-60 C Function... C-60 C Example... C-60 C execution-context-name-provider... C-60 C Function... C-60 C Example... C-60 C export-profiling... C-61

19 C Function... C-61 C Example... C-61 C extension-deprecated-jdo-mapping-factory... C-61 C Function... C-61 C Example... C-61 C fetch-batch-size... C-62 C Function... C-62 C Example... C-62 C fetch-direction... C-62 C Function... C-62 C Example... C-62 C fetch-group... C-62 C Function... C-63 C Example... C-63 C fetch-groups... C-63 C Function... C-63 C Example... C-63 C field-override... C-63 C Function... C-64 C Example... C-64 C file... C-64 C Function... C-64 C Example... C-64 C file-name... C-64 C Function... C-64 C Example... C-64 C file-schema-factory... C-65 C Function... C-65 C Example... C-65 C files... C-65 C Function... C-66 C Example... C-66 C filter-listeners... C-66 C Function... C-66 C Example... C-66 C foreign-keys... C-66 C Function... C-66 C Example... C-67 C format... C-67 C Function... C-67 C foxpro-dictionary... C-67 C Function... C-67 C Example... C-67 C flush-before-queries... C-67 C Function... C-67 C Example... C-68 C gem-fire-data-cache... C-68 xix

20 xx C Function... C-68 C Example... C-68 C gem-fire-data-cache-name... C-68 C Function... C-68 C Example... C-68 C gui-jmx... C-69 C Function... C-69 C Example... C-69 C gui-profiling... C-69 C Function... C-69 C Example... C-69 C Host... C-69 C Function... C-69 C Example... C-70 C host... C-70 C Function... C-70 C Example... C-70 C hsql-dictionary... C-70 C Function... C-70 C Example... C-70 C http-transport... C-70 C Function... C-70 C Example... C-71 C ignore-changes... C-71 C Function... C-71 C Example... C-71 C ignore-unmapped... C-71 C Function... C-71 C Example... C-71 C ignore-virtual... C-71 C Function... C-72 C Example... C-72 C in-memory-savepoint-manager... C-72 C Function... C-72 C Example... C-72 C increment... C-72 C Function... C-73 C Example... C-73 C indexes... C-73 C Function... C-73 C Example... C-73 C informix-dictionary... C-73 C Function... C-73 C Example... C-73 C initial-value... C-74 C Function... C-74 C Example... C-74

21 C interval-millis... C-74 C Function... C-74 C Example... C-74 C inverse-manager... C-74 C Function... C-74 C Example... C-75 C jdatastore-dictionary... C-75 C Function... C-75 C Example... C-75 C jdbc-broker-factory... C-75 C Function... C-75 C Example... C-75 C jdbc-listeners... C-75 C Function... C-76 C Example... C-76 C jdbc3-savepoint-manager... C-76 C Function... C-76 C Example... C-76 C jdo-meta-data-factory... C-76 C Function... C-76 C Example... C-76 C jms-remote-commit-provider... C-77 C Function... C-77 C Example... C-77 C jmx... C-77 C Function... C-77 C Example... C-77 C jmx2-jmx... C-77 C Function... C-78 C Example... C-78 C JNDIName... C-78 C Function... C-78 C Example... C-78 C kodo-broker... C-78 C Function... C-78 C Example... C-78 C kodo-concurrent-data-cache... C-79 C Function... C-79 C Example... C-79 C kodo-data-cache-manager... C-79 C Function... C-79 C Example... C-79 C kodo-mapping-repository... C-80 C Function... C-80 C Example... C-80 C kodo-persistence-mapping-factory... C-80 C Function... C-80 xxi

22 xxii C Example... C-80 C kodo-persistence-meta-data-factory... C-80 C Function... C-81 C Example... C-81 C kodo-pooling-data-source... C-81 C Function... C-81 C Example... C-81 C kodo-sql-factory... C-81 C Function... C-82 C Example... C-82 C large-transaction... C-82 C Function... C-82 C Example... C-82 C lazy-schema-factory... C-82 C Function... C-82 C Example... C-82 C level... C-83 C Function... C-83 C Example... C-83 C local-jmx... C-83 C Function... C-83 C Example... C-83 C local-profiling... C-83 C Function... C-84 C Example... C-84 C lock-timeout... C-84 C Function... C-84 C Example... C-84 C log-factory-impl... C-84 C Function... C-84 C Example... C-84 C log-orphaned-key-action... C-84 C Function... C-85 C Example... C-85 C log4j-log-factory... C-85 C Function... C-85 C Example... C-85 C login-timeout... C-85 C Function... C-86 C Example... C-86 C lrs-size... C-86 C Function... C-86 C Example... C-86 C lru-data-cache... C-86 C Function... C-86 C Example... C-87 C manage-lru... C-87

23 C Function... C-87 C Example... C-87 C mapping... C-87 C Function... C-87 C Example... C-87 C mapping-column... C-88 C Function... C-88 C Example... C-88 C mapping-defaults-impl... C-88 C Function... C-88 C Example... C-88 C mapping-file-deprecated-jdo-mapping-factory... C-89 C Function... C-89 C Example... C-89 C max-active... C-89 C Function... C-89 C Example... C-89 C max-idle... C-90 C Function... C-90 C Example... C-90 C max-size... C-90 C Function... C-90 C Example... C-90 C maximize-batch-size... C-90 C Function... C-91 C Example... C-91 C MBeanServerStrategy... C-91 C Function... C-91 C Example... C-91 C multithreaded... C-91 C Function... C-91 C Example... C-91 C mx4j1-jmx... C-92 C Function... C-92 C Example... C-92 C mysql-dictionary... C-92 C Function... C-92 C Example... C-92 C name... C-92 C Function... C-93 C name-column... C-93 C Function... C-93 C Example... C-94 C NamingImpl... C-94 C Function... C-94 C Example... C-94 C native-jdbc-seq... C-94 xxiii

24 xxiv C Function... C-94 C Example... C-94 C none-jmx... C-95 C Function... C-95 C Example... C-95 C none-lock-manager... C-95 C Function... C-95 C Example... C-95 C none-log-factory... C-95 C Function... C-95 C Example... C-95 C none-orphaned-key-action... C-96 C Function... C-96 C Example... C-96 C none-profiling... C-96 C Function... C-96 C Example... C-96 C nontransactional-read... C-96 C Function... C-97 C Example... C-97 C nontransactional-write... C-97 C Function... C-97 C Example... C-97 C num-broadcast-threads... C-97 C Function... C-97 C Example... C-97 C operation-order-update-manager... C-98 C Function... C-98 C Example... C-98 C optimistic... C-98 C Function... C-98 C Example... C-98 C oracle-dictionary... C-98 C Function... C-98 C Example... C-99 C oracle-savepoint-manager... C-99 C Function... C-99 C Example... C-99 C orm-file-jdor-mapping-factory... C-99 C Function... C-99 C Example... C-99 C order-dirty-objects... C-100 C Function... C-100 C Example... C-100 C Password... C-100 C Function... C-100 C Example... C-100

25 C C-100 C Function... C-100 C unit... C-101 C Function... C-101 C pessimistic-lock-manager... C-101 C Function... C-101 C Example... C-101 C persistence-mapping-defaults... C-101 C Function... C-101 C Example... C-101 C populate-data-cache... C-102 C Function... C-102 C Example... C-102 C Port... C-102 C Function... C-102 C Example... C-102 C port... C-102 C Function... C-103 C Example... C-103 C postgres-dictionary... C-103 C Function... C-103 C Example... C-103 C primary-key-column... C-103 C Function... C-104 C Example... C-104 C primary-key-value... C-104 C Function... C-104 C Example... C-104 C primary-keys... C-104 C Function... C-104 C Example... C-105 C profiling... C-105 C Function... C-105 C Example... C-105 C profiling-proxy-manager... C-105 C Function... C-105 C Example... C-105 C properties... C-105 C Function... C-107 C property... C-107 C Function... C-108 C Example... C-108 C proxy-manger-impl... C-108 C Function... C-108 C Example... C-108 C query-caches... C-108 C Function... C-108 xxv

26 xxvi C Example... C-108 C quoted-numbers-in-queries... C-109 C Function... C-109 C Example... C-109 C read-lock-level... C-109 C Function... C-109 C Example... C-110 C recover-action... C-110 C Function... C-110 C Example... C-110 C recovery-time-millis... C-110 C Function... C-110 C Example... C-110 C resources... C-110 C Function... C-111 C Example... C-111 C restore-state... C-111 C Function... C-111 C Example... C-111 C result-set-type... C-111 C Function... C-112 C Example... C-112 C retain-state... C-112 C Function... C-112 C Example... C-112 C retry-class-registration... C-112 C Function... C-112 C Example... C-113 C scan-top-down... C-113 C Function... C-113 C Example... C-113 C schema... C-113 C Function... C-114 C Example... C-114 C schema-column... C-114 C Function... C-114 C Example... C-114 C schemas... C-114 C Function... C-114 C Example... C-114 C sequence... C-115 C Function... C-115 C Example... C-115 C sequence-column... C-115 C Function... C-115 C Example... C-115 C sequence-name... C-115

27 C Function... C-116 C Example... C-116 C ServiceURL... C-116 C Function... C-116 C Example... C-116 C simple-driver-data-source... C-116 C Function... C-116 C Example... C-116 C single-file... C-116 C Function... C-117 C Example... C-117 C single-jvm-exclusive-lock-manager... C-117 C Function... C-117 C Example... C-117 C single-jvm-remote-commit-provider... C-117 C Function... C-117 C Example... C-117 C soft-reference-size... C-118 C Function... C-118 C Example... C-118 C so-timeout... C-118 C Function... C-118 C Example... C-118 C sql-server-dictionary... C-119 C Function... C-119 C Example... C-119 C stack-execution-context-name-provider... C-119 C Function... C-119 C Example... C-119 C store-mode... C-119 C Function... C-120 C Example... C-120 C strict... C-120 C Function... C-121 C Example... C-121 C strict-identity-values... C-121 C Function... C-121 C Example... C-121 C style... C-122 C Function... C-122 C Example... C-122 C subclass-fetch-mode... C-122 C Function... C-122 C Example... C-122 C sybase-dictionary... C-122 C Function... C-122 C Example... C-123 xxvii

28 xxviii C sync-with-managed-transactions... C-123 C Function... C-123 C Example... C-123 C synchronize-mappings... C-123 C Function... C-123 C Example... C-123 C table... C-123 C Function... C-124 C Example... C-124 C table-deprecated-jdo-mapping-factory... C-124 C Function... C-124 C Example... C-124 C table-jdbc-seq... C-125 C Function... C-125 C Example... C-125 C table-jdor-mapping-factory... C-125 C Function... C-125 C Example... C-125 C table-lock-update-manager... C-126 C Function... C-126 C Example... C-126 C table-name... C-126 C Function... C-127 C Example... C-127 C table-schema-factory... C-127 C Function... C-127 C Example... C-127 C tangosol-cache-name... C-128 C Function... C-128 C Example... C-128 C tangosol-cache-type... C-128 C Function... C-128 C Example... C-128 C tangosol-data-cache... C-128 C Function... C-129 C Example... C-129 C tcp-remote-commit-provider... C-129 C Function... C-129 C Example... C-129 C tcp-transport... C-129 C Function... C-129 C Example... C-129 C time-seeded-seq... C-130 C Function... C-130 C Example... C-130 C topic... C-130 C Function... C-130

29 C Example... C-130 C topic-connection-factory... C-130 C Function... C-131 C Example... C-131 C track-changes... C-131 C Function... C-131 C Example... C-131 C transaction-isolation... C-131 C Function... C-131 C Example... C-132 C transaction-mode... C-132 C Function... C-132 C Example... C-132 C transaction-name-execution-context-name-provider... C-132 C Function... C-132 C Example... C-132 C type... C-132 C Function... C-133 C Example... C-133 C type-column... C-133 C Function... C-133 C Example... C-133 C types... C-133 C Function... C-134 C Example... C-134 C URL... C-134 C Function... C-134 C Example... C-134 C url... C-134 C Function... C-134 C Example... C-134 C urls... C-134 C Function... C-135 C Example... C-135 C use-aliases... C-135 C Function... C-135 C Example... C-136 C use-schema-validation... C-136 C Function... C-136 C Example... C-136 C user-object-execution-context-name-provider... C-136 C Function... C-137 C Example... C-137 C UserName... C-137 C Function... C-137 C Example... C-137 C validate-false-returns-hollow... C-137 xxix

30 xxx C Function... C-137 C Example... C-137 C validate-true-checks-store... C-138 C Function... C-138 C Example... C-138 C value-table-jdbc-seq... C-138 C Function... C-138 C Example... C-138 C version-check-on-read-lock... C-139 C Function... C-139 C Example... C-139 C version-check-on-write-lock... C-139 C Function... C-139 C Example... C-139 C version-lock-manager... C-139 C Function... C-139 C Example... C-140 C wls81-jmx... C-140 C Function... C-140 C Example... C-140 C write-lock-level... C-140 C Function... C-140 C Example... C-141

31 Preface This preface describes the document accessibility features and conventions used in this guide Developing Enterprise JavaBeans for Oracle WebLogic Server Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit or visit if you are hearing impaired. Conventions The following text conventions are used in this document: Convention boldface italic monospace Meaning Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary. Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values. Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter. xxxi

32 xxxii

33 1 1Introduction and Roadmap [2]This chapter describes the contents and organization of this guide Developing Enterprise JavaBeans for Oracle WebLogic Server This chapter includes the following sections: Document Scope and Audience Guide to this Document Related Documentation Comprehensive Examples for the EJB Developer New and Changed Features in this Release 1.1 Document Scope and Audience This document is a resource for software developers who develop applications that include WebLogic Server Enterprise JavaBeans (EJBs). The document mostly discusses the Java EE 6-based, EJB 3.1 programming model, in particular the use of metadata annotations to simplify development. This document does not address EJB topics that are different between versions 2.x and 3.x, such as design considerations, EJB container architecture, entity beans, deployment descriptor use, and so on. This document also does not address production phase administration, monitoring, or performance tuning. For links to WebLogic Server documentation and resources for these topics, see Section 1.3, "Related Documentation." It is assumed that the reader is familiar with Java Platform, Enterprise Edition (Java EE) Version 6 and basic EJB programming concepts. For information on programming and packaging 2.1 EJBs, see Developing Enterprise JavaBeans, Version 2.1, for Oracle WebLogic Server. 1.2 Guide to this Document This chapter, Chapter 1, "Introduction and Roadmap," introduces the organization of this guide. Chapter 2, "Understanding Enterprise JavaBeans," provides an overview of the new EJB 3.1 features, as well as a brief description of the differences between EJB 3.1 and 3.0. Chapter 3, "Simple Enterprise JavaBeans Examples," provides examples of programming EJBs using the metadata annotations specified by EJB 3.x. Introduction and Roadmap 1-1

34 Related Documentation Chapter 4, "Iterative Development of Enterprise JavaBeans," describes the EJB implementation process, and provides guidance for how to get an EJB up and running in WebLogic Server. Chapter 5, "Programming the Annotated EJB Class," describes the requirements and typical steps when programming the EJB bean class that contains the metadata annotations. Chapter 6, "Deployment Guidelines for Enterprise JavaBeans," discusses EJB-specific deployment issues and procedures. Chapter 7, "Using an Embedded EJB Container in Oracle WebLogic Server," discusses using an embeddable EJB container in Oracle WebLogic Server. Chapter 8, "Configuring the Persistence Provider in Oracle WebLogic Server," provides an overview of developing an Oracle TopLink application using Oracle WebLogic Server. Appendix A, "EJB Metadata Annotations Reference," provides reference information for the EJB 3.0 metadata annotations, as well as information about standard metadata annotations that are used by EJB. Appendix B, "Using Oracle Kodo with Oracle WebLogic Server," describes how to use Oracle Kodo to create entity beans. Oracle Kodo is a product that provides the implementation of the Java Persistence API section of the EJB 3.0 specification, as well as other persistence-related technologies such as Java Data Objects (JDO). Note: Oracle Kodo JPA/JDO is deprecated in this release. Customers are encouraged to use Oracle TopLink, which supports JPA 2.0. Kodo supports only JPA 1.0. Appendix C, "Oracle Kodo Persistence Configuration Schema Reference," provides reference information for the persistence configuration schema. 1.3 Related Documentation This document contains EJB 3.1-specific development information. Additionally, it provides information only for session and message-driven beans. For complete information on general EJB design and architecture, the EJB 2.x programming model (which is fully supported in EJB 3.1), see the following documents EJB Documentation in WebLogic Server For information about developing and deploying EJBs with WebLogic Server, see: "Enterprise Java Beans (EJBs)" in Understanding Oracle WebLogic Server. For instructions on how to organize and build WebLogic Server EJBs in a split directory environment, see Developing Applications for Oracle WebLogic Server. For information on programming and packaging 2.x EJBs, see Developing Enterprise JavaBeans, Version 2.1, for Oracle WebLogic Server. Deploying Applications to Oracle WebLogic Server is the primary source of information about deploying WebLogic Server applications in development and production environments. 1-2 Developing Enterprise JavaBeans for Oracle WebLogic Server