Setting up a project

Client Side

To use Restlet-GWT on the client side of your GWT application (Figure 2-5 above):

1) Create an application normally with the applicationCreator and/or projectCreator scripts supplied with GWT, or using your favorite GWT design or IDE plugins.

2) Add the Restlet-GWT JAR (org.restlet.gwt.jar) to the project classpath [explain]

3) Add the following to your application's module definition file (yourapp.gwt.xml):

<inherits name='org.restlet.GWT'/>

This will make the Restlet-GWT API available to your GWT compiled code.  The Restlet-GWT module in turn inherits the GWT standard HTTP, JSON, and XML modules. You can also check the full Javadocs of the API online.

Hosted Mode

If you would like to debug your application in hosted mode using Restlet on the server side as well (Figure 4 above), you must also modify the GWT-generated web.xml file in hosted mode's tomcat/webapps/WEB-INF directory.  GwtShellServletWrapper, provided by the Noelios GWT Extension (com.noelios.restlet.ext.gwt_1.5.jar) extends ServerServlet and shares its semantics, but also knows how to pass Hosted Mode requests to the GWT Shell Servlet.

1) Add com.noelios.restlet.ext.gwt_1.5.jar, org.restlet.jar, com.noelios.restlet.jar, and com.noelios.restlet.ext.servlet_2.5.jar to the project classpath [explain].  Also, be sure to add any other Restlet extension JARs necessary for extensions you plan to use on the server side.

2) Modify the web.xml to use the GwtShellServletWrapper:

<?xml version="1.0" encoding="UTF-8"?>
<web-app>

	<servlet>
		<servlet-name>adapter</servlet-name>
		<servlet-class>com.noelios.restlet.ext.gwt.GwtShellServletWrapper</servlet-class>
		<init-param>
		  <param-name>org.restlet.application</param-name>
		  <param-value>application</param-value>
		</init-param>
		<init-param>
		  <param-name>module</param-name>
		  <param-value>module</param-value>
		</init-param>
	</servlet>
	
	<servlet-mapping>
		<servlet-name>adapter</servlet-name>
		<url-pattern>/*</url-pattern>
	</servlet-mapping>

</web-app>

For application, supply the name of your Restlet Application, e.g. org.restlet.test.gwt.server.TestApplication.  You can also supply a component via an org.restlet.component parameter, or any other permitted ServerServlet configuration parameter.

The module should be the name of your GWT module as seen in the hosted mode URI path.  This is the package name plus the base filename of your GWT module file, e.g. org.restlet.test.gwt.TestClient.

The web.xml file can be overwritten by GWT Hosted Mode in some situations.  If your Restlet server side functionality fails and you start receiving messages about server requests being incorrectly dispatched to an unknown module, check that the web.xml file still contains valid contents.

Comments (0)
Navigation doc: view