Home TOC

Preface

The Java Web Services Tutorial is a beginner's guide to developing Web services and Web applications using the Java Web Services Developer Pack ("Java WSDP"). The Java WSDP is an all-in-one download containing key technologies to simplify building of Web services using the Java 2 Platform. The technologies available on the Java WSDP are:

• Java Servlets
• JavaServer Pages (JSP)
• JSP Standard Tag Library ("JSTL")
• Java XML Pack, which includes:
  • Java API for XML Messaging ("JAXM")
  • Java API for XML Processing ("JAXP")
  • Java API for XML Registries ("JAXR")
  • Java API for XML-based RPC ("JAX-RPC")

To provide a development and deployment environment, the Java WSDP includes the:

• Tomcat servlet and JSP container
• ant build tool
• Java WSDP Registry Server

Here we cover all the things you need to know to make the best use of the Java Web Services Tutorial.

Who Should Use This Tutorial

About the Examples

Related Information

How to Print This Tutorial

Typographical Conventions

Who Should Use This Tutorial

This tutorial is intended for programmers interested in developing and deploying Web services and Web applications on the Java WSDP.

About the Examples

This tutorial includes many complete, working examples.

Prerequisites for the Examples

To understand the examples you will need a good knowledge of the Java programming language, SQL, and relational database concepts. The following topics in the Java Tutorial are particularly relevant:

Topic	Java Tutorial
JDBC	http://java.sun.com/docs/books/tutorial/jdbc
Threads	http://java.sun.com/docs/books/tutorial/essential/threads
JavaBeans	http://java.sun.com/docs/books/tutorial/javabeans
Security	http://java.sun.com/docs/books/tutorial/security1.2

Running the Examples

This section tells you everything you need to know to obtain, build, deploy, and run the examples.

Required Software

If you are viewing this online, you need to download the Java Web Services Tutorial from:

http://java.sun.com/webservices/downloads/webservicestutorial.html
 

Once you have installed the tutorial bundle, the example source code is in the <JWSDP_HOME>/docs/tutorial/examples directory, with subdirectories for each of the technologies included in the pack.

This tutorial documents the Java WSDP EA1. To build, deploy, and run the examples you need a copy of the Java WSDP and the Java 2 Platform, Standard Edition (J2SE) SDK 1.3.1 or 1.4. You can download the Java WSDP from:

http://java.sun.com/webservices/downloads/webservicespack.html
 

the J2SE 1.3.1 SDK from

http://java.sun.com/j2se/1.3/
 

or the J2SE 1.4 SDK from

http://java.sun.com/j2se/1.4/
 

Set the environment variables to the values noted in Table 1.

Table 1 Required Environment Variables

Environment Variable	Value
JAVA_HOME	The location of the J2SE SDK installation.
JWSDP_HOME	The location of the Java WSDP installation. This variable is used by the example build files.
PATH	Add the bin directories of the Java WSDP and J2SE SDK installations to the front. The Java WSDP bin directory contains the startup scripts for Tomcat, ant, and the registry server as well as other tools.

Building the Examples

Most of the examples are distributed with a configuration file for version 1.4.1 of ant, a portable build tool contained in the Java WSDP. Directions for building the examples are provided in each chapter.

Deploying the Examples

Most of the Java WSDP examples run on Tomcat. Before you can run an example you must first deploy it on Tomcat. To deploy an application execute ant deploy. The deploy task usually copies some files into the <JWSDP_HOME>/webapps directory. Some things you need to keep in mind:

• For this release of the Java WSDP you must be running Tomcat on the same machine that you are developing on.
• The first time an application is deployed you must start or restart Tomcat (see next section). Thereafter, when you modify an application, you can build, deploy, and then reload the example, as described in the next section.

Running Tomcat

You run Tomcat by executing the startup script in a terminal window.

Reloading the Examples

You reload an application with the command:

http://localhost:8080/manager/reload?path=/target
 

This command invokes the manager Web application. Before you can use this application you must add your user name and password combination and associate the role name manager with it to <JWSDP_HOME>/conf/tomcat-users.xml, which can be edited with any text editor. This file contains an element <user> for each individual user, which might look something like this:

<user name="adeveloper" password="secret" roles="manager" />
 

The Tomcat reference documentation distributed with the Java WSDP contains information about the manager application.

Related Information

For further information on the technologies discussed in this tutorial see the reference documentation contained in the Java WSDP (<JWSDP_HOME>/docs/index.html) and the Web sites listed in Table 2. References to individual technology homes listed in some chapters map as follows:

• JAXM-HOME to JWSDP_HOME/docs/jaxm/index.html
• JAXP-HOME to JWSDP_HOME/docs/jaxp/index.html
• JAXR-HOME to JWSDP_HOME/docs/jaxr/index.html
• JAXRPC-HOME to JWSDP_HOME/docs/jaxrpc/index.html

  Table 2 Related Information

  Technology	Web Site
  Java Servlets	http://java.sun.com/products/servlet/index.html
  JavaServer Pages	http://java.sun.com/products/jsp/index.html
  JSP Standard Tag Library	http://java.sun.com/products/jsp/taglibraries.html#jstl
  JAXM	http://java.sun.com/xml/jaxm/index.html
  JAXP	http://java.sun.com/xml/jaxp/index.html
  JAXR	http://java.sun.com/xml/jaxr/index.html
  JAX-RPC	http://java.sun.com/xml/jaxrpc/index.html
  Tomcat	http://jakarta.apache.org/tomcat/index.html
  ant	http://jakarta.apache.org/ant/index.html

How to Print This Tutorial

To print this tutorial, follow these steps:

• Ensure that Adobe Acrobat Reader is installed on your system.
• Open the PDF version of this book.
• Click the printer icon in Adobe Acrobat Reader.

Typographical Conventions

The following table lists the typographical conventions used in this tutorial.

Font Style	Uses
italic	Emphasis, titles, first occurrence of terms
monospace	URLs, code examples, file names, command names, programming language keywords
italic monospace	Programming variables, variable file names

Home TOC