Oracle Fusion Middleware 11g: Build Web Services

Volume I • Student Guide

D59163GC10

Edition 1.0

April 2010

D66460

Copyright © 2010, Oracle and/or it affiliates. All rights reserved.

Disclaimer

This document contains proprietary information and is protected by copyright and other intellectual property laws. You may copy and print this document solely for your own use in an Oracle training course. The document may not be modified or altered in any way. Except where your use constitutes "fair use" under copyright law, you may not use, share, download, upload, copy, print, display, perform, reproduce, publish, license, post, transmit, or distribute this document in whole or in part without the express authorization of Oracle.

The information contained in this document is subject to change without notice. If you find any problems in the document, please report them in writing to: Oracle University, 500 Oracle Parkway, Redwood Shores, California 94065 USA. This document is not warranted to be error-free.

Restricted Rights Notice

If this documentation is delivered to the United States Government or anyone using the documentation on behalf of the United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTSThe U.S. Government’s rights to use, modify, reproduce, release, perform, display, or disclose these training materials are restricted by the terms of the applicable Oracle license agreement and/or the applicable U.S. Government contract.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Authors

Iris LiAl Saganich

Technical Contributors and Reviewers

Pyounguk ChoSteve FriedbergJoe GreenwaldVasiliy StrelnikovHolger Rasmussen

EditorNita Pavitran

Graphic DesignersRajiv ChandrabhanuPriya Saxena

PublishersPavithran AdkaGiri VenugopalVeena Narasimhan

iii

Contents

I Course Introduction Audience I-2 Class Introductions I-3 Goal I-4 Course Objectives I-5 Prerequisites I-7 Course Map I-8 Course Environment I-9 Course Schedule I-10 How Can I Learn More? I-12

1 Introducing Web Services Objectives 1-2 The Drive Towards Web Services 1-3 What Web Services Are 1-5 The Integration Problem 1-7 Web Services Versus Web Applications 1-8 The Building Blocks of Web Services 1-9 SOAP 1-10 WSDL 1-11 UDDI 1-12 Quiz 1-13 Web Services Interaction 1-14 Web Services Interoperability 1-15 WS-I Basic Profile 1-16 WS - * Specifications 1-17 Web Services Architectural Styles 1-19 RESTful Versus SOAP-Based Web Services 1-20 Quiz 1-21 Definition: Service-Oriented Architecture (SOA) 1-22 SOA Further Defined 1-23 Services Are SOA Building Blocks 1-24 Standards That Enable SOA 1-25 Web Services and SOA 1-26

iv

Sample SOA Application Composed of Web Services 1-28 Summary 1-30 Practice 1 Overview: Reviewing Terms and Concepts 1-31 Describing the Course Environment 1-32 Configuring a Grid VM Connection 1-33 Configuring a Grid VM Connection: Session 1-34 Configuring a Grid VM Connection: Desktop 1-35 Configuring a Grid VM Connection: Configuration Completed 1-36 Connecting to the Grid VM Instance 1-37

2 Java Web Services Technologies Overview Objectives 2-2 Java Technology for Web Services 2-3 Java Web Services 2-4 Java Web Services Standards 2-5 JAX-WS Programming Model 2-6 JAX-WS Benefits 2-7 WS-Metadata Benefits 2-8 A Simple Annotated Java Class 2-9 Java Web Service from POJO Rules 2-10 Quiz 2-11 JAXB 2-12 SOAP with Attachments API for Java (SAAJ) 2-13 WSEE 2-14 Roles of APIs in Web Services Invocation 2-15 JAX-RPC and JAX-WS Stack Comparison 2-17 Java Web Service Development Approaches 2-18 Bottom-Up Approach 2-19 Top-Down Approach 2-20 WebLogic Server Support for JWS 2-21 Quiz 2-22 Web Service Development Process 2-23 Tools for JWS Development 2-24 Creating Web Services by Using Oracle JDeveloper 11g 2-25 Creating a Web Service from a Java Class by Using JDeveloper 2-27 Summary 2-28 Practice 2 Overview: Developing a Simple Web Service 2-29

