Support Readiness Document Java™ API for XML

Support Readiness Document
Java™ API for XML-Based Remote
Procedure Call, Version 1.0_01
Sun Microsystems, Inc.
4150 Network Circle
Santa Clara, CA 95054 U.S.A.
650-960-1300
December 2002
Copyright 2002 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All rights reserved.
Sun Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In
particular, and without limitation, these intellectual property rights may include one or more of the U.S. patents listed at
http://www.sun.com/patents and one or more additional patents or pending patent applications in the U.S. and in other countries.
This document and the product to which it pertains are distributed under licenses restricting their use, copying, distribution, and
decompilation. No part of the product or of this document may be reproduced in any form by any means without prior written authorization of
Sun and its licensors, if any.
Third-party software, including font technology, is copyrighted and licensed from Sun suppliers.
Parts of the product may be derived from Berkeley BSD systems, licensed from the University of California. UNIX is a registered trademark in
the U.S. and in other countries, exclusively licensed through X/Open Company, Ltd.
Sun, Sun Microsystems, the Sun logo, Sun ONE Application Server, Sun ONE Studio, Java, Java 2 Platform, J2SE, Java 2 Enterprise Edition,
J2EE, Java 2 SDK, JavaServer Pages, Java Development Kit, JDK, Java Web Services Developer Pack, AnswerBook2, docs.sun.com, and Solaris are
trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and in other countries.
All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and in other
countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc.
The OPEN LOOK and Sun™ Graphical User Interface was developed by Sun Microsystems, Inc. for its users and licensees. Sun acknowledges
the pioneering efforts of Xerox in researching and developing the concept of visual or graphical user interfaces for the computer industry. Sun
holds a non-exclusive license from Xerox to the Xerox Graphical User Interface, which license also covers Sun’s licensees who implement OPEN
LOOK GUIs and otherwise comply with Sun’s written license agreements.
U.S. Government Rights—Commercial use. Government users are subject to the Sun Microsystems, Inc. standard license agreement and
applicable provisions of the FAR and its supplements.
DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT,
ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.
Copyright 2002 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, Etats-Unis. Tous droits réservés.
Sun Microsystems, Inc. a les droits de propriété intellectuels relatants à la technologie incorporée dans le produit qui est décrit dans ce
document. En particulier, et sans la limitation, ces droits de propriété intellectuels peuvent inclure un ou plus des brevets américains énumérés à
http://www.sun.com/patents et un ou les brevets plus supplémentaires ou les applications de brevet en attente dans les Etats-Unis et dans les
autres pays.
Ce produit ou document est protégé par un copyright et distribué avec des licences qui en restreignent l’utilisation, la copie, la distribution, et la
décompilation. Aucune partie de ce produit ou document ne peut être reproduite sous aucune forme, parquelque moyen que ce soit, sans
l’autorisation préalable et écrite de Sun et de ses bailleurs de licence, s’il y ena.
Le logiciel détenu par des tiers, et qui comprend la technologie relative aux polices de caractères, est protégé par un copyright et licencié par des
fournisseurs de Sun.
Des parties de ce produit pourront être dérivées des systèmes Berkeley BSD licenciés par l’Université de Californie. UNIX est une marque
déposée aux Etats-Unis et dans d’autres pays et licenciée exclusivement par X/Open Company, Ltd.
Sun, Sun Microsystems, le logo Sun, Sun ONE Application Server, Sun ONE Studio, Java, Java 2 Platform, J2SE, Java 2 Enterprise Edition, J2EE,
Java 2 SDK, JavaServer Pages, Java Development Kit, JDK, Java Web Services Developer Pack, AnswerBook2, docs.sun.com, et Solaris sont des
marques de fabrique ou des marques déposées de Sun Microsystems, Inc. aux Etats-Unis et dans d’autres pays.
Toutes les marques SPARC sont utilisées sous licence et sont des marques de fabrique ou des marques déposées de SPARC International, Inc.
aux Etats-Unis et dans d’autres pays. Les produits protant les marques SPARC sont basés sur une architecture développée par Sun
Microsystems, Inc.
L’interface d’utilisation graphique OPEN LOOK et Sun™ a été développée par Sun Microsystems, Inc. pour ses utilisateurs et licenciés. Sun
reconnaît les efforts de pionniers de Xerox pour la recherche et le développment du concept des interfaces d’utilisation visuelle ou graphique
pour l’industrie de l’informatique. Sun détient une license non exclusive do Xerox sur l’interface d’utilisation graphique Xerox, cette licence
couvrant également les licenciées de Sun qui mettent en place l’interface d ’utilisation graphique OPEN LOOK et qui en outre se conforment aux
licences écrites de Sun.
LA DOCUMENTATION EST FOURNIE "EN L’ÉTAT" ET TOUTES AUTRES CONDITIONS, DECLARATIONS ET GARANTIES EXPRESSES
OU TACITES SONT FORMELLEMENT EXCLUES, DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS NOTAMMENT
TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE, A L’APTITUDE A UNE UTILISATION PARTICULIERE OU A
L’ABSENCE DE CONTREFAÇON.
Please
Recycle
Contents
Preface
1.
3
JAX-RPC Overview 1
1.1
Overview
1.2
Features, Advantages, and Benefits
1.2.1
2.
3.
4.
1
Benefits
2
2
1.3
Product Limitations
2
1.4
Introduction to JAX-RPC
1.5
Other Introductory Material
1.6
Specialized Terminology
3
3
3
Product Changes for Version 1.0_01 5
2.1
Changes and New Features in Version 1.0_01
5
2.2
Previous Versions of JAX-RPC
2.3
Backward and Forward Compatibility With Other Versions
5
5
Using and Supporting JAX-RPC 6
3.1
User’s Guides and Tutorials
6
3.2
Using JAX-RPC in a Development Environment
3.3
Localization and Internationalization
6
6
Code Samples 8
Contents
1
5.
Troubleshooting 9
5.1
6.
Installation and Uninstallation Issues
5.1.1
Product Distribution
5.1.2
Product Licensing
9
9
9
5.2
Configuration and Administration Issues
5.3
Troubleshooting Utilities
9
10
Reference Information 11
6.1
Product Information
11
6.2
Technical Documentation
6.3
Frequently Asked Questions
6.4
Tutorials and Other References
11
11
12
Contents
2
Preface
This document provides support readiness information for the Java
Application Programming Interface (API) for eXtensible Markup Language
(XML)-based (JAX) Remote Procedure Call (RPC), Version 1.0_01 (JAX-RPC).
This document is not designed to provide comprehensive product training.
Instead, it focuses on issues immediately relevant to support, such as changes in
this version of the product, using and troubleshooting the product, and
installing and configuring the product. For pointers to other documentation, see
Section 6 “Reference Information.”
Preface
3
1
JAX-RPC Overview
The following document may contain actual software programs in source code
form. This source code is made available for developers to use as needed,
pursuant to the terms and conditions of this license located at:
http://access1.sun.com/SRDs/BSD.html
1.1
Overview
JAX-RPC is an API for building Web services and clients that use remote
procedure calls (RPC) and XML. Often used in a distributed client/server
model, an RPC mechanism enables clients to execute procedures on other
systems. In JAX-RPC, a remote procedure call is represented by an XML-based
protocol, such as Simple Object Access Protocol (SOAP). The SOAP specification
defines envelope structure, encoding rules, and a convention for representing
remote procedure calls and responses. These calls and responses are transmitted
as SOAP messages over HTTP. In this release, JAX-RPC relies on SOAP, v. 1.1,
and HTTP, v. 1.1.
Although JAX-RPC relies on complex protocols, the API hides this complexity
from the application developer. On the server side, the developer specifies the
remote procedures by defining methods in an interface written in the Java
programming language. The developer also codes one or more classes that
implements those methods. Client programs are also easy to code. A client
creates a proxy, a local object representing the service, and then invokes
methods on the proxy.
The JAX-RPC enables Java technology developers to build Web applications and
Web services, incorporating XML-based RPC functionality according to the
SOAP, v. 1.1, specification.
By using JAX-RPC, Java programming language developers can rapidly achieve
Web services interoperability based on widely adopted standards and protocols.
JAX-RPC Overview
Sun Microsystems, Inc.
1 of 12
The JAX-RPC FAQ is located at:
http://java.sun.com/xml/jaxrpc/faq.html
The product home page, including the product road map, is located at:
http://java.sun.com/xml/jaxrpc/index.html
1.2
Features, Advantages, and Benefits
Some of the key features are:
■
■
■
■
1.2.1
Mapping of XML to Java programming language type and vice versa.
Use of Web Service Description Language (WSDL) for describing network
services as a set of endpoints operating on messages containing either
document-oriented or procedure-oriented information.
The ability to have its end point run in a Java Platform, Enterprise Edition,
(J2EE) container.
Use of SOAP, v. 1.1.
Benefits
With JAX-RPC, clients and Web services have a big advantage--the platform
independence of the Java programming language. In addition, JAX-RPC is not
restrictive: a JAX-RPC client can access a Web service that is not running on the
Java platform and vice versa. This flexibility is possible because JAX-RPC uses
technologies defined by the World Wide Web Consortium (W3C): HTTP, SOAP,
and the WSDL. WSDL specifies an XML format for describing a service as a set
of endpoints operating on messages.
1.3
Product Limitations
The following are the product limitations for this release:
■
■
■
■
Namespace-to-package mapping is not supported for dynamic proxies.
Inner classes must be static.
There is no support for GIF encoding as part of attachments. However,
decoding is supported.
The gen:client and gen:both options of wscompile will fail if the service
name in the configuration file, the package name, and the interface name are
identical.
JAX-RPC Overview
Sun Microsystems, Inc.
2 of 12
1.4
Introduction to JAX-RPC
The tutorial for JAX-RPC is located at:
http://java.sun.com/webservices/docs/1.0/tutorial/doc/
JAXRPC.html
The downloads and specification for JAX-RPC are located at:
http://java.sun.com/xml/downloads/jaxrpc.html#jaxrpcspec10
The Java Specification Request (“JSR”) for JAX-RPC is located at:
http://jcp.org/aboutJava/communityprocess/first/jsr101/
The FAQ for JAX-RPC is located at:
http://java.sun.com/xml/jaxrpc/faq.html
1.5
Other Introductory Material
JSR 101: Java APIs to support emerging industry XML-based RPC standards is
located at:
http://www.jcp.org/jsr/detail/101.jsp
JAX-RPC fits in with J2EE, v. 1.4. Please read the following JSR for more details:
http://www.jcp.org/jsr/detail/109.jsp
1.6
Specialized Terminology
Web Services Definition Language (WSDL): An XML format for describing
network services as a set of end points operating on messages containing either
document-oriented or procedure-oriented information. A complete description
is available at:
http://www.w3.org/TR/wsdl12/
Web Services: A services-on-demand model in which your software Internet
infrastructure is able to provide information, data, and applications to anyone,
anytime, anywhere on anything.
eXtensible Markup Language (XML): A tag-based markup language.
Simple Object Access Protocol (SOAP): A lightweight protocol intended for
exchanging structured information in a decentralized, distributed environment.
JAX-RPC Overview
Sun Microsystems, Inc.
3 of 12
For more terms, the glossary is located at:
http://java.sun.com/webservices/docs/1.0/tutorial/doc/
Glossary.html#21675
JAX-RPC Overview
Sun Microsystems, Inc.
4 of 12
2
Product Changes for Version 1.0_01
2.1
Changes and New Features in Version 1.0_01
JAX-RPC is included in J2EE, v. 1.4; the Java WSDP, v. 1.0_01; the Sun ONE
Application Server; and the Sun ONE Studio developer tools.
The WSDP release notes are located at:
http://java.sun.com/webservices/docs/1.0/ReleaseNotes.html
The JAX-RPC release notes are located at:
http://java.sun.com/webservices/docs/1.0/jaxrpc/
ReleaseNotes.html
2.2
Previous Versions of JAX-RPC
Information about JAX-RPC and documentation can be downloaded at:
http://java.sun.com/xml/downloads/jaxrpc.html
2.3
Backward and Forward Compatibility With
Other Versions
Files created with an earlier version of the product work with the current
version.
Product Changes for Version 1.0_01
Sun Microsystems, Inc.
5 of 12
3
Using and Supporting JAX-RPC
3.1
User’s Guides and Tutorials
The tutorial for JAX-RPC is located at:
http://java.sun.com/webservices/docs/1.0/tutorial/doc/
JAXRPC.html
The documentation for JAX-RPC is located at:
http://java.sun.com/xml/jaxrpc/docs.html
3.2
Using JAX-RPC in a Development
Environment
Documentation, specification, and APIs can be downloaded at:
http://java.sun.com/xml/downloads/jaxrpc.html
The documentation for JAX-RPC is located at:
http://java.sun.com/webservices/docs.html
The Release Notes for JAX-RPC are located at:
http://java.sun.com/webservices/docs/1.0/jaxrpc/
ReleaseNotes.html
3.3
Localization and Internationalization
The exceptions are currently localized for English only. They can be found at:
com/sun/xml/rpc/sp/resources/
Using and Supporting JAX-RPC
Sun Microsystems, Inc.
6 of 12
JAX-RPC received an I18N/L10N waiver for the Java Web Services Developer
Pack (WSDP), v. 1.0, release.
Using and Supporting JAX-RPC
Sun Microsystems, Inc.
7 of 12
4
Code Samples
The following section may contain actual software programs in source code
form. This source code is made available for developers to use as needed,
pursuant to the terms and conditions of this license located at:
http://access1.sun.com/SRDs/BSD.html
Code samples are available at:
http://java.sun.com/webservices/docs/1.0/tutorial/doc/
JAXRPC.html
The JAX-RPC code examples are not in the software download bundle. Instead,
they are in a separate download bundle that contains the Java Web Services
Tutorial located at:
http://java.sun.com/webservices/download.html
Code Samples
Sun Microsystems, Inc.
8 of 12
5
Troubleshooting
5.1
Installation and Uninstallation Issues
There are no known issues other than those covered in the Installation Guide
and release notes, which are located at:
http://java.sun.com/webservices/docs/1.0/ReleaseNotes.html
5.1.1
Product Distribution
The download site for the current version of the product is located at:
http://java.sun.com/webservices/download.html
5.1.2
Product Licensing
JAX-RPC is available with the Java WSDP. All rules and licensing agreements of
the Java WSDP apply.
5.2
Configuration and Administration Issues
The most common configuration issue is using the correct Java Development
Kit (JDK) software. JAX-RPC should be used with JDK, v. 1.3.1_02 or above.
More details can be found on the Java platform forum located at:
http://forums.java.sun.com/forum.jsp?forum=331
Troubleshooting
Sun Microsystems, Inc.
9 of 12
5.3
Troubleshooting Utilities
Information on the troubleshooting utilities in JAX-RPC can be found in the
Release Notes located at:
http://java.sun.com/webservices/docs/1.0/ReleaseNotes.html
Troubleshooting
Sun Microsystems, Inc.
10 of 12
6
Reference Information
6.1
Product Information
■
JAX-RPC Home Page:
http://java.sun.com/xml/jaxrpc/index.html
6.2
Technical Documentation
■
JAX-RPC User’s Guide:
http://java.sun.com/xml/jaxrpc/docs.html
■
API Guide for JAX-RPC:
http://java.sun.com/webservices/docs/1.0/api/index.html
http://java.sun.com/xml/downloads/jaxrpc.html#jaxrpcdocs10
■
WSDL, v. 1.2, Specification:
http://www.w3.org/TR/wsdl12/
■
JSR for Web Services for J2EE, v. 1.4:
http://www.jcp.org/jsr/detail/109.jsp
■
Release Notes on JAX-RPC:
http://java.sun.com/webservices/docs/1.0/jaxrpc/
ReleaseNotes.html
6.3
Frequently Asked Questions
■
Description of FAQ
http://java.sun.com/xml/jaxrpc/faq.html
Reference Information
Sun Microsystems, Inc.
11 of 12
■
JDC Forum Archive for JAX-RPC
http://forums.java.sun.com/forum.jsp?forum=331
■
Glossary of Web Services Terms
http://java.sun.com/webservices/docs/1.0/tutorial/doc/
Glossary.html#21675
6.4
Tutorials and Other References
■
Java Tutorial on JAX-RPC
http://java.sun.com/webservices/docs/1.0/tutorial/doc/
JAXRPC.html
http://java.sun.com/webservices/docs/1.0/tutorial/
index.html
■
J2EE Tutorial:
http://java.sun.com/j2ee/tutorial/
■
White Papers:
http://java.sun.com/webservices/white/index.html
■
Download site for specification:
http://java.sun.com/xml/downloads/jaxrpc.html#jaxrpcspec10
■
JAX-RPC JSR location:
http://jcp.org/aboutJava/communityprocess/first/jsr101/
Reference Information
Sun Microsystems, Inc.
12 of 12