Home / Middleware / Oracle WebLogic Server

Contents

Title and Copyright Information

Preface

• Documentation Accessibility
• Conventions

What's New in This Guide

• New and Changed Features for Release 12c (12.1.2)

Part I Introduction

1 Introduction to JAX-RPC Web Services

2 Examples for JAX-RPC Web Service Developers

• Creating a Simple HelloWorld Web Service
  • Sample HelloWorldImpl.java JWS File
  • Sample Ant Build File for HelloWorldImpl.java
• Creating a Web Service With User-Defined Data Types
  • Sample BasicStruct JavaBean
  • Sample ComplexImpl.java JWS File
  • Sample Ant Build File for ComplexImpl.java JWS File
• Creating a Web Service from a WSDL File
  • Sample WSDL File
  • Sample TemperaturePortType Java Implementation File
  • Sample Ant Build File for TemperatureService
• Invoking a Web Service from a Java SE Client
  • Sample Java Client Application
  • Sample Ant Build File For Building Java Client Application
• Invoking a Web Service from a WebLogic Web Service
  • Sample ClientServiceImpl.java JWS File
  • Sample Ant Build File For Building ClientService

Part II Developing Basic JAX-RPC Web Services

3 Developing JAX-RPC Web Services

• Overview of the WebLogic Web Service Programming Model
• Configuring Your Domain For Web Services Features
• Developing WebLogic Web Services Starting From Java: Main Steps
• Developing WebLogic Web Services Starting From a WSDL File: Main Steps
• Creating the Basic Ant build.xml File
• Running the jwsc WebLogic Web Services Ant Task
  • Specifying the Transport Used to Invoke the Web Service
  • Defining the Context Path of a WebLogic Web Service
  • Examples of Using jwsc
• Running the wsdlc WebLogic Web Services Ant Task
• Updating the Stubbed-out JWS Implementation Class File Generated By wsdlc
• Deploying and Undeploying WebLogic Web Services
  • Using the wldeploy Ant Task to Deploy Web Services
  • Using the Administration Console to Deploy Web Services
• Browsing to the WSDL of the Web Service
• Configuring the Server Address Specified in the Dynamic WSDL
  • Web Service is not a callback service and can be invoked using HTTP/S
  • Web Service is not a callback service and can be invoked using JMS Transport
  • Web Service is a callback service
  • Web Service is invoked using a proxy server
• Testing the Web Service
• Integrating Web Services Into the WebLogic Split Development Directory Environment

4 Programming the JWS File

• Overview of JWS Files and JWS Annotations
• Java Requirements for a JWS File
• Programming the JWS File: Typical Steps
  • Example of a JWS File
  • Specifying that the JWS File Implements a Web Service (@WebService Annotation)
  • Specifying the Mapping of the Web Service to the SOAP Message Protocol (@SOAPBinding Annotation)
  • Specifying the Context Path and Service URI of the Web Service (@WLHttpTransport Annotation)
  • Specifying That a JWS Method Be Exposed as a Public Operation (@WebMethod and @OneWay Annotations)
  • Customizing the Mapping Between Operation Parameters and WSDL Elements (@WebParam Annotation)
  • Customizing the Mapping Between the Operation Return Value and a WSDL Element (@WebResult Annotation)
• Accessing Run-Time Information About a Web Service
  • Using JwsContext to Access Run-Time Information
    • Guidelines for Accessing the Web Service Context
    • Methods of the JwsContext
  • Using the Stub Interface to Access Run-Time Information
• Should You Implement a Stateless Session EJB?
  • Programming Guidelines When Implementing an EJB in Your JWS File
  • Example of a JWS File That Implements an EJB
• Programming the User-Defined Java Data Type
• Throwing Exceptions
• Invoking Another Web Service from the JWS File
• Programming Additional Miscellaneous Features Using JWS Annotations and APIs
  • Sending Binary Data Using MTOM/XOP
  • Streaming SOAP Attachments
  • Using SOAP 1.2
  • Specifying that Operations Run Inside of a Transaction
  • Getting the HttpServletRequest/Response Object
• JWS Programming Best Practices

5 Understanding Data Binding

• Overview of Data Binding
• Supported Built-In Data Types
  • XML-to-Java Mapping for Built-in Data Types
  • Java-to-XML Mapping for Built-In Data Types
• Supported User-Defined Data Types
  • Supported XML User-Defined Data Types
  • Supported Java User-Defined Data Types

6 Developing JAX-RPC Web Service Clients

• Overview of JAX-RPC Web Service Clients
  • Invoking Web Services Using JAX-RPC
  • Examples of Clients That Invoke Web Services
• Invoking a Web Service from a Java SE Client
  • Using the clientgen Ant Task To Generate Client Artifacts
  • Getting Information About a Web Service
  • Writing the Java Client Application Code to Invoke a Web Service
  • Compiling and Running the Client Application
  • Sample Ant Build File for a Java Client
• Invoking a Web Service from Another Web Service
  • Sample build.xml File for a Web Service Client
  • Sample JWS File That Invokes a Web Service
• Using a Standalone Client JAR File When Invoking Web Services
• Using a Proxy Server When Invoking a Web Service
  • Using the HttpTransportInfo API to Specify the Proxy Server
  • Using System Properties to Specify the Proxy Server
• Client Considerations When Redeploying a Web Service
• WebLogic Web Services Stub Properties
• Setting the Character Encoding For the Response SOAP Message

Part III Developing Advanced Features of JAX-RPC Web Services

