summaryrefslogtreecommitdiffstats
path: root/WebContent/release-notes.html
blob: 65ad783606f01882c6c30909f845508f49ddca9e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <title>Vaadin @version@</title>
        <link rel="stylesheet" type="text/css" href="demo/css/styles.css" />

        <!--[if lte IE 6]>
		<link rel="stylesheet" type="text/css" href="demo/css/ie.css" />
		<![endif]-->
    </head> <!-- /head -->
    <body>

		<div id="header">
			<h1>Vaadin &ndash; thinking of U and I</h1>
			<div id="version">
                <strong>Version @version@</strong>
				<a href="javascript:history.go(-1);" title="Back to index page">&laquo; Back</a>
			</div>
		</div> <!-- /header -->

<div id="content">

<p>Version @version@ built on @builddate@.</p>

<h2 id="overview">Release Notes for Vaadin @version@</h2>

<ul>
  <li><a href="#overview">Overview</a></li>
  <li><a href="#upgrading">General Upgrade Notes</a></li>
  <li><a href="#known-problems">Important known problems in Vaadin @version@</a></li>
  <li><a href="#requirements">Requirements</a></li>
</ul>

<p>Vaadin @version@ is a maintenance release for Vaadin 6.5. It contains several important fixes.</p>

<h3>Change Log, Future Releases, and Upgrading</h3>

<p>See this <a href="http://dev.vaadin.com/query?status=closed&group=resolution&order=priority&col=id&col=summary&col=owner&col=type&col=priority&col=component&col=version&milestone=Vaadin+@version@">list of closed tickets</a> for a
full list of tickets fixed in this release.</p>

<p>Problem fixes and enhancements planned for upcoming releases can be found in the <a
href="http://dev.vaadin.com/roadmap">Vaadin Roadmap</a> in Vaadin Trac.</p>

<p>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
<a href="#upgrading">General Upgrade Notes</a> for more details on upgrading.</p>

<h2 id="widgetupgrade">Upgrading from Vaadin 6.0 or 6.1</h2>

<p>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.</p>

<p>
For applications where custom widgets are used (also applicable to widget projects):
<ul>
<li>Remove the <i>getTag()</i> method from all components and replace it with a <tt>@ClientWidget(VClientSideWidget.class)</tt> 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 <tt>@ClientWidget</tt> annotation.</li>
<li>Remove the <tt>WidgetSet.java</tt> file. This file is no longer needed as the mapping between the server- and the client-side is done automatically using <tt>@ClientWidget</tt>.</li>
</ul>
</p>
<p>
If you are using widgets from another project (typically in a separate JAR file):
<ul>
<li>Acquire a new JAR which is compatible with Vaadin 6.3 and add it to <tt>WEB-INF/lib</tt>. The widget set compilation will automatically include the JAR in your <tt>.gwt.xml</tt> during compilation if you use the Eclipse <b>Compile Widget Set</b> 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.</li>
</ul>
</p>
<p>
If you package a widget set as a JAR for use in other projects:
<ul>
	<li>Replace <tt>getTag()</tt> with <tt>@ClientWidget</tt> and remove the <tt>-WidgetSet.java</tt> as described above.</li>
    <li>Add a &quot;Vaadin-Widgetsets: &lt;fully qualified name of widgetset&gt;&quot; (e.g. &quot;Vaadin-Widgetsets: com.example.widgetset.mywidgetset&quot;) 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.</li>
</ul>
</p>

<h2 id="upgrading">General Upgrade Notes</h2>

<p>When upgrading from an earlier version of the Vaadin library, you should always do the following:</p>

<ol>
  <li>Install the new Vaadin JAR to your project</li>
  <ul>
    <li>If using the Vaadin Plugin in Eclipse, download and select the new version in project preferences.</li>
  </ul>
  <li>Install new GWT JARs if the GWT version has changed</li>
  <ul>
    <li>The Eclipse plugin will automatically download the new GWT and update launch configurations and the project build path when you update the Vaadin version.</li>
  </ul>  
  <li>If you have custom widget sets, recompile them with the new Vaadin library using the included GWT compiler</li>
  <li>If using the Eclipse IDE:
  <ol type="a">
    <li>Refresh the Eclipse project by selecting the project folder and pressing <strong>F5</strong></li>
    <li>Restart the application server</li>
  </ol>