v

3 Exploring SOAP and WSDL

Objectives 3-2 Basics of XML 3-3 XML Namespace and XML Schema 3-5 SOAP: XML Messaging for Web Services 3-7 Communication with SOAP 3-8 SOAP over HTTP 3-9 Basic Structure of SOAP 3-10 SOAP Messages: Example 3-12 Examining SOAP Messages Using the HTTP Analyzer 3-13 SOAP Message Formats 3-14 Quiz 3-16 RPC-Style SOAP Message Structure 3-17 Document-Style SOAP Message Structure: document/literal 3-19 Document-Style SOAP Message Structure: document/wrapped 3-20 SOAP Attachment 3-21 WSDL 3-22 WSDL Model 3-23 A Basic WSDL Document 3-25 Defining the Structure of Content in the SOAP Body 3-27 WSDL Binding 3-28 WSDL Styles 3-29 RPC/literal Message WSDL 3-30 document/literal Message WSDL 3-31 document/wrapped Message WSDL 3-34 An Example with SOAP Binding 3-35 Quiz 3-36 Creating a WSDL File by Using JDeveloper 3-37 Mapping of a Java Method to WSDL 3-40 WSDL Message Exchange Patterns 3-42 Summary 3-43 Practice 3 Overview: Creating WSDL-Based Contracts 3-44

4 Implementing JAX-WS Web Services: Server Side Objectives 4-2 JAX-WS 2.1 Features 4-3 Server-Side JAX-WS Run Time 4-5 Service Granularity 4-6

vi

Designing Coarse-Grained Interfaces 4-7 JAX-WS Development Model 4-8 Implementing Web Services by Using POJOs 4-9 Using Annotations 4-10 JSR 181 Annotations 4-12 Complex Return Results 4-13 Web Service Life Cycle 4-14 PostConstruct and PreDestroy Life Cycle Annotations 4-15 An Example of POJO-Based Service Endpoint 4-17 Quiz 4-19 Implementing Web Services by Using EJB 4-20 An Example of EJB Endpoint 4-21 The Provider API: Working with XML Directly 4-22 A Sample of Provider Endpoint 4-23 Creating Web Services from a WSDL File 4-24 A Sample WSDL and Generated Java File 4-25 Quiz 4-27 Summary 4-28 Practice 4 Overview: Creating Server-Side Web Services 4-29

5 Implementing JAX-WS Web Services: Client Side Objectives 5-2 Agenda 5-3 JAX-WS Client-Side Programming Model 5-4 Accessing Web Services 5-5 Service Objects 5-6 Invoking a Web Service with Proxy 5-7 Clients and Web Services 5-8 Generated Client Artifacts 5-9 HelloWorld Web Service (Server-Side) 5-10 HelloWorld Web Service WSDL File 5-11 Generated HelloWorld (Client-Side) 5-13 Generated HelloWorldService 5-14 Enabling Features: WebServiceFeature 5-15 Generated HelloWorldPortClient 5-16 BindingProvider Interface 5-17 Tools for Generating a Web Service Proxy 5-18 Creating a Web Service Proxy Using JDeveloper 5-19 Creating a Client JAR by Using Ant 5-20 Injecting Web Service References 5-21

vii

Quiz 5-22 Agenda 5-23 Dispatch Client API 5-24 Using the Dispatch API for XML Messaging 5-25 Dispatch Client Support Matrix 5-26 A Sample of Dispatch Client 5-27 Invoking a Web Service by Using the Dispatch API 5-28 Agenda 5-29 JAX-WS Web Services Invocation Mechanisms: Synchronous 5-30 JAX-WS Web Services Invocation Mechanisms: Asynchronous 5-31 Asynchronous Invocation Models 5-32 HelloWorld (SEI) with Asynchronous Method Calls 5-33 HelloWorldPortClient: Asynchronous Polling 5-35 Asynchronous Callback: Sequence Diagram 5-36 HelloWorldPortClient: Asynchronous Callback 5-37 Creating an SEI Proxy by Using the Asynchronous Invocation Models 5-39 Creating a Dispatch Client by Using the Polling Asynchronous Invocation Model 5-40 Dispatch Client: Asynchronous Polling 5-41 Creating a Dispatch Client by Using the Callback Asynchronous Invocation Model 5-42 Dispatch Client: Asynchronous Callback 5-43 Quiz 5-44 Summary 5-45 Practice 5 Overview: Accessing Web Services 5-46

6 Packaging, Deploying, and Managing Web Services Objectives 6-2 Web Services Packaging and Deployment 6-3 Port Component 6-4 Packaging a POJO Endpoint 6-5 Packaging an EJB Endpoint 6-7 WLS Container Deployment Processing 6-8 Deploying Web Services Without Deployment Descriptor 6-10 WSDL Generated from the SIB 6-11 Supplying a WSDL File 6-12 Deploying Web Services with a Deployment Descriptor 6-13 Customizing Endpoint URLs 6-14 Deployment Descriptors: Example 6-15 Generated WSDL File: Example 6-16

viii

Overview of webservice.xml and weblogic-webservice.xml 6-17 Example of webservice.xml File 6-18 Using webservice.xml to Override Annotations 6-19 Quiz 6-20 Packaging and Deployment Tools 6-21 Deploying Web Services by Using JDeveloper 6-22 Deploying Web Services by Using OEPE 6-23 Deploying a Web Service with a SIB 6-24 Deploying a Web Service with an SIB and WSDL 6-25 Using jwsc Ant to Package Web Services 6-26 Updating the build.xml File for the jwsc Ant Task 6-27 Using the wldeploy Ant Task to Deploy Web Services 6-28 Overview of WebLogic Web Services Administration Tasks 6-29 Basics of WebLogic Server Administration Console 6-31 Managing Web Services by Using the Administration Console 6-33 Web Service Configuration 6-34 Configuring a Policy 6-35 Testing via the Console 6-36 Quiz 6-37 Summary 6-38

Practice 6 Overview: Packaging and Deploying Web Services 6-39

7 Fault and Exception Handling in JAX-WS Web Services Objectives 7-2 What Are SOAP Faults? 7-3 Java and SOAP Faults 7-4 Unmodeled Faults 7-5 Common Unmodeled Faults 7-6 SOAP Fault Structure 7-7 SOAP 1.1 Fault 7-8 SOAP 1.1 Standard Fault Codes 7-9 SOAP 1.1 Fault Message Example 7-10 SOAP 1.2 Faults 7-11 SOAP 1.2 Fault Codes 7-12 SOAP 1.2 Fault Message Structure 7-13 SOAP 1.2 Fault Message Example 7-14 JAX-WS Fault Processing Infrastructure 7-15 Quiz 7-16 Creating Modeled Faults 7-17 Web Service and Exception 7-18

ix

Web Service WSDL with Fault Message 7-19 FaultBean Class (Generated JavaBean) 7-21 Exception Class 7-22 Client-Side Service Implementation 7-24 Client 7-25 Creating Modeled Faults 7-26 Implicit Fault Example on the Server Side 7-27 Implicit Fault Example on the Client Side 7-28 Exceptions in the Log File 7-29 Quiz 7-30 Summary 7-31 Practice 7 Overview: Handling Web Service Exceptions 7-32

