Contents

Title and Copyright Information

Preface

• Documentation Accessibility
• Conventions

1 Introduction

2 Using Web Services Addressing

• Overview of WS-Addressing
• Enabling WS-Addressing on the Web Service
  • Enabling WS-Addressing on the Web Service (Starting From Java)
  • Enabling WS-Addressing on the Web Service (Starting from WSDL)
• Enabling WS-Addressing on the Web Service Client
  • Explicitly Enabling WS-Addressing on the Web Service Client
  • Implicitly Enabling WS-Addressing on the Web Service Client
  • Disabling WS-Addressing on the Web Service Client
• Associating WS-Addressing Action Properties
  • Explicitly Associating WS-Addressing Action Properties (Starting from Java)
  • Explicitly Associating WS-Addressing Action Properties (Starting from WSDL)
  • Implicitly Associating WS-Addressing Action Properties
• Configuring Anonymous WS-Addressing

3 Roadmaps for Developing Web Service Clients

• Roadmap for Developing Web Service Clients
• Roadmap for Developing Asynchronous Web Service Clients

4 Invoking Web Services Asynchronously

• Overview of Asynchronous Web Service Invocation
• Steps to Invoke Web Services Asynchronously
• Configuring Your Servers for Asynchronous Web Service Invocation
• Building the Client Artifacts for Asynchronous Web Service Invocation
• Developing Scalable Asynchronous JAX-WS Clients (Asynchronous Client Transport)
  • Enabling and Configuring the Asynchronous Client Transport Feature
    • Configuring the Address of the Asynchronous Response Endpoint
    • Configuring the ReplyTo and FaultTo Headers of the Asynchronous Response Endpoint
    • Configuring the Context Path of the Asynchronous Response Endpoint
    • Publishing the Asynchronous Response Endpoint
    • Configuring Asynchronous Client Transport for Synchronous Operations
  • Developing the Asynchronous Handler Interface
  • Propagating User-defined Request Context to the Response
• Using Asynchronous Web Service Clients From Behind a Firewall (Make Connection)
  • Enabling and Configuring Make Connection on a Web Service
    • Creating the Web Service Make Connection WS-Policy File (Optional)
    • Programming the JWS File to Enable Make Connection
  • Enabling and Configuring Make Connection on a Web Service Client
    • Configuring the Expiration Time for Sending Make Connection Messages
    • Configuring the Polling Interval
    • Configuring the Exponential Backoff
    • Configuring Make Connection as the Transport for Synchronous Methods
• Using the JAX-WS Reference Implementation
• Propagating Request Context to the Response
• Monitoring Asynchronous Web Service Invocation
• Clustering Considerations for Asynchronous Web Service Messaging

5 Roadmap for Developing Reliable Web Services and Clients

• Roadmap for Developing Reliable Web Service Clients
• Roadmap for Developing Reliable Web Services
• Roadmap for Accessing Reliable Web Services from Behind a Firewall (Make Connection)
• Roadmap for Securing Reliable Web Services

6 Using Web Services Reliable Messaging

• Overview of Web Services Reliable Messaging
  • Using WS-Policy to Specify Reliable Messaging Policy Assertions
  • Supported Transport Types for Reliable Messaging
  • The Life Cycle of the Reliable Message Sequence
  • Reliable Messaging Failure Recovery Scenarios
    • RM Destination Down Before Request Arrives
    • RM Source Down After Request is Made
    • RM Destination Down After Request Arrives
    • Failure Scenarios with Non-buffered Reliable Web Services
• Steps to Create and Invoke a Reliable Web Service
• Configuring the Source and Destination WebLogic Server Instances
• Creating the Web Service Reliable Messaging WS-Policy File
  • Creating a Custom WS-Policy File Using WS-ReliableMessaging Policy Assertions Versions 1.2 and 1.1
  • Creating a Custom WS-Policy File Using WS-ReliableMessaging Policy Assertions Version 1.0 (Deprecated)
  • Using Multiple Policy Alternatives