</ol>

<p>Using the Vaadin project facet in the Eclipse IDE does the steps 1 and 2 automatically.</p>

<h2 id="gae">Notes and Limitations for Google App Engine</h2>

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

<ul>
  <li><p>Applications must use <b>GAEApplicationServlet</b> instead of
  <b>ApplicationServlet</b> in <tt>web.xml</tt>.</p></li>

  <li><p>Session support must be enabled in <tt>appengine-web.xml</tt>:</p>

      <pre>    &lt;sessions-enabled&gt;true&lt;/sessions-enabled&gt;</pre>
  </li>

  <li><p>Avoid using the session for storage, usual App Engine limitations apply (no
  synchronization, i.e, unreliable).</p></li>

  <li><p>Vaadin uses memcache for mutex, the key is of the form
  <tt>_vmutex&lt;sessionid&gt;</tt>.</p></li>
  
  <li><p>The Vaadin <b>WebApplicationContext</b> class is serialized separately into memcache
  and datastore; the memcache key is <tt>_vac&lt;sessionid&gt;</tt> and the datastore
  entity kind is <tt>_vac</tt> with identifiers of the type <tt>_vac&lt;sessionid&gt;</tt>.</p></li>
  
  <li><p>DO NOT update application state when serving an <b>ApplicationResource</b> (e.g <b>ClassResource</b>.<i>getStream()</i>).</p></li>

  <li><p>AVOID (or be very careful when) updating application state in a
  <b>TransactionListener</b> or a <b>HttpServletRequestListener</b> - they are called even when the
  application is not locked and won't be serialized (e.g <b>ApplicationResource</b>), 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)</p></li>

  <li><p>The application remains locked during uploads - a progress bar is not possible</p></li>
</ul>

<h2 id="known-problems">Important known problems in Vaadin @version@</h2>

<ul>
	<li><p><a href="http://dev.vaadin.com/ticket/1155">#1155</a>:
	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 <a
		href="http://www.7-zip.org/">7-Zip</a> or some other good unzip
	program for Windows.</p></li>
</ul>

<p>For other known problems, see open tickets at developer site <a
	href="http://dev.vaadin.com/">dev.vaadin.com</a>.</p>

<h2 id="requirements">Requirements</h2>

<p>Vaadin is available for the following operating systems:</p>

<ul>
	<li>Windows (see the Zip installation notice above)</li>

	<li>Linux</li>

	<li>Mac OS X Tiger (mac) or Leopard (leopard)</li>

	<li>Other UNIX operating systems, such as Sun Solaris</li>
</ul>

<p>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:</p>

<ul>
    <li>Apache Tomcat, version 4.1 or later</li>
    <li>BEA WebLogic&reg; Server, version 9.2 or later</li>
    <li>IBM WebSphere&reg; Application Server, version 6.1 or later</li>
    <li>JBoss Application Server, version 3.2.8 or later</li>
    <li>Jetty, version 5 or later</li>
    <li>Glassfish, version 2 or later</li>
</ul>

<p>Vaadin supports the following browsers for using the applications made with
it:</p>

<ul>
	<li>Mozilla Firefox 3</li>
	<li>Internet Explorer releases 6, 7, and 8</li>
	<li>Safari 3, 4 and 5</li>
	<li>Opera 10</li>
	<li>Google Chrome 5</li>
</ul>

<p>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.</p>

<p>The following browsers are not supported but have been found to
work to a large degree:</p>

<ul>
	<li>Safari 2</li>
	<li>Firefox 2</li>
    <li>Older versions of Google Chrome</li>
	<li>iPhone (firmware 2.2)</li>
    <li>Midori (0.1.2)</li>
	<li>Epiphany (2.22.3), Galeon, and other Gecko-based browsers. Also WebKit-based Epiphany (2.22.3) works.</li>
    <li>Konqueror 4.2 (3.5.x does not work)</li>
    <li>Nokia Internet Tablet N800 and N810 (ITOS 2008, Opera-based browser).</li>
</ul>

<p>The reported versions are those that have been tested, though other versions may work
as well.</p>

<p>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.</p>

</div> <!-- /content-->


<div id="footer">
	<span class="slogan"><strong>vaadin <em>}></em></strong> thinking of U and I<span> <a href="#top">&uarr; Back to top</a>
</div> <!-- /footer -->

</body>
</html>