JBoss Web Services User Guide

Define the service attributes

Define the project, web service, package and class names according to the options displayed in Table 6.5, “Project and Web Service Name”

Generate the web service

Click the Finish button to complete the web service setup.

Result:

The web service classes will be generated and the web.xml file updated with the deployment details.

Browse the HelloWorld.java class

Double click the HelloWorld.java class and note the annotated class name and method. These annotations identify the web service entities to the server.

[D]

Figure 6.4. web.xml

Browse the web.xml deployment decriptor

Double click the web.xml file and note the servlet mapping as defined in Figure 6.3, “Generate a Sample Web Service - Project and Web Service Name”. Note also that:

[D]

Figure 6.5. web.xml

Upon start up, the server will write a WSDL file to the server-profile/data/wsdl/ directory and the WSDL can be accessed with http://localhost:8080/ProjectName/[1]?WSDL or, http://localhost:8080/WebServiceSample/HelloWorld?WSDL.

Define the WAR file attributes as described in Table 6.6, “Export - War Export”

Deploy the application

Copy the file to the deploy directory of the required target server profile, such as the all profile. Note that the WAR file destination may have already been set as the deploy directory in Step 2.

1. Query the available options

   Select OPTIONS from the available combobox options.

2. Enter the url of the web service in the editable drop-down list: http://localhost:8080/RestfulSample/MyRESTApplication.

3. Click the Invoke button

   Result:

   The Response Headers text area indicates that the allowed options are [GET, OPTIONS, HEAD] as shown in Figure 8.8, “JAX-RS Response Header Text”.

   

   
   [D]

   Figure 8.8. JAX-RS Response Header Text

   
   

Test the GET request

1. Having established that the GET request is valid, select GET from the available combobox options.

2. Click the Invoke button.

   Result:

   The Response Body text area displays the expected “Hello World” text as shown in Figure 8.9, “JAX-RS Response Body Text”.

   

   
   [D]

   Figure 8.9. JAX-RS Response Body Text

   
   

1. Query the available options

   Following the preliminary steps described in Testing a JAX-RS web service, select the OPTIONS method from the operations text area.

2. Enter the url of the web service in the editable drop-down list http://localhost:8080/simple/rest-services/customers.

3. Click the Invoke button

   Result:

   The Response Headers text area indicates that the allowed options are [POST, OPTIONS] as shown in Figure 8.10, “JAX-RS RESTEasy project Body Text”.

   

   
   [D]

   Figure 8.10. JAX-RS RESTEasy project Body Text

   
   

Test the POST option

1. Select POST method in the the operations drop-down list.

2. We will post xml data to this particular web service. Complete the header details by entering content-type=application/xml in the text area and click Add to add it to the Headers list.

   Result:

   The content-type is added to the Headers list as shown in Figure 8.11, “content-type header”.

   

   
   [D]

   Figure 8.11. content-type header

   
   

3. Enter customer details

   Enter the customer details in the Body Text area as displayed in Figure 8.12, “Customer data”.

   

   
   [D]

   Figure 8.12. Customer data

   
   

4. Click the Invoke button.

   Result:

   The Response Headers area indicated that a record was created and lists the location as http://localhost:8080/simple/rest-services/customers/1 as shown in Figure 8.13, “Customer added”.

   

   
   [D]

   Figure 8.13. Customer added

   
   

   The console also indicates the successful creation of the customer: 10:44:33,846 INFO [STDOUT] Created customer 1

1. Select the GET method in the the operations drop-down list.

2. We will retrieve the record created in the previous step. Enter the url for the record returned in the previous step http://localhost:8080/simple/rest-services/customers/1

3. Click the Invoke button.

   Result:

   The Response Headers area indicates a [HTTP/1.1 200 OK] response and the customer data is retrieved and displayed in the Response Body area as shown in Figure 8.14, “GET response”.

   

   
   [D]

   Figure 8.14. GET response

   
   

Test the PUT option

1. Editing a record is achieved by using the PUT method. Select the PUT method in the operations drop-down list.

2. Enter the url of the record to be edited http://localhost:8080/simple/rest-services/customers/1

3. Enter the data in the Body Text area. Replace the first-name with a different entry as in Figure 8.15, “Updated customer data”

   

   
   [D]

   Figure 8.15. Updated customer data

   
   

4. Ensure that the content-type=application/xml header is in the Headers list.

5. Click the Invoke button.

   Result:

   The Response Headers area indicates a No Response ([HTTP/1.1 204 No Content]) Figure 8.16, “Response header following PUT”.

   

   
   [D]

   Figure 8.16. Response header following PUT

   
   

   In this instance, the console does not indicate an update was performed, however, the console may provide useful information following an operation.

Check the updated data with a GET

Perform a GET operation by following the steps in Step 3.

Result:

The Response Body area displays the updated data.

[D]

Figure 8.17. Customer data updated

Test the DELETE option

1. Deleting a record is a similar process to posting. Select the DELETE method in the operations drop-down list.

2. Enter the url of the record to be deleted http://localhost:8080/simple/rest-services/customers/1

3. Click the Invoke button.

   Result:

   The Response Headers area indicates a No Response ([HTTP/1.1 204 No Content]) as was the case for the PUT operation in Figure 8.16, “Response header following PUT”.

   Once again, the console does not indicate an update was performed, however, the console may provide useful information following an operation.

Check the DELETE operation with a GET

Perform a GET operation by following the steps in Step 3.

Result:

The Response Body area returns an error report indicating that The requested resource () is not available and the Response Headers area returns a [HTTP/1.1 404 Not Found].

[D]

Figure 8.18. Customer data deleted

The response header and body messages indicate that the data was successfully deleted.