Download
PDF
Home
History 		PrevBeginningNext API
Search
Feedback
FAQ
Divider

Building, Packaging, Deploying, and Running the Application

The source code for the Coffee Break application is located in the directory <INSTALL>/j2eetutorial14/examples/cb/. Within the cb directory are subdirectories for each Web application--saaj, jaxrpc, server, and server-jsf--and a directory, common, for classes shared by the Web applications. Each subdirectory contains a build.xml and build.properties file. The Web application subdirectories in turn contain a src subdirectory for Java classes and a web subdirectory for Web resources.

Setting the Port

The JAX-RPC and SAAJ services in the Coffee Break application run at the port that you specified when you installed the Application Server. The tutorial examples assume that the Application Server runs on the default port, 8080. If you have changed the port, you must update the port number in the following files before building and running the examples:

Setting Up the Registry Server

The Coffee Break servers use a registry server to obtain information about the JAX-RPC service endpoint. Since the Application Server does not include a registry server, you must obtain one before you can run the application.

We recommend that you use the Registry Server provided with the Java Web Services Developer Pack (Java WSDP) 1.4, which you can download from http://java.sun.com/webservices/downloads/. To use the Java WSDP Registry Server, follow these steps:

  1. Stop the Application Server.
  2. Start the Java WSDP install program.
  3. Choose the Custom install option.
  4. When the install program requests that you choose which features to install, deselect everything except the Java WSDP Registry Server.
  5. Select the Sun Java System Application Server Platform Edition 8 for the Web container. The Registry Server and its backing repository Xindice are installed into the Application Server as Web applications.
  6. Start the Application Server.
  7. Confirm that the Registry Server and Xindice Web applications are running using the Admin Console or deploytool.

The Registry Server is automatically loaded when you start the Application Server.

Using the Provided WARs

The instructions that follow for packaging and deploying the Coffee Break Web applications assume that you are familiar with the deploytool procedures for packaging Web services and presentation-oriented Web applications described in previous chapters of the tutorial. If after following these procedures you have trouble deploying or running the application, you can use the WARs provided in <INSTALL>/j2eetutorial14/examples/cb/provided-wars/ to run the example. The provided WARs assume that Coffee Break supplier services and the Registry Server are all running on port 8080. If the services are not running on port 8080, you won't be able to use these WARs.

Building the Common Classes

The Coffee Break applications share a number of common utility classes. To build the common classes, do the following:

  1. In a terminal window, go to <INSTALL>/j2eetutorial14/examples/cb/common/.
  2. Run asant build.

Building, Packaging, and Deploying the JAX-RPC Service

To build the JAX-RPC service and client library and to package and deploy the JAX-RPC service, follow these steps:

  1. In a terminal window, go to <INSTALL>/j2eetutorial14/examples/cb/jaxrpc/.
  2. Run asant build-registry and asant build-service. These tasks create the JAR file containing the JAXR routines and run wscompile and compile the source files of the JAX-RPC service.

    3. If you get an error, make sure that you edited the file <INSTALL>/j2eetutorial14/examples/common/build.properties as described in Building the Examples.

  3. Make sure the Application Server and Registry Server are started.

To package and deploy the JAX-RPC service using asant, follow these steps:

  1. Run asant create-war.
  2. If you did not do so in Chapter 10, follow the instructions in Creating JAXR Resources to create a JAXR connection factory named eis/JAXR.
  3. Run asant deploy-war.

To package and deploy the JAX-RPC service using deploytool, follow these steps:

  1. Start deploytool.
  2. Create a stand-alone Web module named jaxrpc-coffee-supplier in <INSTALL>/j2eetutorial14/examples/cb/jaxrpc/.
  3. Set the context root to /jaxrpc-coffee-supplier.
  4. Add the content to the service.
    1. Add the com package, Supplier.wsdl, and mapping.xml under <INSTALL>/j2eetutorial14/examples/cb/jaxrpc/build/server/ to the module.
    2. Navigate to <INSTALL>/j2eetutorial14/examples/cb/jaxrpc/build/registry/dist/ and add registry-org.jar.
    3. In the Web module contents editor, drag the com directory (containing sun/cb/SupplierPrices.properties) from the context root to WEB-INF/classes/.
  5. Specify Web Services Endpoint as the component type.
  6. In the Choose Service dialog box (Define New Service):
    1. In the WSDL File combo box, select WEB-INF/wsdl/Supplier.wsdl.
    2. In the Mapping File combo box, select mapping.xml.
  7. In the Component General Properties dialog box:
    1. In the Service Endpoint Implementation combo box, select com.sun.cb.SupplierImpl.
    2. Click Next.
  8. In the Web Service Endpoint dialog box:
    1. In the Service Endpoint Interface combo box, select com.sun.cb.SupplierIF.
    2. In the Namespace combo box, select urn:Foo.
    3. In the Local Part combo box, select SupplierIFPort.
    4. Click Next.
  9. Add the alias /jaxrpc to the SupplierImpl Web component.
  10. Select the Endpoint tab, and then select jaxrpc from the Endpoint Address combo box in the Sun-specific Settings frame.
  11. Add an event listener that references the listener class com.sun.cb.ContextListener.
  12. Add a resource reference of type javax.xml.registry.ConnectionFactory named eis/JAXR mapped to the JAXR connection factory eis/JAXR. If you have not already created the connection factory, follow the instructions in Creating JAXR Resources.
  13. Add the context parameter that specifies the URL of the registry server. The parameter is named registryURL and the value is http://localhost:port/RegistryServer/, where port is the port at which the registry server is running.
  14. Save the module.
  15. Deploy the module.

