Web Service Passing Binary Data, pt 4: Modifying the Schema and WSDL Files

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

In this lesson, you add the WSDL file and schema file to the web application. Then you modify the schema file to interpret arrays of bytes as Images. You also edit the web service source code to correctly locate the schema and WSDL file. In the process, you are introduced to various tools in the IDE that help you with WSDL and Schema files.

You can apply the procedure in this section to any JAX-WS web service, to pass any MIME type as binary data. Starting with a web service that passes binary data, as you created in Lessons 2 and 3, you customize the service’s WSDL and XML schema. In the customized XML schema file, you add an expectedContentTypes="mime_type" attribute to the return element for the binary data. This attribute informs the client that it should map the binary data to a Java type (as per MIME > Java type mapping) instead of to an array of bytes. In this tutorial, you map the binary data to java.awt.Image , but you can map the binary data to any of the Java types given in the JAXB 2.0 specification, as described in the JAX-WS Users Guide.

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
  1. Overview

  2. Creating the Web Service

  3. Coding and Testing the Web Service

  4. ⇒ Modifying the Schema and WSDL Files to Pass Binary Data

  5. + Creating the Swing Client+

Modifying the Schema File and WSDL Files to Pass Binary Data

In the following procedure, you create modified WSDL and XML Schema files for the web service that you created in a previous tutorial. The modified WSDL and Schema files enable the web service and the clients that consume it to parse JPEG image data that is passed as binary data.

To modify the WSDL and Schema files:

  1. In the Projects window, expand the FlowerService web application node until you reach the WEB-INF node. Right-click the WEB-INF folder and select New > Folder. (You might need to select New > Other, then the Other category).

new file wiz folder
  1. Click Next. The Name and Location page opens. Name the folder wsdl .

wsdl folder name location
  1. Click Finish. The folder wsdl appears in the Projects Window.

wsdl folder
  1. Expand the Web Services node and right-click the FlowerService node. Choose Generate and Copy WSDL…​

  1. The Generate and Copy WSDL dialog opens with a navigation tree. Navigate to the wsdl folder you created (FlowerAlbumService > web > WEB-INF > wsdl) and click OK.

You now see FlowerService.wsdl and FlowerService_schema1.xsd in the wsdl node. You also see a new node for Generated Sources (jax-ws).

generated wsdl and schema
  1. Explicitly make the application server use your own version of the WSDL file. Otherwise the application server will generate its own WSDL file. Open FlowerService.java and locate the @WebService annotation. Add to this annotation the parameter wsdlLocation="WEB-INF/wsdl/FlowerService.wsdl" as shown below:

@WebService(serviceName = "FlowerService"*, wsdlLocation = "WEB-INF/wsdl/FlowerService.wsdl")*
  1. Modify the schema file FlowerService_schema1.xsd so it specifies the expected content type of the return element. To identify the return element in the schema file, open the schema file and find the complex types getThumbnailResponse and getFlowerResponse :

<xs:complexType name="getThumbnailsResponse"><xs:sequence><xs:element name="return" type="xs:base64Binary" minOccurs="0" maxOccurs="unbounded"/></xs:sequence></xs:complexType>
<xs:complexType name="getFlowerResponse"><xs:sequence><xs:element name="return" type="xs:base64Binary" minOccurs="0"/> </xs:sequence></xs:complexType>
  1. Add the following attributes to both return elements ( <xs:element name="return"…​/>): .

xmime:expectedContentTypes="image/jpeg" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"

You should now see the following in the same lines.

<xs:complexType name="getThumbnailsResponse"><xs:sequence><xs:element name="return" type="xs:base64Binary" minOccurs="0" maxOccurs="unbounded"
                xmime:expectedContentTypes="image/jpeg" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"/></xs:sequence></xs:complexType>
<xs:complexType name="getFlowerResponse"><xs:sequence><xs:element name="return" type="xs:base64Binary" minOccurs="0"
            xmime:expectedContentTypes="image/jpeg" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"/> </xs:sequence></xs:complexType>
  1. Now, when you redeploy the web service to the Tester application, and invoke one of the operations, you see that an image is correctly returned:

ws tester goodschema

Now that the Tester application has confirmed that images are correctly being returned, you can create a Swing client to retrieve and display the images.

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.