• Programming Guidelines for the Reliable JWS File
• Invoking a Reliable Web Service from a Web Service Client
• Configuring Reliable Messaging
  • Configuring Reliable Messaging on WebLogic Server
    • Using the Administration Console
    • Using WLST
  • Configuring Reliable Messaging on the Web Service Endpoint
  • Configuring Reliable Messaging on Web Service Clients
  • Configuring the Base Retransmission Interval
    • Configuring the Base Retransmission Interval on WebLogic Server or the Web Service Endpoint
    • Configuring the Base Retransmission Interval on the Web Service Client
  • Configuring the Retransmission Exponential Backoff
    • Configuring the Retransmission Exponential Backoff on WebLogic Server or Web Service Endpoint
    • Configuring the Retransmission Exponential Backoff on the Web Service Client
  • Configuring the Sequence Expiration
    • Configuring the Sequence Expiration on WebLogic Server or Web Service Endpoint
    • Configuring Sequence Expiration on the Web Service Client
  • Configuring Inactivity Timeout
    • Configuring the Inactivity Timeout on WebLogic Server or Web Service Endpoint
    • Configuring the Inactivity Timeout on the Web Service Client
  • Configuring a Non-buffered Destination for a Web Service
  • Configuring the Acknowledgement Interval
• Implementing the Reliability Error Listener
• Managing the Life Cycle of a Reliable Message Sequence
  • Managing the Reliable Sequence
    • Getting and Setting the Reliable Sequence ID
    • Accessing the State of the Reliable Sequence
  • Managing the Client ID
  • Managing the Acknowledged Requests
  • Accessing Information About a Message
  • Identifying the Final Message in a Reliable Sequence
  • Closing the Reliable Sequence
  • Terminating the Reliable Sequence
  • Resetting a Client to Start a New Message Sequence
• Monitoring Web Services Reliable Messaging
• Grouping Messages into Business Units of Work (Batching)
• Client Considerations When Redeploying a Reliable Web Service
• Interoperability with WebLogic Web Service Reliable Messaging

7 Managing Web Service Persistence

• Overview of Web Service Persistence
• Roadmap for Configuring Web Service Persistence
• Configuring Web Service Persistence
  • Configuring the Logical Store
  • Configuring Web Service Persistence for a Web Service Endpoint
  • Configuring Web Service Persistence for Web Service Clients
• Using Web Service Persistence in a Cluster
• Cleaning Up Web Service Persistence

8 Configuring Message Buffering for Web Services

• Overview of Message Buffering
• Configuring Messaging Buffering
  • Configuring the Request Queue
  • Configuring the Response Queue
  • Configuring Message Retry Count and Delay

9 Managing Web Services in a Cluster

• Overview of Web Services Cluster Routing
• Cluster Routing Scenarios
  • Scenario 1: Routing a Web Service Response to a Single Server
  • Scenario 2: Routing Web Service Requests to a Single Server Using Routing Information
  • Scenario 3: Routing Web Service Requests to a Single Server Using an ID
• How Web Service Cluster Routing Works
  • Adding Routing Information to Outgoing Requests
  • Detecting Routing Information in Incoming Requests
  • Routing Requests Within the Cluster
  • Maintaining the Routing Map on the Front-end SOAP Router
    • X-weblogic-wsee-storetoserver-list HTTP Response Header
    • X-weblogic-wsee-storetoserver-hash HTTP Response Header
• Configuring Web Services in a Cluster
  • Setting Up the WebLogic Cluster
  • Configuring the Domain Resources Required for Web Service Advanced Features in a Clustered Environment
  • Extending the Front-end SOAP Router to Support Web Services
  • Enabling Routing of Web Services Atomic Transaction Messages
  • Enabling Routing of Web Services Make Connection Messages
  • Configuring the Identity of the Front-end SOAP Router
• Monitoring Cluster Routing Performance

10 Using Web Services Atomic Transactions

• Overview of Web Services Atomic Transactions
• Configuring the Domain Resources Required for Web Service Advanced Features
• Enabling Web Services Atomic Transactions on Web Services
  • Using the @Transactional Annotation in Your JWS File
    • Example: Using @Transactional Annotation on a Web Service Class
    • Example: Using @Transactional Annotation on a Web Service Method
    • Example: Using the @Transactional and the EJB @TransactionAttribute Annotations Together
  • Enabling Web Services Atomic Transactions Starting From WSDL
• Enabling Web Services Atomic Transactions on Web Service Clients
  • Using @Transactional Annotation with the @WebServiceRef Annotation
  • Passing the TransactionalFeature to the Client
• Configuring Web Services Atomic Transactions Using the Administration Console
  • Securing Messages Exchanged Between the Coordinator and Participant
  • Enabling and Configuring Web Services Atomic Transactions
• Using Web Services Atomic Transactions in a Clustered Environment
• More Examples of Using Web Services Atomic Transactions

11 Publishing a Web Service Endpoint

12 Using Callbacks

• Overview of Callbacks
• Example Callback Implementation
• Steps to Program Callbacks
• Programming Guidelines for Target Web Service
• Programming Guidelines for the Callback Client Web Service
• Programming Guidelines for the Callback Web Service
• Updating the build.xml File for the Target Web Service

13 Optimizing Binary Data Transmission

• Optimizing Binary Data Transmission Using MTOM/XOP
  • Annotating the Data Types
    • Annotating the Data Types: Start From Java
    • Annotating the Data Types: Start From WSDL
  • Enabling MTOM on the Web Service
    • Enabling MTOM on the Web Service Using Annotation
    • Enabling MTOM on the Web Services Using WS-Policy File
  • Enabling MTOM on the Client
  • Setting the Attachment Threshold
• Streaming SOAP Attachments
  • Client Side Example
  • Server Side Example
  • Configuring Streaming SOAP Attachments
    • Configuring Streaming SOAP Attachments on the Server
    • Configuring Streaming SOAP Attachments on the Client
• Sending SOAP Messages With Attachments Using swaRef

14 Developing Dynamic Proxy Clients

• Overview of Static Versus Dynamic Proxy Clients
• Steps to Develop a Dynamic Proxy Client
• Additional Considerations When Specifying WSDL Location

15 Using XML Catalogs

• Overview of XML Catalogs
• Defining and Referencing XML Catalogs
  • Defining an External XML Catalog
    • Creating an External XML Catalog File
    • Referencing the External XML Catalog File
  • Embedding an XML Catalog
    • Creating an Embedded XML Catalog
    • Referencing an Embedded XML Catalog
• Disabling XML Catalogs in the Client Runtime
• Getting a Local Copy of XML Resources

16 Handling Exceptions Using SOAP Faults

• Overview of Exception Handling Using SOAP Faults
• Contents of the SOAP Fault Element
  • SOAP 1.2 <Fault> Element Contents
  • SOAP 1.1 <Fault> Element Contents
• Using Modeled Faults
  • Creating and Using a Custom Exception
  • How Modeled Faults are Mapped in the WSDL File
  • How the Fault is Communicated in the SOAP Message
  • Creating the Web Service Client
    • Reviewing the Generated Java Exception Class
    • Reviewing the Generated Java Fault Bean Class
    • Reviewing the Client-side Service Implementation
    • Creating the Client Implementation Class
• Using Unmodeled Faults
• Customizing the Exception Handling Process
• Disabling the Stack Trace from the SOAP Fault
• Other Exceptions

17 Creating and Using SOAP Message Handlers

• Overview of SOAP Message Handlers
• Adding Server-side SOAP Message Handlers: Main Steps
• Adding Client-side SOAP Message Handlers: Main Steps
• Designing the SOAP Message Handlers and Handler Chains
  • Server-side Handler Execution
  • Client-side Handler Execution
• Creating the SOAP Message Handler
  • Example of a SOAP Handler
  • Example of a Logical Handler
  • Implementing the Handler.handleMessage() Method
  • Implementing the Handler.handleFault() Method
  • Implementing the Handler.close() Method
  • Using the Message Context Property Values and Methods
  • Directly Manipulating the SOAP Request and Response Message Using SAAJ
    • The SOAPPart Object
    • The AttachmentPart Object
    • Manipulating Image Attachments in a SOAP Message Handler
• Configuring Handler Chains in the JWS File
• Creating the Handler Chain Configuration File
• Compiling and Rebuilding the Web Service
• Configuring the Client-side SOAP Message Handlers

18 Sending and Receiving SOAP Headers

• Overview of Sending and Receiving SOAP Headers
• Sending SOAP Headers Using WSBindingProvider
• Receiving SOAP Headers Using WSBindingProvider

19 Operating at the XML Message Level

• Overview of Web Service Provider-based Endpoints and Dispatch Clients
• Usage Modes and Message Formats for Operating at the XML Level
• Developing a Web Service Provider-based Endpoint (Starting from Java)
  • Developing a Synchronous Provider-based Endpoint
  • Developing an Asynchronous Provider-based Endpoint
  • Specifying the Message Format
  • Specifying that the JWS File Implements a Web Service Provider (@WebServiceProvider Annotation)
  • Specifying the Usage Mode (@ServiceMode Annotation)
  • Defining the invoke() Method for a Synchronous Provider-based Endpoints
  • Defining the invoke() Method for an Asynchronous Provider-based Endpoints
  • Defining the Callback Handler for the Asynchronous Provider-based Endpoint
• Developing a Web Service Provider-based Endpoint (Starting from WSDL)
• Using SOAP Handlers with Provider-based Endpoints
• Developing a Web Service Dispatch Client
  • Example of a Web Service Dispatch Client
  • Creating a Dispatch Instance
  • Invoking a Web Service Operation

20 Programming RESTful Web Services

• Overview of RESTful Web Services
• Using the Jersey JAX-RS Reference Implementation
  • Summary of the Jersey JAX-RS RI Shared Libraries
  • Steps to Use the Jersey JAX-RS RI Shared Libraries
    • Registering the Jersey JAX-RS RI Shared Libraries With Your WebLogic Server Instances
    • Configuring the Web Application to Use the Jersey JAX-RS RI
    • Creating JAX-RS Web Services and Clients
    • Securing the Jersey Servlet Application
  • Registering a More Recent Version of the Jersey JAX-RS RI
• Programming Web Services Using XML Over HTTP
  • Programming Guidelines for the Web Service Using XML Over HTTP
  • Accessing the Web Service from a Client
  • Securing Web Services that Use XML Over HTTP

21 Programming Stateful JAX-WS Web Services Using HTTP Session

• Overview of Stateful Web Services
• Accessing HTTP Session on the Server
• Enabling HTTP Session on the Client
• Developing Stateful Services in a Cluster Using Session State Replication
• A Note About the JAX-WS RI @Stateful Extension

22 Publishing and Finding Web Services Using UDDI

• Overview of UDDI
  • UDDI and Web Services
  • UDDI and Business Registry
  • UDDI Data Structure
• WebLogic Server UDDI Features
• UDDI 2.0 Server
  • Configuring the UDDI 2.0 Server
  • Configuring an External LDAP Server
    • 51acumen.ldif File Contents
  • Description of Properties in the uddi.properties File
• UDDI Directory Explorer
• UDDI Client API
• Pluggable tModel
  • XML Elements and Permissible Values
  • XML Schema for Pluggable tModels
  • Sample XML for a Pluggable tModel

A Pre-packaged WS-Policy Files for Web Services Reliable Messaging and Make Connection

• DefaultReliability1.2.xml (WS-Policy File)
• DefaultReliability1.1.xml (WS-Policy File)
• DefaultReliability.xml WS-Policy File (WS-Policy) [Deprecated]
• LongRunningReliability.xml WS-Policy File (WS-Policy) [Deprecated]
• Mc1.1.xml (WS-Policy File)
• Mc.xml (WS-Policy File)
• Reliability1.2_ExactlyOnce_WithMC1.1.xml (WS-Policy File)
• Reliability1.2_SequenceSTR.xml (WS-Policy File)
• Reliability1.1_SequenceSTR.xml (WS-Policy File)
• Reliability1.2_SequenceTransportSecurity.xml (WS-Policy File)
• Reliability1.1_SequenceTransportSecurity.xml (WS-Policy File)
• Reliability1.0_1.2.xml (WS-Policy File)
• Reliability1.0_1.1.xml (WS-Policy.xml File)

B Example Client Wrapper Class for Batching Reliable Messages