Next, build and test the client:

  1. Run asant build-client. This task creates the JAR file that contains the classes needed by JAX-RPC clients. The build-client task runs wscompile to generate the stubs and JavaBeans components.
  2. Test that the JAX-RPC service has been deployed correctly by running the test programs asant run-test-order and asant run-test-price

    3. Here is what you should see when you run asant run-test-price:

    run-test-price:
    run-test-client:
      [java] 07/21/03 08/20/03
      [java] Kona 6.50
      [java] French Roast 5.00
      [java] Wake Up Call 5.50
      [java] Mocca 4.00

Building, Packaging, and Deploying the SAAJ Service

To build the SAAJ service and client library, follow these steps:

  1. In a terminal window, go to <INSTALL>/j2eetutorial14/examples/cb/saaj/.
  2. Run asant build. This task creates the client library and compiles the server classes.
  3. Make sure the Application Server is started.

To package and deploy the SAAJ service using asant, follow these steps:

  1. Run asant create-war.
  2. Run asant deploy-war.

To package and deploy the SAAJ service using deploytool, follow these steps:

  1. Start deploytool.
  2. Create a stand-alone Web module called saaj-coffee-supplier in <INSTALL>/j2eetutorial14/examples/cb/saaj/.
  3. Set the context root to /saaj-coffee-supplier.
  4. Add the com directory under <INSTALL>/j2eetutorial14/examples/cb/saaj/build/server/ to the module.
  5. Add the ConfirmationServlet Web component. Choose the Servlet component type.
  6. Add the alias /orderCoffee to the ConfirmationServlet Web component.
  7. Add the PriceListServlet Web component to the existing saaj-coffee-supplier WAR.
  8. Add the alias /getPriceList to the PriceListServlet Web component.
  9. Save the module.
  10. Deploy the module.

Test that the SAAJ service has been deployed correctly by running one or both of the test programs asant run-test-price and asant run-test-order.

Building, Packaging, and Deploying the Coffee Break Server

To build the Coffee Break server:

  1. In a terminal window, go to <INSTALL>/j2eetutorial14/examples/cb/server/.
  2. Run asant build. This task compiles the server classes and copies the classes, JSP pages, and tag libraries into the correct location for packaging.
  3. Make sure the Application Server is started.

To package and deploy the Coffee Break server using asant, follow these steps:

  1. Run asant create-war.
  2. Run asant deploy-war.

To package and deploy the Coffee Break server using deploytool, follow these steps:

  1. Start deploytool.
  2. Create a stand-alone Web module called cbserver in <INSTALL>/j2eetutorial14/examples/cb/server/.
  3. Set the context root to /cbserver.
  4. Add the content to the Web module.
    1. Add all the JSP pages, tutorial-template.tld, and the template and com directories under <INSTALL>/j2eetutorial14/examples/cb/server/build/ to the module.
    2. In the Web module contents editor, drag the com directory (containing sun/cb/CoffeeBreak.properties) from the context root to WEB-INF/classes/.
    3. Add the JAX-RPC client library in <INSTALL>/j2eetutorial14/examples/cb/jaxrpc/dist/jaxrpc-client.jar to the module.
    4. Add the SAAJ client library in <INSTALL>/j2eetutorial14/examples/cb/saaj/dist/saaj-client.jar to the module.
  5. Create a Dispatcher Web component. Choose the Servlet component type.
  6. Add the aliases /orderForm, /checkoutForm, and /checkoutAck to the Dispatcher component.
  7. Add the RetailPriceListServlet Web component to the existing cbserver WAR.
  8. Add the alias /loadPriceList to the RetailPriceListServlet component.
  9. Add a resource reference of type javax.xml.registry.ConnectionFactory named eis/JAXR mapped to the JAXR connection factory eis/JAXR.
  10. Add a JSP property group named cbserver. The property group applies to the URL pattern *.jsp. Add the include prelude /template/prelude.jspf.
  11. Add a context parameter named javax.servlet.jsp.jstl.fmt.localizationContext and value com.sun.cb.messages.CBMessages.
  12. Add the context parameter that specifies the URL of the registry server. The parameter is named registryURL and the value is http://localhost:port/RegistryServer/, where port is the port at which the registry server is running.
  13. Specify a security constraint for RetailPriceListServlet.
    1. Select Basic as the User Authentication Method.
    2. Click Settings and enter file in the Realm Name field. Click OK.
    3. Add a security constraint and a web resource collection. Use the default names provided by deploytool.
    4. Add the URL /loadPriceList to the web resource collection.
    5. Select the GET HTTP method.
    6. Add the security role admin.
  14. Map the admin role to the admin user.
  15. Save the module.
  16. Deploy the module.