8 Web Services Security Objectives 8-2 Overview of Web Services Security 8-3 Transport-Level Security 8-4 Message-Level Security 8-5 WS-Security Overview 8-6 What Is SAML? 8-8 SAML Architecture 8-9 WS-Security and SAML 8-10 WebLogic’s Support for SAML Token 8-11 WS-Security Architecture 8-12 WS-Security Stack 8-13 Quiz 8-15 WS-Policy: Overview 8-17 Policy Assertion 8-18 Policy Operators 8-19 Sample of a Policy File 8-20 WS-SecurityPolicy 8-21 Quiz 8-22 WebLogic WS-Security Support 8-23 Message-Level Security Configuration Using Policy Files 8-24 Using @Policy and @Policies Annotations: Example 8-25 Specifying the Policy File Location 8-26 WebLogic Prepackaged Policy Files 8-27 Associating Policy Files by Using JDeveloper 8-29 Associating Policy Files at Run Time by Using Administration Console 8-30 Quiz 8-32

x

Message Encryption and Signing Mechanisms 8-33 Configuring Message-Level Security 8-34 Creating Key Pairs, Keystore on the Server Side 8-36 Web Service Security Configuration 8-37 Quiz 8-38 Invoking a Message-Secured Web Service 8-39 Sample Client Code 8-40 Invoking a Web Service from Within a WebLogic Server Instance 8-42 Oracle WSM WS-Security Policies 8-44 Adding Oracle WSM WS-Security Policies to a Web Service 8-45 Nonsupported Oracle WSM WS-Security Policies 8-46 Summary 8-47 Practice 8 Overview: Securing Web Services by Using WS-Policy 8-48

9 Using Handlers in JAX-WS Web Services Objectives 9-2 SOAP Message Handlers 9-3 Handler Types 9-5 Handler Framework 9-6 Creating Message Handlers 9-7 Quiz 9-8 Handler Interfaces 9-9 Handler Life Cycle 9-10 Message Context 9-11 MessageContext Interface 9-12 MessageContext Injection in Web Services 9-14 Handler Interface Methods 9-15 Interfaces of Logical and SOAP Handlers 9-16 A Simple Logical Handler Class 9-17 A Simple SOAP Handler Class 9-18 Quiz 9-19 Handler Chain 9-20 WebLogic Server-Side Handler Execution 9-22 Handler Chain Processing Order 9-23 Configuring Handler Chains on the Server Side 9-24 Sample Service Implementation Class with Handler Chain Annotation 9-25 Sample Handler Chain Configuration File 9-26 Quiz 9-28 Configuring Handler Chains on the Client Side 9-29 Implementing HandlerResolver Interface 9-31

xi

Using a Binding Interface 9-33 Quiz 9-35 Adding Server-Side Handlers 9-36 Creating a Configuration File by Using JDeveloper Wizard 9-37 Adding Client-Side Handlers 9-38 Summary 9-39 Practice 9 Overview: Creating Handlers for Web Services 9-40

10 Optimizing Binary Data Transmission by Using MTOM/XOP Objectives 10-2 Challenges of Binary Data Transmission 10-3 SOAP Message with Text-Encoded Binary 10-4 SOAP with Attachment 10-5 Using MIME with SOAP 10-6 SOAP Message in MIME Package 10-7 MTOM Addresses Challenges 10-9 XOP 10-10 How MTOM/XOP Works 10-11 MTOM/XOP Version of SOAP Message 10-12 Quiz 10-14 Enabling MTOM for JAX-WS Web Services 10-15 Using MTOM/XOP to Send Binary Data 10-16 MIME and Java Data Type Mappings 10-17 Annotating the Data Types: Start from Java 10-18 Annotating the Data Types: Start from WSDL 10-19 Enabling MTOM on the Server Side: Annotation 10-20 Enabling MTOM on the Server Side: WS-Policy 10-21 Enabling MTOM by Using JDeveloper 10-23 Quiz 10-24 Enabling MTOM on the Client Side 10-25 Setting the Attachment Threshold 10-27 Quiz 10-28 Streaming MTOM 10-29 Server-Side Implementation Code 10-30 Client-Side Implementation Code 10-31 Configuring Streaming SOAP Attachments 10-32 Summary 10-34 Practice 10 Overview: Enabling MTOM in JAX-WS Web Services 10-35

