Software Needed for the Tutorial

Before you begin, you need to install the following software on your computer:

• NetBeans IDE 5.5 (download).
• Java Standard Development Kit (JDK) version 5.0 or version 6.0 (download).
• Sun Java System Application Server 9.0 (if not bundled with your NetBeans IDE installation, download and install it separately).

Tutorial Exercises

• Installing and Configuring the Tutorial Environment
• Creating a Web Service
• Coding the Web Service
• Deploying and Testing the Web Service
• Consuming the Web Service in
  • a Java class in a Java SE Application
  • a servlet in a web application
  • a JSP page in a web application

Choosing a Container

You can either deploy your web service in a web container or in an EJB container. This depends on implementation choices. For example, if you plan to deploy to the Tomcat Web Server, which only has a web container, you should choose to create a web application, and not an EJB module.

1. Choose File > New Project (Ctrl-Shift-N). Select Web Application from the Web category or EJB Module from the Enterprise category.
2. Name the project CalculatorWSApplication.
3. Depending on the deployment server that you want to use, do the following:
   • For the Sun Java System Application Server, set the J2EE Version to Java EE 5.
   • For the Tomcat Web Server, unselect the Set Source Level to 1.4 checkbox.
4. Click Finish.

Creating a Web Service from a Java Class

1. Right-click the CalculatorWSApplication node and choose New > Web Service.
2. Name the web service CalculatorWS, type org.me.calculator in Package, and click Finish.

   The Projects window displays the new web service. For example, for web applications the Projects window now looks as follows:

   

   The IDE automatically creates the deployment descriptors required for the server, if any. For the Sun Java System Application Server, no deployment descriptor is needed. For web services deployed to the Tomcat Web Server, sun-jaxws.xml and a WSServlet item in web.xml are added.

Summary

In this exercise, you created a NetBeans project and set up the web service.

Adding Business Logic to the Web Service

1. Expand the Web Services node and double-click the CalculatorWS node. The web service opens in the Source Editor. Note that an operation exists in the code already. It is commented out. Here, we create a new operation from scratch. Another way of creating the operation would be to remove the lines that comment out the code.
2. Right-click within the body of the class, either above or below the code that is commented out, and choose Web Service > Add Operation.
3. In the upper part of the Add Operation dialog box, type add in Name and choose int from the Return Type drop-down list.
4. In the lower part of the Add Operation dialog box, click Add and create a parameter of type int named i. Click OK.
5. Click Add again and create a parameter of type int called j.
6. Click OK at the bottom of the Add Operation dialog box. Notice that a skeleton for the add method has been added to the Source Editor:

       @WebMethod
       public int add(@WebParam(name = "i") int i, @WebParam(name = "j") int j) {
           // TODO implement operation
           return 0;
               }

7. Change the add method to the following (changes are in bold):

       @WebMethod
       public int add(@WebParam(name = "i") int i, @WebParam(name = "j") int j) {
           int k = i + j;
           return k;
           }

Summary

In this exercise, you added code to the web service.

Client 1: Java Class in Java SE Application

1. Choose File > New Project (Ctrl-Shift-N). Select Java Application from the General category. Name the project CalculatorWS_Client_Application.

   Note: At the time of writing, issue Issue 10 was unresolved; therefore, you must create your web service client in a project folder that does not contain spaces in its path. For example, the path should not be "C:\Documents and Settings\...".

   Click Finish.
2. Right-click the CalculatorWS_Client_Application node and choose New > Web Service Client.
3. In Project, click Browse. Browse to the web service that you want to consume. When you have selected the web service, click OK.
4. Type org.me.calculator.client in Package, and click Finish.

   The Projects window displays the new web service client:

   

5. Double-click Main.java so that it opens in the Source Editor. Delete the TODO comment and right-click in that line. Choose Web Service Client Resources > Call Web Service Operation.
6. Browse to the Add operation and click OK.
7. Change the line that is underlined in red to the following:

       System.out.println("Sum: " + port.add(3,4));

8. Right-click the project node and choose Run Project.

   The Output window should now show the following:

       compile:
       run:
       Sum: 7
           BUILD SUCCESSFUL (total time: 1 second)

Client 2: Servlet in Web Application

1. Choose File > New Project (Ctrl-Shift-N). Select Web Application from the Web category. Name the project CalculatorWSServletClient.

   Note: At the time of writing, issue Issue 10 was unresolved; therefore, you must create your web service client in a project folder that does not contain spaces in its path. For example, the path should not be "C:\Documents and Settings\...".

   Click Finish.