Building, Packaging, and Deploying the JavaServer Faces Technology Coffee Break Server

To build the JavaServer Faces technology version of the Coffee Break server, follow these steps:

  1. In a terminal window, go to <INSTALL>/j2eetutorial14/examples/cb/server-jsf/.
  2. Run asant build. This task compiles the server classes and copies the classes, JSP pages, tag libraries, and other necessary files into the correct location for packaging.
  3. Make sure the Application Server is started.

To package and deploy the JavaServer Faces technology version of the Coffee Break server using asant, follow these steps:

  1. Run asant create-war.
  2. Run asant deploy-war.

To package and deploy the JavaServer Faces technology version of the Coffee Break server using deploytool, follow these steps:

  1. Start deploytool.
  2. Create a stand-alone Web module called cbserver-jsf in <INSTALL>/j2eetutorial14/examples/cb/server-jsf/.
  3. Set the context root to /cbserver-jsf.
  4. Add the content to the Web module.
    1. Add all the JSP pages, coffeebreak.css, faces-config.xml, index.html, and the template and com directories under <INSTALL>/j2eetutorial14/examples/cb/server-jsf/build/ to the module.
    2. In the Web module contents editor, drag the com directory (containing sun/cb/CoffeeBreak.properties) from the context root to WEB-INF/classes.
    3. Drag faces-config.xml to the root of the WEB-INF directory.
    4. Add the JSF API library from <J2EE_HOME>/lib/jsf-api.jar to the module.
    5. Add the JAX-RPC client library in <INSTALL>/j2eetutorial14/examples/cb/jaxrpc/dist/jaxrpc-client.jar to the module.
    6. Add the SAAJ client library in <INSTALL>/j2eetutorial14/examples/cb/saaj/dist/saaj-client.jar to the module.
  5. Create a FacesServlet Web component. Choose the Servlet component type.
    1. In the Load Sequence Position field on the Component General Properties dialog, enter 1.
  6. Add the aliases /faces/* and *.jsf to the FacesServlet component.
  7. Add a resource reference of type javax.xml.registry.ConnectionFactory named eis/JAXR mapped to the JAXR connection factory eis/JAXR.
  8. Add a JSP property group named cbserver-jsf. The property group applies to the URL pattern *.jsp. Add the include prelude /template/prelude.jspf.
  9. Add the context parameter that specifies the URL of the registry server. The parameter is named registryURL and the value is http://localhost:port/RegistryServer/, where port is the port at which the registry server is running.
  10. Save the module.
  11. Deploy the module.

Running the Coffee Break Client

After you have installed all the Web applications, check that all the applications are running in deploytool or the Admin Console. You should see cbserver (or cbserver-jsf), jaxrpc-coffee-supplier, and saaj-coffee-supplier in the list of applications.

If you have installed the non-GUI framework version of the Coffee Break server, you can run the Coffee Break client by opening the Coffee Break server URL in a Web browser: 

http://localhost:8080/cbserver/orderForm

If you have installed the JavaServer Faces technology version of the Coffee Break server, you can run the JavaServer Faces version of the Coffee Break client by opening this URL in a Web browser: 

http://localhost:8080/cbserver-jsf/faces/orderForm.jsp

You should see a page something like the one shown in Figure 35-2.

Coffee Break Order Form

Figure 35-2 Order Form

After you have gone through the application screens, you will get an order confirmation that looks like the one shown in Figure 35-3.

Coffee Break Order Confirmation

Figure 35-3 Order Confirmation

Removing the Coffee Break Application

To remove the Coffee Break application, perform the following steps:

  1. Undeploy the JAX-RPC and SAAJ services and the Coffee Break server using deploytool or the Admin Console or by running asant undeploy-war.
  2. Stop the Application Server.

If you want to remove the build and dist directories, run ant clean in each directory, including <INSTALL>/j2eetutorial14/examples/cb/common/.

Note: You should undeploy the Coffee Break Web applications before you stop the Application Server. When the Application Server is restarted, it loads the Registry Server after other deployed applications. When the deployed Coffee Break Web applications are started by the Application Server, they will not be able to access the Registry Server and thus will not be able to complete their initialization.

Divider
Download
PDF
Home
History 		PrevBeginningNext API
Search
Feedback
FAQ
Divider

All of the material in The J2EE(TM) 1.4 Tutorial is copyright-protected and may not be published in other works without express written permission from Sun Microsystems.