Set up Eclipse and Tomcat 7 on Ubuntu 12.10 to create Java RESTful Web Services with Jersey

 

1. Install Eclipse and Tomcat 7 by running in a terminal:

   sudo apt-get install eclipse tomcat7 -y

2. assign the tomcat7 group to your user. Assuming your username is pippo, run:

   sudo adduser pippo tomcat7

   Note: you need to log out and log back in for the changes to take effect.

3. stop the system-wide Tomcat by running:

   /usr/share/tomcat7/bin/shutdown.sh

4. prevent the system-wide Tomcat from automatically starting at boot by running:

   sudo update-rc.d tomcat7 disable

5. install WTP (Web Tools Platform) by running Eclipse and then:
   1. from then menu Help select Install New Softare…
   2. next to Work with: open the drop down menu and select the update site of your Eclipse version
   3. select Web, XML, Java EE Development and OSGi Enterprise Development, press Next and complete the installation;
6. to configure WTP to use Tomcat 7:
   1. select Windows -> Preferences -> Server -> Runtime Environments;
   2. press Add…;
   3. select “Apache Tomcat v7.0″;
   4. enter “/usr/share/tomcat7″ into the “Tomcat installation directory” field;
   5. press Ok;
7. create a new “Dynamic Web Project”
   • as Target Runtime select “Apache Tomcat v7.0″;
   • press twice Next;
   • select the “Generate the web.xml deployment descriptor” option at the final dialog;
   • press Finish;
8. open the Servers view:
   • go to Window->Show View->Other…;
   • choose the Servers under the Server category;
9. click on new server wizard;
   • choose Apache / Tomcat v7.0 Server and press Next;
   • enter “/usr/share/tomcat7″ into the “Tomcat installation directory” field;
   • press Next;
   • select your project on the left pane under “Available” and press Add> to move it to the right pane under “Configured”;
   • press Finish”;
10. download the zip of Jersey;
11. put the the jersey jars into the folder “WEB-INF/lib” and add them to the project build path;
12. create your first RESTful Webservice by following this tutorial by Lars Vogel.

Your web services will be automatically deployed in the following folder:

~/workspace/.metadata/.plugins/org.eclipse.wst.server.core/tmp0/wtpwebapps/

Your web service will be accessible through the following URI:

http://localhost:8080/UrlPattern/ClassPath/methodPath

Where:

1. UrlPattern = the root of your service set inside the tag url-pattern in the web.xml;
2. ClassPath = the path set for your class
3. methodPath = the path set for your method

All the files you put in your WebContent folder will be accessible via http through the following URI:

http://localhost:8080/UrlPattern/yourfile

Note: make sure the tag url-pattern in the web.xml is set to something like this:

<url-pattern>/rest/*</url-pattern>

and not something like this:

<url-pattern>/*</url-pattern>

Troubleshooting

• to fix the error “Cannot create a server using the selected type” assign the tomcat7 group to your user. Assuming your username is pippo, run:

  sudo adduser pippo tomcat7
  cd ~/workspace/.metadata/.plugins/org.eclipse.core.runtime/.settings/    
  rm org.eclipse.jst.server.tomcat.core.prefs    
  rm org.eclipse.wst.server.core.prefs

• to fix the error “Could not load the Tomcat server configuration at /usr/share/tomcat7/conf. The configuration may be corrupt or incomplete. /usr/share/tomcat7/conf/catalina.policy (No such file or directory)” assign the tomcat7 group to your user. Assuming your username is pippo, run:

  sudo adduser pippo tomcat7

• to fix the error “Could not load the Tomcat server configuration at /Servers/Tomcat v7.0 Server at localhost-config. The configuration may be corrupt or incomplete” assign the tomcat7 group to your user. Assuming your username is pippo, run:

  sudo adduser pippo tomcat7

About these ads