Vaadin Framework @version@

Version @version@ built on @builddate@.

Release Notes for Vaadin Framework @version@

Package contents
Enhancements in Vaadin @version-minor@
Fixes in Vaadin @version@
Backwards incompatible changes in Vaadin @version-minor@
Vaadin @version@ dependencies
Upgrading to Vaadin @version-minor@
Known problems and limitations in Vaadin @version@
Supported technologies
Vaadin on the Web

Package Contents

Vaadin is a Java framework for building modern web applications that look great, perform well and make you and your users happy. Vaadin is available under the Apache 2 license (see license.html).

Vaadin is distributed as a single JAR file. Inside the JAR you will find:

Vaadin server and client side classes (/com)
Vaadin server and client side sources (/com)
The default widget set (/VAADIN/widgetsets)
Themes: Runo, Reindeer and Chameleon (/VAADIN/themes)
Release notes (/release-notes.html)
Licensing information (/license.html)

Enhancements in Vaadin @version-minor@

TODO: Enhancements

TOdO: Enhancements.

Fixes in Vaadin @version@

TODO: Ticket list

The full details of the defects can be found at dev.vaadin.com.

Backwards incompatible changes in Vaadin @version-minor@

VerticalSplitPanel and HorizontalSplitPanel position is now a float instead of an int to enable defining an exact position when using percentages.

Vaadin @version@ dependencies

Vaadin uses GWT @gwt-version@ for widget set compilation. GWT can be downloaded from http://code.google.com/webtoolkit/. GWT can also be automatically downloaded by the Vaadin Plug-in for Eclipse. Please note that GWT @gwt-version@ requires the validation-api-1.0.0.GA.jar and validation-api-1.0.0.GA-sources.jar files in addition to gwt-dev.jar and gwt-user.jar for widget set compilation.

Upgrading to Vaadin @version-minor@

When upgrading from an earlier Vaadin version, you must

Recompile your classes using the new Vaadin JAR. Binary compatibility is only guaranteed for maintenance releases of Vaadin.
Recompile any add-ons you have created using the new Vaadin JAR.
Recompile your widget set using the new Vaadin JAR and the newly compiled add-ons.
If you have extracted a theme from the Vaadin JAR, you need to update it with the theme provided in the new Vaadin JAR.

Remember also to refresh the project in your IDE to ensure that the new version of everything is in use.

Using the "?debug" URL parameter you can verify that the version of the servlet (JAR), the theme and the widgetset all match.

Eclipse users should always check if there is a new version of the Eclipse Plug-in available. The Eclipse Plug-in can be used to update the Vaadin version in the project (Project properties » Vaadin).

Maven users should update the Vaadin dependency version in the pom.xml unless it is defined as LATEST . You must also ensure that the GWT dependency uses the correct version and recompile your project and your widget set.

Liferay and other portal users must install the new vaadin-@version@.jar as ROOT/WEB-INF/lib/vaadin.jar in the portal. Additionally the contents of the VAADIN folder from the JAR must be extracted to the ROOT/html/VAADIN directory in the Liferay installation. If your portal uses custom widgets, install the latest version of Vaadin Control Panel for Liferay for easy widget set compilation.

Upgrading from Vaadin 6.5 or earlier

If you are upgrading from 6.5.x or earlier, notice that Vaadin @version@ uses GWT @gwt-version@. Upgrade your dependencies as necessary. See the dependencies section for more information.

Upgrading from Vaadin 6.1 or earlier

The way widget sets are created was completely changed in Vaadin 6.2. Existing projects, where custom widgets (a custom widget set) are used, must be migrated when upgrading to Vaadin 6.2 or later. Projects where the default widget set is used do not need migration. See Vaadin 6.2.0 release notes for more details.

Notes and Limitations for Google App Engine

The following instructions and limitations apply when you run a Vaadin application under the Google App Engine.

Applications must use GAEApplicationServlet instead of ApplicationServlet in web.xml .
Session support must be enabled in appengine-web.xml :
```
    <sessions-enabled>true</sessions-enabled>
```
Avoid using the session for storage, usual App Engine limitations apply (no synchronization, i.e, 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 application state when serving an ApplicationResource (e.g ClassResource.getStream()).
AVOID (or be very careful when) updating application state in a TransactionListener or a HttpServletRequestListener - they are called even when the application is not locked and won't be serialized (e.g ApplicationResource), and changes can thus go missing (it should be safe to update things that can be safely discarded later - i.e valid only for the current request)
The application remains locked during uploads - a progress bar is not possible

For other known problems, see open tickets at developer site dev.vaadin.com.

Supported technologies

Vaadin is based on Java 5 and it is also compatible with most other operating system supporting Java 5 or newer. Vaadin is supported on the following operating systems:

Windows (see the Zip installation notice above)
Linux
Mac OS X

Vaadin requires Java Servlet API 2.3 but also supports later versions and should work with any Java application server that conforms to the standard. The following application servers are supported:

Apache Tomcat, version 4.1-7.0
Oracle WebLogic® Server, version 9.2-10.3.5(11gR1)
IBM WebSphere® Application Server, version 6.1-8.0
JBoss Application Server, 3.2.8-7.0
Jetty, version 5.0-7.0
Glassfish, version 2.0-3.1

Vaadin supports JSR-168 and JSR-286 Portlet specifications. All portals that implement either of the portlet specifications should work. The following portals are supported: