2 Development and Documentation Roadmap

The following sections provide a suggested roadmap through the documentation that takes you through the steps of developing a Web service.

• Setting Up Your Environment

• Best Coding Practices

• Assembling Web Service Artifacts

• Deploying the Web Service

• Testing the Deployed Web Service

• Assembling a Web Service Client

• Adding Quality of Service Features to a Web Service

• Adding Advanced Functionality to a Web Service

• Alternative Web Service Strategies

• Reference Chapters and Appendixes

Setting Up Your Environment

The following chapter describes how to set up your environment to use the functionality provided by OracleAS Web Services.

• Chapter 4, "Getting Started"

Best Coding Practices

The chapters in this section describe issues that you should consider as you design your Web service.

The following chapter describes the varieties of message formats that you can employ in OracleAS Web Services. It describes the advantages and disadvantages of each message format and suggests which format to use based on the client functionality.

• Chapter 5, "OracleAS Web Services Messages"

The following chapter in the Oracle Application Server Advanced Web Services Developer's Guide identifies some of the common areas where interoperability problems can occur. It provides design suggestions and programming guidelines that increase the interoperability of your Web service with applications on different platforms.

• "Ensuring Interoperable Web Services"

Assembling Web Service Artifacts

OracleAS Web Services enables you to assemble Web service artifacts bottom up starting from Java classes, EJBs, JMS destinations, database resources, or source files which employ J2SE 5.0 JDK Web Service Annotations. You can also assemble the artifacts top down starting from a WSDL. In OracleAS Web Services, you use the WebServicesAssembler tool to perform the assembly. Chapter 18, "Using WebServicesAssembler" provides a reference guide to the tool.

The following chapters describe how to use the WebServicesAssembler tool to perform the different types of Web Service assembly supported by OracleAS Web Services.

• Chapter 6, "Assembling a Web Service from WSDL"

• Chapter 7, "Assembling a Web Service with Java Classes"

• Chapter 8, "Assembling a Web Service with EJBs"

• Chapter 9, "Assembling Web Services with JMS Destinations"

• Chapter 10, "Assembling Database Web Services"

• Chapter 11, "Assembling Web Services with Annotations"

Deploying the Web Service

While the WebServicesAssembler tool does not perform deployment, it does package the Web service into a deployable EAR or WAR file. Deploying this file is very similar to deploying any other EAR or WAR file into a running instance of OC4J. OC4J provides a separate book that describes how to perform deployment.

• Oracle Containers for J2EE Deployment Guide

The following chapter provides additional information about the packaging format and the files required for deployment. The chapter also briefly describes the deployment support offered by the Oracle JDeveloper and Application Server Control tools.

• Chapter 19, "Packaging and Deploying Web Services"

Testing the Deployed Web Service

The following chapter describes the Web Service Test Page. This page lets you test whether deployment was successful without the need to write any code.

• Chapter 13, "Testing Web Services Deployment"

Assembling a Web Service Client

The following chapters describe how to use WebServicesAssembler to assemble a Web service client for the J2SE and J2EE platforms.

• Chapter 14, "Assembling a J2EE Web Service Client"

• Chapter 15, "Assembling a J2SE Web Service Client"

Adding Quality of Service Features to a Web Service

OracleAS Web Services support quality of service features, such as security, reliability, message logging, and auditing. The following chapters describe how to implement these features; they can be managed by other tools such as Oracle JDeveloper and Application Server Control. The following chapters appear in the Oracle Application Server Advanced Web Services Developer's Guide.

• "Managing Web Services"

• "Ensuring Web Services Security"

  This chapter provides only an overview of the contents of the Oracle Application Server Web Services Security Guide. The Security Guide describes the Web Services implementation of message-level security.

• "Ensuring Web Service Reliability"

• "Auditing and Logging Messages"

Adding Advanced Functionality to a Web Service

The following chapters describe additional features that can enhance the performance and functionality of your Web service.

• Chapter 16, "Using JAX-RPC Handlers"

• Chapter 17, "Processing SOAP Headers"

See also the following chapters in the Oracle Application Server Advanced Web Services Developer's Guide.

• "Working with Message Attachments"

• "Custom Serialization of Java Value Types"

Alternative Web Service Strategies

The following chapters describe alternative modes of Web service implementation.

For example, you can write your own infrastructure to make Web service calls, create a client for non-SOAP protocols, or use a non-HTTP transport mechanism.

• Chapter 12, "Assembling REST Web Services"

See also the following chapters in the Oracle Application Server Advanced Web Services Developer's Guide.

• "Using JMS as a Web Service Transport"

• "Using Web Service Invocation Framework"

• "Using Web Service Providers"

Reference Chapters and Appendixes

The following chapters and appendixes provide information to supplement the implementation and development tasks described in this book.

• Chapter 1, "Web Services Overview"

• Chapter 3, "OracleAS Web Services Architecture and Life Cycle"

• Chapter 18, "Using WebServicesAssembler"

• Appendix A, "Web Service Client APIs and JARs"

• Appendix B, "Oracle Implementation of the WSDL 1.1 API"

• Appendix C, "oracle-webservices.xml Deployment Descriptor Schema"

• Appendix D, "service-ref-mapping Schema"

• Appendix E, "Error Message Prefixes"

See also the following reference chapters and appendixes in the Oracle Application Server Advanced Web Services Developer's Guide.

• "Understanding the WSMGMT Schema"

• "OracleAS Web Services Client Schema"

• "OracleAS Web Services Reliability Schema"

• "OracleAS Web Services Auditing Schema"

• "OracleAS Web Services Tracing Schema"

• "JAX-RPC Mapping File Descriptor"

• "Web Service MBeans"

• "Mapping Java Types to XML and WSDL Types"