REpresentational State Transfer (REST) is an architectural style for distributed hypermedia systems, such as the World Wide Web. Central to the RESTful architecture is the concept of resources identified by universal resource identifiers (URIs). These resources can be manipulated using a standard interface, such as HTTP, and information is exchanged using representations of these resources. In this tutorial, you first learn a bit about REST and then you are shown how NetBeans IDE supports this architectural style.
Contents
To follow this tutorial, you need the following software and resources.
Both Tomcat and GlassFish can be installed with the Web and Java EE distribution of NetBeans IDE. Alternatively, you can visit the GlassFish downloads page or the Apache Tomcat downloads page.
RESTful web services are services built using the RESTful architectural style. Building web services using the RESTful approach is emerging as a popular alternative to using SOAP-based technologies for deploying services on the internet, due to its lightweight nature and the ability to transmit data directly over HTTP.
The IDE supports rapid development of RESTful web services using JSR 311 - Java API for RESTful Web Services (JAX-RS) and Jersey, the reference implementation for JAX-RS.
For detailed information, refer to the following:
In addition to building RESTful web services, the IDE also supports testing, building client applications that access RESTful web services, and generating code for invoking web services (both RESTful and SOAP-based.)
Here is the list of RESTful features provided by the IDE:
In this tutorial, you will be shown how the IDE supports you in generating, implementing, and testing RESTful web services.
The goal of this exercise is to create a project and generate entity classes from a database.
Note: In NetBeans IDE 6.5, you can generate entity classes and RESTful web services in a single wizard. Instead of choosing New > Entity Classes from Database, choose New > Web Services > RESTful Web Services from Database. Follow the same steps described in the rest of this procedure and in Generating RESTful Web Services from Entity Classes. The Generated Classes step of the New Entity Classes from Database wizard corresponds to Step 3 of Generating RESTful Web Services from Entity Classes. However, if you generate entity classes and RESTful web services separately, as described in this tutorial, you can see in greater detail how the process works.
In the Database Tables panel, select the jdbc/sample data source from the Data Source drop-down field.Note: On Tomcat, this data source may not exist. In this case, choose New Data Source from the Data Source drop-down field. The Create Data Source dialog opens. Type jdbc/sample in the JNDI Name field. From the Database Connection drop-down field, select jdbc:derby://hostname:1527/sample [app on APP]. Click OK. The dialog closes and you return to the Database Tables panel. See also the RESTful Service on Tomcat tutorial for NetBeans IDE 6.0.
Under Available Tables, select CUSTOMER and then click Add. The DISCOUNT_CODE table, which has a relationship with the CUSTOMER table, is automatically added to the Selected Tables list too. You now see the following:
Click Next.
Under Package, type customerdb. You now see the following.
Click Create Persistence Unit. The following dialog appears.
Click Create. You return to the Entity Classes pane. Click Finish, and the IDE creates the entity classes.
Note: In this tutorial, you skip the optional Mapping Options pane, which lets you change the default annotations used for mapping collections.
Look in the Projects window. You now see the following.
The goal of this exercise is to generate RESTful web services from the entity classes that you generated in the previous section.
Here you can see everything that the IDE will generate for you. The IDE uses the container-item pattern to generate the resource classes. For example, for the Customer entity class, the IDE generates a container resource called CustomersResource and an item resource called CustomerResource. Also, for each resource class, the IDE generates a converter class used for generating the resource representation from the corresponding entity instance, such as CustomersConverter and CustomerConverter. Furthermore, there is an additional converter class called reference converter, such as CustomerRefConverter, for representing relationships.
Click Finish.
Look in the Projects window. You now see the following:
The RESTful Web Services node in the Projects window displays all the RESTful web services in your project. The value between the square brackets, such as [/customers/], is the value for the URI template. You can also navigate to the source file by doubling clicking on this node. This view also displays all the HTTP methods and Sub-resource locator methods. Again, you can navigate to the methods by double clicking on the nodes.
Now test your application. The IDE provides a useful utility for testing RESTful web services. You will make use of it in the next section.
The goal of this exercise is to try out your application.
If the output window shows an error message that one or more classes fails to exist and the project does not build, add the Jersey libraries to the compile-time libraries. Right-click the project node and select Properties. In the Properties tree menu, select Libraries. Click Add Library and browse for the Jersey libraries.
On the left-hand side is the set of root resources. Here they are named customers and discountCodes.
Click the customers node. The browser window shows you a list of parameters for testing the Customers service.
You can set the following parameters:
There are 4 tabs in the Test Output section.
Note that you have 6 results listed although you specified a maximum of 3 entities to display. Open the Raw View tab to see the reason why. Each entity corresponds to a <customer> element, and you have only 3 customers in the test results. However, the Tablular view lists URIs, not entities, and each entity has two URIs, one as an attribute of the parent <customer> element and one as an attribute of the child <discountCode> element. So although there are only 3 customer entities, there are 6 URIs in total.
Exit the browser and return to the IDE.The goal of this exercise is to add Google map functionality to our RESTful web services.
@GET
@Produces("text/html")
public String getGoogleMap() {
// Drag and drop the getGoogleMap operation here
return "";
}
Sign up for a Google map key at http://www.google.com/apis/maps/signup.html. The Google map key request dialog has a field for your website's URL. Type http://localhost:8080 in that field. In the IDE, open the Services tab and expand the Web Services node. Under Web Services, expand Google. Under Google, expand Map Service.
Drag the getGoogleMap item and drop it into the body of the getGoogleMap method you created in Step 2, just before the return = null; line. The Customize getGoogleMap SAAS dialog opens. Accept the defaults and click OK.
The IDE adds the following try block to the getGoogleMap method in the CustomerResource class.
@GET
@Produces("text/html")
public String getGoogleMap() {
// Drag and drop the getGoogleMap operation here
try {
String address = "16 Network Circle, Menlo Park";
java.lang.Integer zoom = 15;
String iframe = "false";
RestResponse result = GoogleMapService.getGoogleMap(address, zoom, iframe);
//TODO - Uncomment the print Statement below to print result.
//System.out.println("The SaasService returned: "+result.getDataAsString());
} catch (Exception ex) {
ex.printStackTrace();
}
return "";
}
The IDE also creates the packages org.netbeans.saas and org.netbeans.saas.google, which contain the following classes and resources:
In the try block of getGoogleMap(), replace the commented-out print statement with the line return result.getDataAsString();. The method now looks like this:
@GET
@Produces("text/html")
public String getGoogleMap() {
// Drag and drop the getGoogleMap operation here
try {
String address = "16 Network Circle, Menlo Park";
java.lang.Integer zoom = 15;
String iframe = "false";
RestResponse result = GoogleMapService.getGoogleMap(address, zoom, iframe);
return result.getDataAsString();
} catch (Exception ex) {
ex.printStackTrace();
}
return "";
}
Open googlemapservice.properties. Paste in the API key you got from Google in Step 3. Right-click the CustomerDB project node and select Test RESTful Web Services. The IDE undeploys and redeploys your project to the server and then opens a browser window with the test client. Click customers in the left sidebar. Test criteria for customers open in the main pane. Leave the defaults and click Test. A table of customers opens. From the table, click customer1. A test window for that customer opens in the main pane. From the drop-down menu, select the text/html MIME type. Click Test. The GoogleMap of 16 Network Circle, Menlo Park opens in the Raw View.
The Google map of the Menlo Park address appears for all customers in the database. To display the Google maps of the actual addresses of the customers, create an instance of Customer for each entity in the database and set the address equal to a concatenation of address variables for each Customer. If you are using an earlier version of the IDE than 6.5, also add a line at the end of the try block to close the instance of Customer. The method now looks like the following (changes in bold):
@GET
@Produces("text/html")
public String getGoogleMap() {
try {
Customer c = getEntity();
String address = c.getAddressline1() + " " + c.getAddressline2() + " " +
c.getCity() + " " + c.getState() + " " + c.getZip();
java.lang.Integer zoom = 15;
String iframe = "false";
RestResponse result = GoogleMapService.getGoogleMap(address, zoom, iframe);
return result.getDataAsString();
} catch (Exception ex) {
ex.printStackTrace();
}
//The close() method is only necessary with versions of NetBeans IDE earlier than 6.5
finally {
PersistenceService.getInstance().close();
}
return "";
}
Test the RESTful web services again. Again, select the text/html MIME type for one of the customers. A Google map of that customer's address in the database now displays in the Raw View. For customer1, the following map displays:
Note: If GoogleMaps cannot find an address, it shows a zoomed in view of the ocean.
Starting in NetBeans IDE 6.5 and Jersey 0.8, Jersey is integrated into the Spring Framework. When you create a Java Web application with the Spring framework, a REST-aware servlet is automatically created. The user does not need to perform any additional steps.
To create RESTful Web Services with the Spring framework, repeat the procedures described in the tutorial, with one exception. When you create the Java Web application in the New Project wizard as described in Generating Entity Classes from a Database, after you select the server, click Next instead of Finish. This opens the Frameworks panel. Select Spring Web MVC, then click Finish.
After you create the RESTful services, note the following differences between the Spring project and the project you created without Spring:
Both of these differences are due to the Spring framework handling transactions and entity management, whereas in the other project the IDE had to create a class that used javax.transaction.UserTransaction and javax.persistence.EntityManager. The Spring framework results in cleaner code and more efficient transaction handling and entity management.
For more about the features of Spring framework projects in NetBeans IDE, see Introduction to the Spring Framework.
For more information about using NetBeans IDE to develop Java EE applications, see the following resources:
To send comments and suggestions, get support, and keep informed on the latest developments on the NetBeans IDE Java EE development features, join the mailing list.
You are viewing a mobilized version of this site...
View original page here