2. Right-click the CalculatorWSServletClient node and choose New > Web Service Client.
3. In Project, click Browse. Browse to the web service that you want to consume. When you have selected the web service, click OK.
4. Type org.me.calculator.client in Package, and click Finish.

   The Projects window displays the new web service client:

   

5. Right-click the project node and choose New > Servlet. Name the servlet ClientServlet and house it in a package called org.me.calculator.client. Click Finish. To make the servlet the entry point to your application, right-click the project node, choose Properties, click Run, and type /ClientServlet in Relative URL. Click OK.
6. In the Source Editor, remove the line that comments out the body of the processRequest method. This is the line that starts the section that comments out the code:

       /* TODO output your page here

   Next, delete the line that ends the section of commented out code:

       */

   Add some empty lines after this line:

       out.println("<h1>Servlet ClientServlet at " + request.getContextPath () + "</h1>");

   Now, right-click in one of the empty lines that you added. Choose Web Service Client Resources > Call Web Service Operation. The Select Operation to Invoke dialog box appears.

7. Browse to the add operation and click OK.

   The processRequest method now looks as follows (the added code is in bold below):

       protected void processRequest(HttpServletRequest request, HttpServletResponse response)
       throws ServletException, IOException {
           response.setContentType("text/html;charset=UTF-8");
           PrintWriter out = response.getWriter();
           out.println("<html>");
           out.println("<head>");
           out.println("<title>Servlet ClientServlet</title>");
           out.println("</head>");
           out.println("<body>");
           out.println("<h1>Servlet ClientServlet at " + request.getContextPath () + "</h1>");
           try { // Call Web Service Operation
               org.me.calculator.client.CalculatorWSService service = new org.me.calculator.client.CalculatorWSService();
               org.me.calculator.client.CalculatorWS port = service.getCalculatorWSPort();
               // TODO initialize WS operation arguments here
               int arg0 = 0;
               int arg1 = 0;
               // TODO process result here
               int result = port.add(arg0, arg1);
               System.out.println("Result = "+result);
           } catch (Exception ex) {
               // TODO handle custom exceptions here
           }
           out.println("</body>");
           out.println("</html>");
           out.close();
               }

   Change the value for arg0 and arg1 to other numbers, such as 3 and 4.

   Change the System.out.println statement to out.println.

   Add a line that prints out an exception, if an exception is thrown.

   The try/catch block should now look as follows (new and changed lines are highlighted):

       try { // Call Web Service Operation
           org.me.calculator.client.CalculatorWSService service = new org.me.calculator.client.CalculatorWSService();
           org.me.calculator.client.CalculatorWSApplication port = service.getCalculatorWSApplicationPort();
           // TODO initialize WS operation arguments here
           int arg0 = 3;
           int arg1 = 4;
           // TODO process result here
           int result = port.add(arg0, arg1);
           out.println("<p>Result: " + result);
       } catch (Exception ex) {
           out.println("<p>Exception: " + ex);
               }

8. Right-click the project node and choose Run Project.

   The server starts, if it wasn't running already; the application is built and deployed, and the browser opens, displaying the calculation result.

Client 3: JSP Page in Web Application

1. Choose File > New Project (Ctrl-Shift-N). Select Web Application from the Web category. Name the project CalculatorWSJSPClient.

   Note: At the time of writing, issue Issue 10 was unresolved; therefore, you must create your web service client in a project folder that does not contain spaces in its path. For example, the path should not be "C:\Documents and Settings\...".

   Click Finish.

2. Right-click the CalculatorWSJSPClient node and choose New > Web Service Client.
3. In Project, click Browse. Browse to the web service that you want to consume. When you have selected the web service, click OK.
4. Type org.me.calculator.client in Package, and click Finish.

   The Projects window displays the new web service client.

5. In the Web Pages folder, double-click index.jsp so that it opens in the Source Editor.
6. In the Web Service References node, expand the node that represents the web service. The add operation, which you want to invoke from the client, is now exposed.
7. Drag the add operation to the client's index.jsp page, and drop it below the H1 tags. The code for invoking the service's operation is now generated in the index.jsp page.

   Change the value for arg0 and arg1 to other numbers, such as 3 and 4.

8. Right-click the project node and choose Run Project.

   The server starts, if it wasn't running already; the application is built and deployed, and the browser opens, displaying the calculation result: