Google App Engine Integration · Vaadin
Vaadin Framework - Advanced Topics - Google App Engine Integration
 Edit This Page

Google App Engine Integration

This section is not yet fully updated to Vaadin 7.

Vaadin includes support to run Vaadin applications in the Google App Engine (GAE). The most essential requirement for GAE is the ability to serialize the application state. Vaadin applications are serializable through the interface.

To run as a GAE application, an application must use GAEVaadinServlet instead of VaadinServlet, and of course implement the interface for all persistent classes. You also need to enable session support in appengine-web.xml with:


The Vaadin Project wizard can create the configuration files needed for GAE deployment. See Creating the Project. When the Google App Engine deployment configuration is selected, the wizard will create the project structure following the GAE Servlet convention instead of the regular Servlet convention. The main differences are:

  • Source directory: src/main/java

  • Output directory: war/WEB-INF/classes

  • Content directory: war

Rules and Limitations

Running Vaadin applications in Google App Engine has the following rules and limitations:

  • Avoid using the session for storage, usual App Engine limitations apply (no synchronization, that is, it is unreliable).

  • Vaadin uses memcache for mutex, the key is of the form _vmutex<sessionid>.

  • The Vaadin WebApplicationContext class is serialized separately into memcache and datastore; the memcache key is _vac<sessionid> and the datastore entity kind is _vac with identifiers of the type _vac<sessionid>.

  • Do not update the application state when serving an ConnectorResource (such as ClassResource. getStream()).

  • Avoid (or be very careful when) updating application state in a TransactionListener - it is called even when the application is not locked and won’t be serialized (such as with ConnectorResource), and changes can therefore be lost (it should be safe to update things that can be safely discarded later, that is, valid only for the current request).

  • The application remains locked during uploads - a progress bar is not possible.