7 Invoking a Web Service Using Asynchronous Request-Response

• Overview of the Asynchronous Request-Response Feature
• Using Asynchronous Request-Response: Main Steps
• Configuring the Host WebLogic Server Instance for the Asynchronous Web Service
• Writing the Asynchronous JWS File
  • Coding Guidelines for Invoking a Web Service Asynchronously
  • Using Asynchronous Pre- and Post-call Contexts
  • Example of a Synchronous Invoke
• Updating the build.xml File When Using Asynchronous Request-Response
• Disabling The Internal Asynchronous Service
• Using Asynchronous Request Response With a Proxy Server

8 Using Web Services Reliable Messaging

• Overview of Web Service Reliable Messaging
  • Using WS-Policy to Specify Reliable Messaging Policy Assertions
  • Managing the Life Cycle of the Reliable Message Sequence
• Using Web Service Reliable Messaging: Main Steps
  • Prerequisites
• Configuring the Destination WebLogic Server Instance
• Configuring the Source WebLogic Server Instance
• Creating the Web Service Reliable Messaging WS-Policy File
  • Creating a Custom WS-Policy File Using WS-ReliableMessaging Policy Assertions Version 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
  • Using the @Policy Annotation
  • Using the @Oneway Annotation
  • Using the @BufferQueue Annotation
  • Using the @ReliabilityBuffer Annotation
• Configuring Reliable Messaging for a Reliable Web Service
  • Using the Administration Console
  • Using WLST
• Programming Guidelines for the JWS File That Invokes a Reliable Web Service
• Updating the build.xml File for a Client of a Reliable Web Service
• Using Reliable Messaging With MTOM
• Client Considerations When Redeploying a Reliable Web Service
• Using Reliable Messaging With a Proxy Server

9 Creating Conversational Web Services

• Overview of Conversational Web Services
• Creating a Conversational Web Service: Main Steps
• Programming Guidelines for the Conversational JWS File
• Programming Guidelines for the JWS File That Invokes a Conversational Web Service
• ConversationUtils Utility Class
• Updating the build.xml File for a Client of a Conversational Web Service
• Updating a Stand-Alone Java Client to Invoke a Conversational Web Service
• Example Conversational Web Service .NET Client
  • ConversationService.java File
  • Service.cs File
  • build.xml File
• Client Considerations When Redeploying a Conversational Web Service

10 Creating Buffered Web Services

• Overview of Buffered Web Services
• Creating a Buffered Web Service: Main Steps
• Configuring the Host WebLogic Server Instance for the Buffered Web Service
• Programming Guidelines for the Buffered JWS File
• Programming the JWS File That Invokes the Buffered Web Service
• Updating the build.xml File for a Client of the Buffered Web Service

11 Using the Asynchronous Features Together

• Using the Asynchronous Features Together
• Example of a JWS File That Implements a Reliable Conversational Web Service
• Example of Client Web Service That Asynchronously Invokes a Reliable Conversational Web Service

12 Using Callbacks to Notify Clients of Events

• Overview of Callbacks
• Callback Implementation Overview and Terminology
• Programming Callbacks: Main Steps
• Programming Guidelines for Target Web Service
• Programming Guidelines for the Callback Client Web Service
• Programming Guidelines for the Callback Interface
• Updating the build.xml File for the Client Web Service

13 Using JMS Transport as the Connection Protocol

• Overview of Using JMS Transport
• Using JMS Transport Starting From Java: Main Steps
• Using JMS Transport Starting From WSDL: Main Steps
• Configuring the Host WebLogic Server Instance for the JMS Transport Web Service
• Using the @WLJmsTransport JWS Annotation
• Using the <WLJmsTransport> Child Element of the jwsc Ant Task
• Updating the WSDL to Use JMS Transport
• Invoking a WebLogic Web Service Using JMS Transport
  • Overriding the Default Service Address URL
  • Using JMS BytesMessage Rather Than the Default TextMessage
  • Disabling HTTP Access to the WSDL File

14 Creating and Using SOAP Message Handlers

• Overview of SOAP Message Handlers
• Adding SOAP Message Handlers to a Web Service: Main Steps
• Designing the SOAP Message Handlers and Handler Chains
• Creating the GenericHandler Class
  • Implementing the Handler.init() Method
  • Implementing the Handler.destroy() Method
  • Implementing the Handler.getHeaders() Method
  • Implementing the Handler.handleRequest() Method
  • Implementing the Handler.handleResponse() Method
  • Implementing the Handler.handleFault() Method
  • 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 Handlers in the JWS File
  • @javax.jws.HandlerChain
  • @javax.jws.soap.SOAPMessageHandlers
• Creating the Handler Chain Configuration File
• Compiling and Rebuilding the Web Service
• Creating and Using Client-Side SOAP Message Handlers
  • Using Client-Side SOAP Message Handlers: Main Steps
  • Example of a Client-Side Handler Class
  • Creating the Client-Side SOAP Handler Configuration File
  • XML Schema for the Client-Side Handler Configuration File
  • Specifying the Client-Side SOAP Handler Configuration File to clientgen

15 Using Database Web Services

• Overview of Database Web Services
  • Database Call-in
  • Database Call-out
• Type Mapping Between SQL and XML
  • SQL to XML Type Mappings for Web Service Call-Ins
  • XML-to-SQL Type Mapping for Web Service Call-outs

A Pre-Packaged WS-Policy Files for Reliable Messaging

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