COMP REST Programming in Eclipse

Transcription

1 COMP 4601 REST Programming in Eclipse

2 The Context We are building a RESTful applicabon that allows interacbon with a Bank containing bank account. The applicabon will be built using Eclipse. NEON JDK 1.7 (or later) Jersey 1.19 or 2.25 (jersey.java.net)

3 Jersey Is an implementabon of JAX-RS JSR 311 Version 1.19 supports 1.1 JAX-RS API Implements a parbcular RESTful style

4 Start You will need to download Tomcat (tomcat.apache.org) V7 (or V9) Eclipse (eclipse.org) NEON or later Jersey (jersey.java.net/download.html) 1.19 You will have to configure Tomcat h]ps://code.google.com/p/gbif-providertoolkit/ wiki/tomcatinstallabonmacosx (on Mac) h]p://tomcat.apache.org/tomcat-7.0-doc/ setup.html

5 Video! h]p://

6 NOTICE: IN SLIDES WHICH FOLLOW, REPLACE COMP4104 WITH COMP4601

7 StarBng First RESTful Project Create a Dynamic Web Project. Let s say, COMP4104FirstBank For Context Root this will default to this value. Ensure that you check the generate web.xml deployment descriptor box.

8 Step 2: Configuring Libraries Import the Jersey archive lib directory to the WebContent/WEB-INF directory. When done, your directory should look like this: You will have 1.19 but will be very similar

9 Step 3: CreaBng a Bank Create a class called Bank in the edu.carleton.comp4104.simple package Import all of the javax.ws.rs.* classes This will allow you to AnnotaBons allow us to use plain old java classes in our web applicabons

10 Result The Path annotabon tells REST the path to the resource. It combines the root context with this informabon. So, our path is: hlp://localhost:8080/comp4104firstbank/rest/bank

11 Step 4: Adding Content We want to add methods to our plain old java object (POJO) that allows for RESTful interacbon. Let s GET something. We use annotabons again.

12 Step 4: More Formats

13 Step 5: Seong up a Server Have to create a Tomcat server instance to run this applicabon against.

14 Step 4: Choosing Tomcat

15 Step 5: Add and Remove Resources Add the COMP4104FirstBank resource to the Configured column. This will allow the web project to run on the Tomcat server you have installed.

16 Step 5: CreaBng a web.xml We need to tell tomcat about our RESTful resource Tomcat also needs to know the container which will run our POJO

17 Architecture Tomcat Client Servlet HTTP POJO Client sends HTTP request that is Processed by a servlet a container which dispatches the request to our POJO that will process the actual request. In Jersey, the class implemenbng the Servlet container is: com.sun.jersey.spi.container.servlet.servletcontainer

18 Step 5: web.xml So, edit the web.xml file in WEB-INF. Use the XML wizard for this.

19 Step 5: web.xml <servlet-name> Just a user-friendly display name (must be unique)

20 Step 5: web.xml <display-name> This is used to determine path. So, for COMP4104FirstBank We will use h]p://localhost:8080/comp4104firstbank/rest/

21 Step 5: web.xml <servlet-class> This is the class within Jersey that is the servlet container which runs your RESTful code.

22 Step 5: web.xml <param-name> Must be com.sun.jersey.config.property.packages. <param-value> This contains the package where all resources are to be found.

23 Step 5: web.xml <servlet-name> Just needs to correspond to servlet-name used earlier. <url-pa]ern> Added to path in order to idenbfy a resource. So, for our project the bank will be found at: h]p://localhost:8080/comp4104firstbank/rest/bank