Skip Headers
Oracle® Fusion Middleware User's Guide for Technology Adapters
11
g
Release 1 (11.1.1)
E10231-02
Index
Next
Contents
List of Examples
List of Figures
List of Tables
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
Part I Introduction and Concepts
1
Introduction to Oracle JCA Adapters
Features of Oracle JCA Adapters
Types of Oracle JCA Adapters
Oracle Technology Adapters
Architecture
Design-Time Components
Run-Time Components
Deployment
Legacy Adapters
Architecture
Design-Time Components
Run-Time Components
Deployment
Packaged-Application Adapters
Architecture
Design-Time Components
Run-Time Components
Deployment
Oracle Adapter for Oracle Applications
Types of Oracle JCA Adapters Adapter Services
Request-Response (Outbound Interaction) Service
Event Notification (Inbound Interaction) Service
Metadata Service
2
Adapter Life-Cycle Management
Installing Oracle JCA Adapters
Starting and Stopping Oracle JCA Adapters
Defining Adapter Interface by Importing an Existing WSDL
Configuring Message Header Properties for Oracle JCA Adapters
Describing XML Data Structure
Physically Deploying Oracle JCA Adapters
Creating an Application Server Connection for Oracle JCA Adapters
Deploying Oracle JCA Adapter Applications from JDeveloper
Manually Deploying an Adapter RAR File
Handling Deployment Plan When Working on a Remote Oracle SOA Server
Migrating Repositories
How Oracle JCA Adapters Ensure No Message Loss
Local Transactions and Global (XA) Transactions
Inbound Transactions
Outbound Transactions
Composite Availability and Inbound Adapters
Singleton (Active/Passive) Inbound Endpoint Lifecycle Support Within Adapters
Oracle BPEL Process Manager Correlation Support Within Adapters
Streaming Large Payload
Batching and Debatching Support
Adding an Adapter Connection Factory
Creating a Data Source
Creating a Connection Pool
Recommended Setting for Data Sources Used by Oracle JCA Adapters
Error Handling
Handling Rejected Messages
Configuring Rejection Handlers
Rejected Message Handlers
Checking for Rejected Messages
Handling Connection Errors
Outbound Interaction
Inbound Interaction
Handling Message Errors
Testing Applications
Setting the Trace Level of Oracle JCA Adapters
Viewing Adapter Logs
3
Adapter Integration with Oracle Application Server Components
Adapter Integration with Oracle WebLogic Server
Oracle WebLogic Server Overview
Oracle WebLogic Server Integration with Adapters
Design Time
Run Time
Adapter Integration with Oracle Fusion Middleware
Oracle BPEL Process Manager Overview
Oracle Mediator Overview
Oracle Fusion Middleware Integration with Adapters
Design Time
Run Time
End-to-End Testing
Oracle BPEL PM Integration with Outbound Interaction
Oracle BPEL PM Integration with Inbound Interaction
Use Case: Integration with Oracle BPEL Process Manager
Oracle SOA Composite Integration with Adapters
Oracle SOA Composite Overview
Adapters Integration With Oracle SOA Composite
Monitoring Oracle JCA Adapters
4
Oracle JCA Adapter for Files/FTP
Introduction to Oracle File and FTP Adapters
Oracle File and FTP Adapters Architecture
Oracle File and FTP Adapters Integration with Oracle BPEL PM
Oracle File and FTP Adapters Integration with Mediator
Oracle File and FTP Adapters Integration with SOA Composite
Oracle File and FTP Adapters Features
File Formats
FTP Servers
Inbound and Outbound Interactions
File Debatching
File ChunkedRead
File Sorting
Dynamic Outbound Directory and File Name Specification
Security
Nontransactional
Proxy Support
No Payload Support
Large Payload Support
File-Based Triggers
Pre-Processing and Post-Processing of Files
Mechanism For Pre-Processing and Post-Processing of Files
Configuring a Pipeline
Using a Re-Entrant Valve For Processing Zip Files
Configuring Batch Notification Handler
Error Handling
Threading Model
Default Threading Model
Modified Threading Model
Performance Tuning
High Availability
Multiple Directories
Append Mode
Recursive Processing of Files Within Directories in Oracle FTP Adapter
Securing Enterprise Information System Credentials
Oracle File and FTP Adapter Concepts
Oracle File Adapter Read File Concepts
Inbound Operation
Inbound File Directory Specifications
File Matching and Batch Processing
File Polling
Postprocessing
Native Data Translation
Inbound Service
Inbound Headers
Oracle File Adapter Write File Concepts
Outbound Operation
Outbound File Directory Creation
Native Data Translation
Outbound Service Files
Outbound Headers
Oracle File Adapter Synchronous Read Concepts
Oracle File Adapter File Listing Concepts
Listing Operation
File Directory Specifications
File Matching
Oracle FTP Adapter Get File Concepts
Oracle FTP Adapter Put File Concepts
Oracle FTP Adapter Synchronous Get File Concepts
Oracle FTP Adapter File Listing Concepts
Configuring Oracle File and FTP Adapters
Configuring the Credentials for Accessing a Remote FTP Server
Configuring Oracle File and FTP Adapters for High Availability
Prerequisites for High Availability
High Availability in Inbound Operations
High Availability in Outbound Operations
Using Secure FTP with the Oracle FTP Adapter
Secure FTP Overview
Installing and Configuring FTP Over SSL on Solaris and Linux
Installing and Configuring FTP Over SSL on Windows
Using SFTP with Oracle FTP Adapter
SFTP Overview
Install and Configure OpenSSH for Windows
Set Up Oracle FTP Adapter for SFTP
Configuring Oracle FTP Adapter for HTTP Proxy
Configuring for Plain FTP Mode
Configuring for SFTP Mode
Oracle File and FTP Adapters Use Cases
Oracle File Adapter XML Debatching
Prerequisites
Designing the SOA Composite
Creating the Inbound Oracle File Adapter Service
Creating the Outbound File Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using Oracle Enterprise Manager Fusion Middleware Control Console (Fusion Middleware Control Console)
Flat Structure for Oracle BPEL PM
Prerequisites
Designing the SOA Composite
Creating the Inbound Oracle File Adapter Service
Creating the Outbound Oracle File Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using Oracle Fusion Middleware Control Console
Flat Structure for Mediator
Prerequisites
Creating a Mediator Application and Project
Importing the Schema Definition (.XSD) Files
Creating the Inbound Oracle File Adapter Service
Creating the Outbound Oracle FTP Adapter Service
Wiring Services
Creating the Routing Rule
Deploying with JDeveloper
Run-Time Task
Oracle File Adapter Scalable DOM
Prerequisites
Designing the SOA Composite
Creating the Inbound Oracle File Adapter Service
Creating the Outbound Oracle File Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using Fusion Middleware Control Console
Oracle File Adapter ChunkedRead
Prerequisites
Designing the SOA Composite
Creating the Inbound Oracle File Adapter Service
Creating the Outbound Oracle File Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using Fusion Middleware Control Console
Oracle File Adapter Read File As Attachments
Prerequisites
Designing the SOA Composite
Creating the Inbound Oracle File Adapter Service
Creating the Outbound Oracle File Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using Fusion Middleware Control Console
Oracle File Adapter File Listing
Prerequisites
Designing the SOA Composite
Creating the Outbound Oracle File Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using Fusion Middleware Control Console
Oracle File Adapter Complex Structure
Prerequisites
Designing the SOA Composite
Creating the Inbound Oracle File Adapter Service
Creating the Outbound Oracle File Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using Fusion Middleware Control Console
Oracle FTP Adapter Debatching
Prerequisites
Designing the SOA Composite
Creating the Inbound Oracle FTP Adapter Service
Creating the Outbound Oracle FTP Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using Fusion Middleware Control Console
Oracle FTP Adapter Dynamic Synchronous Read
Prerequisites
Designing the SOA Composite
Creating the Inbound Oracle File Adapter Service
Creating the Outbound Oracle FTP Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using Fusion Middleware Control Console
Copying, Moving, and Deleting Files
Moving a File from a Local Directory on the File System to Another Local Directory
Copying a File from a Local Directory on the File System to Another Local Directory
Deleting a File from a Local File System Directory
Using a Large CSV Source File
Moving a File from One Remote Directory to Another Remote Directory on the Same FTP Server
Moving a File from a Local Directory on the File System to a Remote Directory on the FTP Server
Moving a File from a Remote Directory on the FTP Server to a Local Directory on the File System
Moving a File from One FTP Server to another FTP Server
5
Oracle JCA Adapter for Sockets
Introduction to Oracle Socket Adapter
Oracle Socket Adapter Architecture
Oracle Socket Adapter Integration with Mediator
Oracle Socket Adapter Integration with Oracle BPEL PM
Oracle Socket Adapter Integration with SOA Composite
Oracle Socket Adapter Features
Oracle Socket Adapter Concepts
Communication Modes
Inbound Synchronous Request/Response
Outbound Synchronous Request/Response
Inbound Receive
Outbound Invoke
Mechanisms for Defining Protocols
Protocol with Handshake Mechanism Using Style Sheet
Protocol with Handshake Mechanism Using Custom Java Code
Protocol Without Handshake Mechanism
Character Encoding and Byte Order
Performance Tuning
Configuring Oracle Socket Adapter Connection Pooling
Configuring Oracle Socket Adapter
Modifying the weblogic-ra.xml File
Modeling a Handshake
Modeling an Outbound Handshake
Modeling an Inbound Handshake
Designing an XSL File Using the XSL Mapper Tool
Designing XSL for Inbound Synchronous Request/Reply
Designing XSL for Outbound Synchronous Request/Reply
Oracle Socket Adapter Use Cases
Oracle Socket Adapter Hello World
Prerequisites
Designing the SOA Composite
Creating the Inbound Oracle Socket Adapter Service
Creating the Outbound Oracle Socket Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using the Oracle Enterprise Manager Fusion Middleware Control Console (Fusion Middleware Control Console)
Flight Information Display System
Prerequisites
Designing the SOA Composite
Creating the Inbound Oracle Socket Adapter Service
Creating Outbound Oracle Socket Adapter Services
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using the Fusion Middleware Control Console
6
Native Format Builder Wizard
Creating Native Schema Files with the Native Format Builder Wizard
Supported File Formats
Delimited
Fixed Length (Positional)
Complex Type
DTD
COBOL Copybook
Editing Native Schema Files
Native Schema Constructs
Understanding Native Schema Constructs
Using Native Schema Constructs
Defining Fixed-Length Data
Defining Terminated Data
Defining Surrounded Data
Defining Lists
Defining Arrays
Conditional Processing
Defining Dates
Using Variables
Defining Prefixes and Suffixes
Defining Skipping Data
Defining fixed and default Values
Defining write
Defining LookAhead
Defining outboundHeader
Defining Complex Condition in conditionValue
Defining Complex Condition in choiceCondition
Defining dataLines
Defining Date Formats with Time Zone
Implementing Validation During Translation
Processing Files with BOM
Translator XPath Functions
Terminologies
Translator XPath Functions
doTranslateFromNative Function
doTranslateToNative Function
doStreamingTranslate Function
Batching Transformation Features
Use Cases for the Native Format Builder
Defining the Schema for a Delimited File Structure
Defining a Asterisk (*) Separated Value File Structure
Defining the Schema for a Fixed Length File Structure
Defining the Schema for a Complex File Structure
Removing or Adding Namespaces to XML with No Namespace
Defining the Choice Condition Schema for a Complex File Structure
Defining Choice Condition With LookAhead for a Complex File Structure
Defining Array Type Schema for a Complex File Structure
Defining the Schema for a DTD File Structure
Defining the Schema for a COBOL Copybook File Structure
Part II Message Adapters
7
Oracle JCA Adapter for AQ
Introduction to the Oracle AQ Adapter
Oracle AQ Adapter Integration with Oracle BPEL Process Manager
Oracle AQ Adapter Integration with Oracle Mediator
Oracle AQ Adapter Features
Enqueue-Specific Features (Message Production)
Dequeue and Enqueue Features
Supported ADT Payload Types
Native Format Builder Wizard
Normalized Message Support
Is DOM 2 Compliant
Is Message-Size Aware
Multiple Receiver Threads
DequeueTimeout Property
Control Dequeue Timeout and Multiple Inbound Polling Threads
Stream Payload Support
Oracle AQ Adapter Inbound Retries
Error Handling Support
Performance Tuning
Oracle AQ Adapter Use Cases
Generic Use Case
The Adapter Configuration Wizard Walkthrough
Dequeuing and Enqueuing Object and ADT Payloads
Dequeuing One Column of the Object Payload
Using Correlation ID for Filtering Messages During Dequeue
Enqueuing and Dequeuing from Multisubscriber Queues
Rule-Based Subscription for Multiconsumer Queues
Oracle AQ Adapter ADT Queue
Meeting Prerequisites
Creating an Application and an SOA Project
Creating an Inbound Oracle AQ Adapter
Creating an Outbound Oracle AQ Adapter
Wiring Services and Activities
Configuring Routing Service
Configuring the Data Sources in the Oracle WebLogic Server Administration Console
Deploying with JDeveloper
Monitoring Using the Fusion Middleware Control Console
Oracle AQ Adapter RAW Queue
Prerequisites
Creating an Application and an SOA Project
Creating an Inbound Adapter Service
Creating an Outbound Adapter Service
Wiring Services and Activities
Configuring the Data Sources in the Oracle WebLogic Server Administration Console
Deploying with JDeveloper
Monitoring Using the Fusion Middleware Control Console
8
Oracle JCA Adapter for JMS
Introduction to the Oracle JMS Adapter
Oracle JMS Adapter Integration with Oracle BPEL Process Manager
Oracle JMS Adapter Integration with Oracle Mediator
Oracle JMS Adapter Features
Oracle JMS Adapter Concepts
Point-to-Point
Publish/Subscribe
Destination, Connection, Connection Factory, and Session
Structure of a JMS Message
Oracle JMS Adapter Header Properties
Oracle JMS Adapter Use Cases
Configuring Oracle JMS Adapter
Creating an Application and an SOA Project
Using the Adapter Configuration Wizard to Configure Oracle JMS Adapter
Generated Files
weblogic-ra.xml file
Produce Message Procedure
Configuring Oracle JMS Adapter with TIBCO JMS
NonDirect Connection
Direct Connection
Configuring Oracle JMS Adapter with IBM WebSphere MQ JMS
Non-XA Data Sources
XA Data Sources
WLS JMS Text Message
Meeting Prerequisites
Creating an Application Server Connection
Creating an Application and an SOA Project
Creating an Inbound Adapter Service
Creating an Outbound Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using the Fusion Middleware Control Console
Accessing Queues and Topics from WLS JMS Server in a Remote Oracle WebLogic Server Domain
Synchronous/Asynchronous Request Reply Interaction Pattern
Synchronous Request Reply Pattern
Asynchronous Request Reply Pattern
AQ JMS Text Message
Meeting Prerequisites
Create an Application Server Connection
Creating an Application and an SOA Project
Creating an Inbound Adapter Service
Creating an Outbound Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using the Fusion Middleware Control Console
Accessing Queues and Topics Created in 11
g
from the OC4J 10.1.3.4 Server
9
Oracle JCA Adapter for Database
Introduction to the Oracle Database Adapter
Functional Overview
Oracle Database Adapter Integration with Oracle BPEL PM
Design Overview
Complete Walkthrough of the Adapter Configuration Wizard
Creating an Application and an SOA Project
Defining an Oracle Database Adapter
Connecting to a Database
Selecting the Operation Type
Selecting and Importing Tables
Defining Primary Keys
Creating Relationships
What Happens When Relationships Are Created or Removed
Different Types of One-to-One Mappings
When Foreign Keys Are Primary Keys
Creating the Attribute Filter
Defining a WHERE Clause
Choosing an After-Read Strategy
Delete the Rows That Were Read
Update a Field in the Table (Logical Delete)
Update a Sequencing Table
Update an External Sequencing Table on a Different Database
Update a Sequencing File
Specifying Polling Options
Specifying Advanced Options
Entering the SQL String for the Pure SQL Operation
Oracle Database Adapter Features
Transaction Support
Configuring Oracle Database Adapter for Global Transaction Participation
Both Invokes in Same Global Transaction
Failure Must Cause Rollback
Transaction/XA Support
Pure SQL - XML Type Support
Row Set Support Using a Strongly or Weakly Typed XSD
Proxy Authentication Support
Streaming Large Payload
Schema Validation
High Availability
Surviving Database Restart
Undying
Scalability
Distributed Polling First Best Practice: SELECT FOR UPDATE (SKIP LOCKED)
Distributed Polling Second Best Practice: Tuning on a Single Node First
Performance Tuning
detectOmissions
Feature
OutputCompletedXml
Feature
QueryTimeout for Inbound and Outbound Transactions
Doing Synchronous Post to BPEL (Allow In-Order Delivery)
Oracle Database Adapter Concepts
Relational-to-XML Mapping
Relational Types to XML Schema Types
Mapping Any Relational Schema to Any XML Schema
Querying over Multiple Tables
SQL Operations as Web Services
DML Operations
Polling Strategies
Deployment
JDBC Driver and Database Connection Configuration
Creating a Database Connection Using a Native or Bundled Oracle WebLogic Server JDBC Driver
Creating a Database Connection Using a Third-Party JDBC Driver
Summary of Third-Party JDBC Driver and Database Connection Information
Using a Microsoft SQL Server
Using a Sybase Database
Using an Informix Database
Using an IBM DB2 Database
Using a MySQL Database
Location of JDBC Driver JAR Files and Setting the Class Path
Stored Procedure and Function Support
Design Time: Using the Adapter Configuration Wizard
Using Top-Level Standalone APIs
Using Packaged APIs and Overloading
Design Time: Using the Command-Line Utility
Common Command-Line Functionality
Generated Output
Supported Third-Party Databases
Creating Database Connections
Design Time: Artifact Generation
The WSDL–XSD Relationship
JCA File
Oracle Data Types
Generated XSD Attributes
User-Defined Types
Complex User-Defined Types
Object Type Inheritance
Object References
Referencing Types in Other Schemas
XSD Pruning Optimization
Run Time: Before Stored Procedure Invocation
Value Binding
Data Type Conversions
Run Time: After Stored Procedure Invocation
Data Type Conversions
Null Values
Function Return Values
Run Time: Common Third-Party Database Functionality
Processing ResultSets
Returning an INTEGER Status Value
Advanced Topics
Row Set Support Using a Strongly Typed XSD
Row Set Support Using a Weakly Typed XSD
Support for PL/SQL Boolean, PL/SQL Record, and PL/SQL Table Types
Oracle Database Adapter Use Cases
Use Cases for Oracle Database Adapter
Use Cases for Oracle Database Adapter - Stored Procedures
Creating and Configuring a Stored Procedure in JDeveloper BPEL Designer
File To StoredProcedure Use Case
10
Oracle JCA Adapter for MQ Series
MQ Series Message Queuing Concepts
MQ Series Concepts
Introduction to Native Oracle MQ Series Adapter
The Need for Oracle MQ Series Adapter
Oracle MQ Series Adapter Integration with Oracle BPEL Process Manager
Oracle MQ Series Adapter Integration with Mediator
Oracle MQ Series Adapter Features
RFH Version 2 (RFH2) Header
Fixed Portion
Variable Portion
SSL Enabling
XA Transactions
XA Recovery
High Availability
Prerequisites for High Availability
High Availability in Inbound/Outbound Operations
Scalability
Securing Enterprise Information System Credentials
Fault Policy
Inbound Rejection Handler
Retry Mechanism
JCA Inbound Retry Mechanism
Message Backout Queue
Performance Tuning
Oracle MQ Series Adapter Concepts
Messaging Scenarios
Enqueue Message
Dequeue Message
Asynchronous Request-Response (Oracle BPEL PM As Client)
Synchronous Request-Response (Oracle BPEL PM As Server)
Asynchronous Request-Response (Oracle BPEL PM As Server)
Synchronous Request-Response (Mediator As Server)
Synchronous Request-Response (Oracle BPEL PM As Client)
Synchronous Request-Response (Oracle Mediator as Client)
Asynchronous Request-Response (Oracle Mediator As Client)
Outbound Dequeue Scenario
Message Properties
Messages Types
Message Format
Message Expiry
Message Priority
Message Persistence
Correlation Schemas
Distribution List Support
Report Messages
Message Delivery Failure Options
Message Segmentation
Integration with CICS
Supported Encodings
Configuring the Oracle MQ Series Adapter
Adding com.ibm.mq.jar to the Oracle MQ Series Adapter Classpath
Adding JNDI Entry
Enabling Binding Mode for Connections
Oracle MQ Series Adapter Use Cases
Dequeue Enqueue
Prerequisites
Designing the SOA Composite
Creating an Inbound Adapter Service
Creating an Outbound Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using the Oracle Enterprise Manager Fusion Middleware Control Console (Fusion Middleware Control Console)
Inbound Synchronous Request-Reply
Prerequisites
Designing the SOA Composite
Creating an Inbound Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using the Fusion Middleware Control Console
Inbound-Outbound Synchronous Request-Reply
Prerequisites
Designing the SOA Composite
Creating an Inbound Adapter Service
Creating an Outbound Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using the Fusion Middleware Control Console
Asynchronous-Request-Reply
Prerequisites
Designing the SOA Composite
Creating an Inbound Adapter Service
Creating an Asynchronous Outbound Request Reply Adapter Service Outbound
Creating Another Outbound Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using the Fusion Middleware Control Console
Outbound Dequeue
Prerequisites
Designing the SOA Composite
Creating an Outbound Dequeue Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using the Fusion Middleware Control Console
Using RFH2 Headers
Designing the SOA Composite
Creating an Inbound Adapter Service
Creating an Outbound Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Configuring a Backout Queue
Prerequisites
Designing the SOA Composite
Creating an Inbound Adapter Service
Creating an Outbound Adapter Service
Wiring Services and Activities
Deploying with JDeveloper
Monitoring Using the Fusion Middleware Control Console
A
Oracle JCA Adapter Properties
Oracle File and FTP Adapters Properties
Oracle Socket Adapter Properties
Oracle AQ Adapter Properties
Oracle JMS Adapter Properties
Oracle Database Adapter Properties
Oracle MQ Series Adapter Properties
Generic Oracle JCA Adapter Properties
B
Oracle JCA Adapter Valves
A Simple Unzip Valve
A Simple Decryption Valve That Uses Staging File
A Valve for Encrypting Outbound Files
An Unzip Valve for processing Multiple Files
Index