Programming WebLogic Resource Adapters

Introduction and Roadmap

Document Scope and Audience

Guide to This Document

Related Documentation

Examples for the Resource Adapter Developer

New and Changed Features in This Release

(Deprecated) Link-Ref Mechanism

Understanding Resource Adapters

Overview of Resource Adapters

Comparing WebLogic Server and WebLogic Integration Resource Adapters

Inbound, Outbound, and Bidirectional Resource Adapters

Comparing 1.0 and 1.5 Resource Adapters

J2EE Connector Architecture

J2EE Architecture Diagram and Components

System-Level Contracts

Resource Adapter Deployment Descriptors

Creating and Configuring Resource Adapters

Creating and Configuring Resource Adapters: Main Steps

Modifying an Existing Resource Adapter

Configuring the ra.xml File

Configuring the weblogic-ra.xml File

Editing Resource Adapter Deployment Descriptors

Editing Considerations

Schema Header Information

Conforming Deployment Descriptor Files to Schema

Dynamic Descriptor Updates: Console Configuration Tabs

Dynamic Pool Parameters

Dynamic Logging Parameters

Automatic Generation of the weblogic-ra.xml File

(Deprecated) Configuring the Link-Ref Mechanism

Programming Tasks

Required Classes for Resource Adapters

Programming a Resource Adapter to Perform as a Startup Class

Suspending and Resuming Resource Adapter Activity

Extended BootstrapContext

Diagnostic Context ID

Dye Bits

Callback Capabilities

Connection Management

Connection Management Contract

Connection Factory and Connection

Resource Adapters Bound in JNDI Tree

Obtaining the ConnectionFactory (Client-JNDI Interaction)

Configuring Outbound Connections

Connection Pool Configuration Levels

Multiple Outbound Connections Example

Configuring Inbound Connections

Configuring Connection Pool Parameters

initial-capacity: Setting the Initial Number of ManagedConnections

max-capacity: Setting the Maximum Number of ManagedConnections

capacity-increment: Controlling the Number of ManagedConnections

shrinking-enabled: Controlling System Resource Usage

shrink-frequency-seconds: Setting the Wait Time Between Attempts to Reclaim Unused ManagedConnections

highest-num-waiters: Controlling the Number of Clients Waiting for a Connection

highest-num-unavailable: Controlling the Number of Unavailable Connections

connection-creation-retry-frequency-seconds: Recreating Connections

match-connections-supported: Matching Connections

test-frequency-seconds: Testing the Viability of Connections

test-connections-on-create: Testing Connections upon Creation

test-connections-on-release: Testing Connections upon Release to Connection Pool

test-connections-on-reserve: Testing Connections upon Reservation

Connection Proxy Wrapper - 1.0 Resource Adapters

Possible ClassCastException

Turning Proxy Generation On and Off

Testing Connections

Configuring Connection Testing

Testing Connections in the Administration Console

Transaction Management

Supported Transaction Levels

XA Transaction Support

Local Transaction Support

No Transaction Support

Configuring Transaction Levels

Message and Transactional Inflow

Overview of Message and Transactional Inflow

Architecture Components

Inbound Communication Scenario

How Message Inflow Works

Handling Inbound Messages

Proprietary Communications Channel and Protocol

Message Inflow to Message Endpoints (Message-driven Beans)

Deployment-Time Binding Between an MDB and a Resource Adapter

Binding an MDB and a Resource Adapter

Dispatching a Message

Activation Specifications

Administered Objects

Transactional Inflow

Using the Transactional Inflow Model for Locally Managed Transactions

Security

Container-Managed and Application-Managed Sign-on

Application-Managed Sign-on

Container-Managed Sign-on

Password Credential Mapping

Authentication Mechanisms

Credential Mappings

Creating Credential Mappings Using the Console

Security Policy Processing

Configuring Security Identities for Resource Adapters

default-principal-name: Default Identity

manage-as-principal-name: Identity for Running Management Tasks

run-as-principal-name: Identity Used for Connection Calls from the Connector Container into the Resource Adapter

run-work-as-principal-name: Identity Used for Performing Resource Adapter Management Tasks

Configuring Connection Factory-Specific Authentication and Re-authentication Mechanisms

Packaging and Deploying Resource Adapters

Packaging Resource Adapters

Packaging Directory Structure

Packaging Considerations

Packaging Limitation

Packaging Resource Adapter Archives (RARs)

Deploying Resource Adapters

Deployment Options

Resource Adapter Deployment Names

Production Redeployment

Suspendable Interface and Production Redeployment

Production Redeployment Requirements

Production Redeployment Process

weblogic-ra.xml Schema

weblogic-connector

work-manager

security

default-principal-name

manage-as-principal-name

run-as-principal-name

run-work-as-principal-name

properties

admin-objects

admin-object-group

admin-object-instance

outbound-resource-adapter

default-connection-properties

pool-params

logging

connection-definition-group

connection-instance

Resource Adapter Best Practices

Classloading Optimizations for Resource Adapters

Connection Optimizations

Thread Management

InteractionSpec Interface