xii

11 JAX-WS Binding Customization Objectives 11-2 JAX-WS and JAXB 11-3 Data Binding with JAXB 11-4 Type Mapping Mechanisms 11-5 JAXB Binding Scenarios 11-6 Quiz 11-7 Binding XML Schema to Java Representation 11-8 Example of XML Schema-to-Java Mapping 11-9 Mapping Java Types to XML Schema 11-10 Data Type Mapping 11-11 Built-in Data Types: XML-to-Java Mapping 11-12 Built-in Data Types: Java-to-XML Mapping 11-13 Supported User-Defined XML Schema Data Types 11-14 Supported Java User-Defined Data Types 11-15 Customizing Java-to-XML by Using Annotations 11-16 JAXB Mapping Annotations 11-17 Example of JAXB Annotations 11-18 Quiz 11-19 Customizing XML Schema-to-Java Mapping by Using Binding Declaration 11-20 Scopes of Custom Binding Declarations 11-21 Creating an External Binding Declaration File 11-23 JAX-WS Custom Binding Declarations 11-24 Example of JAX-WS Custom Binding Declarations 11-26 Creating an External Binding Declarations File by Using JAXB Binding Declarations 11-27 JAXB Custom Binding Declarations 11-28 Example of JAXB Custom Binding Declarations 11-30 Embedding Binding Declarations 11-31 Embedding JAX-WS or JAXB Binding Declarations in the WSDL File 11-32 Embedding JAXB Binding Declarations in the XML Schema 11-33 Quiz 11-34 Summary 11-35 Practice 11 Overview: Customizing JAX-WS Web Services Data Binding 11-36

12 Implementing JAX-RPC Web Services Objectives 12-2 JAX-RPC Versus JAX-WS 12-3 Standards/Features Supported by JAX-RPC and JAX-WS 12-4 WebLogic’s Support for JAX-RPC 12-5

xiii

JAX-RPC Server-Side Programming Models 12-6 JAX-RPC Service Endpoints Run-Time Architecture 12-7 JAX-RPC Service Endpoints 12-8 EJB Endpoints 12-9 Creating a Web Service by Using Annotations 12-10 Creating a JAX-RPC Web Service by Using JDeveloper 12-11 Quiz 12-12 JAX-RPC Client-Side Programming Models 12-13 Invoking Web Services by Using a Generated Stubs Model 12-14 Endpoint Interface Generated from WSDL 12-15 Generated Stub Class 12-16 Generated Service Interface and Implementation 12-17 Using the Stub Interface to Access Run-Time Information 12-18 WebLogic Web Services Stub Properties 12-19 Quiz 12-20 JAX-RPC Data Binding 12-21 Mapping XML Schema Complex Types 12-22 Mapping XML Schema Complex Types: Generated Endpoint Interface 12-23 Packaging and Deploying JAX-RPC Services 12-24 Packaging and Deployment Tools 12-25 Summary 12-26 Practice 12 Overview: Creating JAX-RPC Web Services 12-27

13 Using Web Services Reliable Messaging Objectives 13-2 What Is Web Service Reliable Messaging? 13-3 Reliable Messaging Model 13-4 WSRM Versus Java Message Service 13-6 Life Cycle of Reliable Message Sequence 13-7 One-Way Reliable Message Sequence 13-8 WSRM SOAP Message: CreateSequence 13-10 WSRM SOAP Message: CreateSequenceResponse 13-11 WSRM SOAP Message: Application Message 13-12 WSRM SOAP Message: SequenceAcknowledgement 13-13 Reliable Messaging Ordering Model 13-14 Delivery Assurances 13-15 Quiz 13-16 WebLogic WSRM Architecture 13-17 WebLogic WSRM Interaction 13-19 Using WS-Policy to Specify Reliability Requirements 13-20

xiv

DefaultReliability1.1.xml WS-Policy File 13-21 Associating WSRM Policy Files by Using JDeveloper 13-22 Quiz 13-23 Configuring WSRM for a WebLogic Web Service 13-24 Configuring Destination WebLogic Server Instance 13-25 Configuring JMS and SAF Resources by Using Configuration Wizard 13-27 Configuring Source WebLogic Server Instance 13-28 Quiz 13-29 Annotations for Reliable Messaging 13-30 Sample RM Web Service 13-32 Invoking a Reliable Web Service 13-34 Reliable Web Service Client 13-35 Web Service Client 13-36 Quiz 13-37 Summary 13-38 Practice 13 Overview: Configuring and Creating Reliable Web Services 13-39

14 Creating Conversational Web Services Objectives 14-2 Conversational Web Service 14-3 Maintaining a Conversational State 14-4 Conversation Phases 14-5 The Process of Conversational Service 14-6 Quiz 14-7 Conversation Provider and Consumer 14-8 Implementing Conversational Web Services 14-9 Sample of a Conversational Web Service 14-11 Invoking a Conversational Web Service 14-13 Sample of a Conversational Web Service Client 14-14 Using a Stand-Alone Java Client to Invoke a Conversational Web Service 14-15 Sample of a Stand-Alone Java Client 14-16 Quiz 14-17 Summary 14-18 Practice 14 Overview: Developing Conversational Web Services 14-19

15 Developing Database Web Services Objectives 15-2 What Is a Database Web Service? 15-3 Database Call-In 15-4 Database Call-Out 15-5

xv

Generating Wrapper Classes by Using JDeveloper 15-6 SQL-to-XML Type Mappings for Web Service Call-Ins 15-7 SQL-to-XML Type Mappings 15-8 Quiz 15-9 Developing Web Services that Expose Database Resources 15-10 Exposing PL/SQL Packages as Web Services 15-12 Steps for Exposing PL/SQL Packages as Web Services by Using JDeveloper 15-13 Creating a Database Connection 15-14 Examining the PL/SQL Package 15-15 Publishing a PL/SQL Package as a Web Service 15-16 Generated Web Service’s Artifacts 15-19 Creating the Application Deployment Profile 15-20 Testing the Generated Web Service by Using the Administration Console 15-21 Quiz 15-23 Generating a Client and Invoking the Database Web Service 15-24 Generating the Web Service Client Proxy 15-25 Creating a Client to Invoke the DB Web Service 15-26 Summary 15-27 Practice 15 Overview: Developing Database Web Services 15-28

16 Developing Web Services Best Practices Objectives 16-2 Web Service Design Principles 16-3 Designing Coarse-Grained Interfaces 16-4 Choosing SOAP Binding 16-5 Using EJB Endpoint in Web Services 16-6 Using Annotations 16-7 Data Serialization and XML Schema 16-8 Practical XML Schema Interoperability 16-9 Type Mapping 16-10 Using Modeled SOAP Fault 16-11 WS-Security Interoperability Best Practices 16-12 Terminating Reliable Message Sequence 16-14 Quiz 16-16 Summary 16-18

17 Building SOA Applications with Web Services Objectives 17-2 Defining SOA 17-3 Enabling SOA Through Web Services 17-4

xvi

Sample SOA Application 17-5 ADF Web Services 17-7 Standards That Enable SOA 17-8 Introducing Orchestration 17-9 Introducing BPEL 17-10 Introducing SCA in Oracle SOA Suite 11g 17-11 Service Component Architecture (SCA) 17-12 Elements of SCA 17-13 Service Data Object (SDO) 17-14 Designing with an SOA Approach 17-15 Types of Service Access and Implementation 17-16 Implementing SOA: General Concepts 17-17 Oracle SOA Suite 11g Components 17-18 Quiz 17-20 Summary 17-21

Appendix A: Practices and Solutions – JDeveloper Appendix B: Practices and Solutions – Eclipse Glossary