End-to-End Binary SOAP Attachment 2: Creating the Web Service

This tutorial needs a review. You can open a JIRA issue, or edit it in GitHub following these contribution guidelines.

The goal of this lesson is to create a web application that contains a web service. You implement the web service as a stateless session bean.

You can download a complete sample of the web service from the NetBeans Samples Catalog.

Lessons In This Tutorial

netbeans stamp 80 74 73
Figure 1. Content on this page applies to the NetBeans IDE 7.2, 7.3, 7.4 and 8.0

Creating the Web Application

In this section, you create a Java EE web application. To this application, you add the images that the web service will pass as binary data.

To create the web application:

  1. Choose File > New Project (Ctrl-Shift-N on Linux and Windows, ⌘-Shift-N on MacOS). The New Project wizard appears. Select Web Application from the Java Web category and click Next. The Name and Location page opens.

  2. Type FlowerAlbumService in the Project Name field. Select the location you want for this project. Keep the default settings for the other options and click Next. The Server and Settings page opens.

  3. Select the GlassFish server and Java EE version Java EE 6 Web or Java EE 7 Web.

  4. Click Finish. The FlowerAlbumService project is created and appears in the Projects window.

  5. Right-click the Source Packages node and select New > Java Package.

Alternatively, select New > Other and select Java Package in the Java category of the New File wizard.

  1. Name the package org.flower.resources . Click Finish.

new package
  1. Copy the following images into org.flower.resources :

The project now has the package org.flower.resources in the Source Package. No other contents have been added.

project w resources

Adding the Web Service

In this section you create a web service in the web application. You create the service as a stateless session bean. You add the following web operations to the service:

  • An operation that takes the name of a flower and gets its associated Image .

  • An operation that gets thumbnails of all the flower images and return them as a List .

To add the web service:

  1. In the Projects window, right-click the FlowerAlbumService project node and choose New > Web Service. Alternatively, choose New > Other and then select Web Service under Web Services in the New File wizard. The New Web Service wizard opens.

  2. In the New Web Service wizard, type FlowerService in Web Service Name and org.flower.service in Package Name. Select Create Web Service from Scratch. Select Implement Service as Stateless Session Bean. Click Finish.

new service

The web service appears in the project’s nodes in the Projects window. The Source Packages directory includes the service package and the resources package.

project w service and resources
  1. Open FlowerService.java in the editor. Switch to the Design view. A form appears in which you can add operations and quality of service elements to the web service.

flower service empty design
  1. Click Add Operation. The Add Operation wizard opens.

  1. Name the operation getFlower . In the Return Type field, type or browse for java.awt.Image .

  1. In the Parameters tab, click Add. Name the parameter name and accept the default java.lang.String type.

add getflower param
  1. Open the Exceptions tab. Add an IOException .

io exception
  1. Click OK and close the wizard. Then click Add Operation again, and add an operation with the following properties:

    • Name: getThumbnails

    • Return type: java.util.List

    • *Exception: * IOException

The Design view now shows the getFlower and getThumbnails operations. Switch to the List View of both operations and you see all their parameters.

flower service full design


Next step:

To send comments and suggestions, get support, and keep informed about the latest developments on the NetBeans IDE Java EE development features, join the nbj2ee@netbeans.org mailing list.