Version @version@ built on @builddate@.
Release Notes for Vaadin @version@
Vaadin @version@ is a maintenance release for Vaadin 6.5. It contains several important fixes.
Change Log, Future Releases, and Upgrading
See this list of closed tickets for a full list of tickets fixed in this release.
Problem fixes and enhancements planned for upcoming releases can be found in the Vaadin Roadmap in Vaadin Trac.
As always, when upgrading from an earlier version, you should recompile any custom widget sets and refresh your project in Eclipse. If you are upgrading from earlier than 6.3.0, notice that Vaadin 6.5 uses GWT 2.1 (included in the installation package). See General Upgrade Notes for more details on upgrading.
Upgrading from Vaadin 6.0 or 6.1
The way how widget sets are defined was simplified 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. For most projects this should be a quite painless upgrade.
For applications where custom widgets are used (also applicable to widget projects):
- Remove the getTag() method from all components and replace it with a @ClientWidget(VClientSideWidget.class) annotation. Tag names are no longer used to map the server-side and client-side part of the component. This is done automatically using the @ClientWidget annotation.
- Remove the WidgetSet.java file. This file is no longer needed as the mapping between the server- and the client-side is done automatically using @ClientWidget.
If you are using widgets from another project (typically in a separate JAR file):
- Acquire a new JAR which is compatible with Vaadin 6.3 and add it to WEB-INF/lib. The widget set compilation will automatically include the JAR in your .gwt.xml during compilation if you use the Eclipse Compile Widget Set button. For Ant/Maven you need to specify the location of the widget set JARs that you want to include in the application widget set.
If you package a widget set as a JAR for use in other projects:
- Replace getTag() with @ClientWidget and remove the -WidgetSet.java as described above.
- Add a "Vaadin-Widgetsets: <fully qualified name of widgetset>" (e.g. "Vaadin-Widgetsets: com.example.widgetset.mywidgetset") row to the META-INF/MANIFEST.MF of the JAR file. This enables the widget set builder to automatically detect and include the widget set in other projects.
General Upgrade Notes
When upgrading from an earlier version of the Vaadin library, you should always do the following:
- Install the new Vaadin JAR to your project
- If using the Vaadin Plugin in Eclipse, download and select the new version in project preferences.
- Install new GWT JARs if the GWT version has changed
- The Eclipse plugin will automatically download the new GWT and update launch configurations and the project build path when you update the Vaadin version.
- If you have custom widget sets, recompile them with the new Vaadin library using the included GWT compiler
- If using the Eclipse IDE:
- Refresh the Eclipse project by selecting the project folder and pressing F5
- Restart the application server
Using the Vaadin project facet in the Eclipse IDE does the steps 1 and 2 automatically.
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
Important known problems in Vaadin @version@
#1155: Uncompressing the installation package fails in Windows if using the default Zip uncompression. Uncompression gives (in Windows Vista) an error message about too long filenames, and a more obscure message in other versions of Windows. Workaround: use 7-Zip or some other good unzip program for Windows.
For other known problems, see open tickets at developer site dev.vaadin.com.
Requirements
Vaadin is available for the following operating systems:
- Windows (see the Zip installation notice above)
- Linux
- Mac OS X Tiger (mac) or Leopard (leopard)
- Other UNIX operating systems, such as Sun Solaris
Vaadin supports Java Servlet API 2.3 and later versions and should work with any Java application server that conforms to the standard. It supports the following application servers:
- Apache Tomcat, version 4.1 or later
- BEA WebLogic® Server, version 9.2 or later
- IBM WebSphere® Application Server, version 6.1 or later
- JBoss Application Server, version 3.2.8 or later
- Jetty, version 5 or later
- Glassfish, version 2 or later
Vaadin supports the following browsers for using the applications made with it:
- Mozilla Firefox 3
- Internet Explorer releases 6, 7, and 8
- Safari 3, 4 and 5
- Opera 10
- Google Chrome 5
The support for browsers follows the support by GWT. The browsers are supported on both Windows and Mac, if available. Firefox is supported also on Linux. There may be differences between the exact versions of the supported browsers that may cause incompatibility with applications made with Vaadin.
The following browsers are not supported but have been found to work to a large degree:
- Safari 2
- Firefox 2
- Older versions of Google Chrome
- iPhone (firmware 2.2)
- Midori (0.1.2)
- Epiphany (2.22.3), Galeon, and other Gecko-based browsers. Also WebKit-based Epiphany (2.22.3) works.
- Konqueror 4.2 (3.5.x does not work)
- Nokia Internet Tablet N800 and N810 (ITOS 2008, Opera-based browser).
The reported versions are those that have been tested, though other versions may work as well.
Nokia E-series phones, such as E90, have been known to work with older versions, but not with Vaadin 6. Links, Lynx, and other text-based browsers do not work.