Skip to Content

Version 22.1 by Thomas Mortagne on 2015/06/04
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 This is the release notes for [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]], [[XWiki Platform>>http://platform.xwiki.org]] and [[XWiki Enterprise>>http://enterprise.xwiki.org]]. They share the same release notes as they are released together and have the same version.
6
7 <insert description of release here>
8
9 = New and Noteworthy (since XWiki 7.1M2) =
10
11 [[Full list of issues fixed and Dashboard for <version>>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=<fill id here>]].
12
13 == New performance report improvements ==
14
15 The debug performance tree has been made a bit more dynamic to be able to open/close nodes.
16
17 {{image reference="elapsedtimetree2.png" width="650px"/}}
18
19 == Flavor ==
20
21 {{warning}}
22 This feature is experimental and you should try it only for test purpose.
23 {{/warning}}
24
25 If no default distribution is configured, [[Distribution Wizard will now let you select the flavor to install>>platform:Features.DistributionWizard||anchor="HFlavor"]].
26
27 {{image reference="dw-flavor-step1.png"/}}
28
29 == WatchList ==
30
31 {{warning}}
32 TODO
33 {{/warning}}
34
35 http://jira.xwiki.org/browse/XWIKI-11756
36
37 == New Solr search UI options ==
38
39 It's now possible to disable highlighting and faceting which are very slow tasks. Can be controlled directly from the search UI or from the Main.SolrSearchConfig document.
40
41 {{image reference="solr_options.png"/}}
42
43 See [[extensions:Extension.Solr Search Application||anchor="HSearchUIoptions"]].
44
45 == Miscellaneous ==
46
47 * The default document cache size has been increased from 100 to 500 elements
48 * Minor visual consistency improvement of the tag cloud header of the LiveTable
49
50 See the [[full list of JIRA issues>>http://jira.xwiki.org/sr/jira.issueviews:searchrequest-printable/temp/SearchRequest.html?jqlQuery=project+in+%28XCOMMONS%2C+XRENDERING%2C+XWIKI%2C+XE%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%22<version>%22&tempMax=1000]] fixed in this release.
51
52 = For Developers =
53
54 == Script oriented advanced extension search API ==
55
56 A new script oriented API has been added to use advanced extension search possibilities introduced in 7.0. See [[extensions:Extension.Extension Script Module||anchor="HSearch"]].
57
58 == Deprecated and Retired projects ==
59
60 <description of deprecated and retired projects>
61
62 == Upgrades ==
63
64 The following dependencies have been upgraded:
65
66 * [[Bootstrap 3.3.4>>http://jira.xwiki.org/browse/XWIKI-11999]]
67 * [[Bootswatch 3.3.4+1>>http://jira.xwiki.org/browse/XWIKI-12100]]
68 * [[reflections 0.9.10>>http://jira.xwiki.org/browse/XCOMMONS-808]]
69 * [[Infinispan 7.2.2>>http://jira.xwiki.org/browse/XWIKI-12138]]
70
71 == Miscellaneous ==
72
73 * Extension upgrade plan job now support checking specific list of installed extensions (instead of the top level installed extensions)
74 * You can now [[disable the automatic start of Distribution Wizard>>platform:Features.DistributionWizard||anchor="HDisabletheautomaticstartofDistributionWizard"]] with two new options.
75 * It's possible to disable minification from xwiki.properties configuration file. Set ##debug.minify## to ##false##.
76
77 = Translations =
78
79 The following translations have been updated:
80
81 {{language codes="none, none"/}}
82
83 = Tested Browsers & Databases =
84
85 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
86
87 = Performances tests compared to <last super stable version> =
88
89 <a summary of the comparison with latest super stable version>
90
91 More details on <link to the test report>.
92
93 = Known issues =
94
95 * [[Bugs we know about>>http://jira.xwiki.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=category+%3D+%22Top+Level+Projects%22+AND+issuetype+%3D+Bug+AND+resolution+%3D+Unresolved+ORDER+BY+updated+DESC]]
96
97 = Backward Compatibility and Migration Notes =
98
99 == General Notes ==
100
101 When upgrading make sure you compare your ##xwiki.cfg##, ##xwiki.properties## and ##web.xml## files with the newest version since some configuration parameters may have been modified or added. Note that you should add ##xwiki.store.migration=1## so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.
102
103 == Mail API changes ==
104
105 The young mail API has been refactored to provide better and more detailed error reporting.
106
107 The MailState enumeration has been extended to report more detailed mail state (##prepare_success##, ##prepare_error##, ##send_success##, ##send_error## and ##send_fatal_error##). The MailListener interface has been extended to provide more detailed event. Now each mail batch should use new independent listener. The listener receive the batch identifier of its own batch when the mail preparation starts (###onPrepareBegin()##), and have to keep it for all subsequent events. Independent success and error events for both the prepare and send phases are provided for each message (###onPrepareMessageSuccess()##, ###onPrepareMessageError()##, ###onSendMessageSuccess()##, ###onSendMessagError()##). Moreover, premature interruption of the prepare phase is caught and reported (###onPrepareFatalError##). Inability of the send phase to retrieve a message for sending is also explicitly reported (###onSendMessageFatalError()##).
108
109 There is now more than one message state representing an error, therefore, the MailStatusResult interface has been extended with a ###getAllError()## method to retrieve all message status in error. Moreover, the ###getTotalMailCount()# may represent a partial total in case of failure of the prepare phase. In that case, it represents the number of mails sent to the send phase. As a consequence, ###isProcessed()# and ###waitTillProcess()# now considerer the batch to be processed when all successfully prepared mail has been sent, or failed to be prepared or sent.##
110
111 The mail API is now tracking individual message based on the standard Message-ID headers, which made it fully compliant with RFC-822 WRT the mail identification. Caller that want to specify custom Message-ID may do so by extending MimeMessage to preserve the Message-ID of the message. Caller is also responsible to ensure that different messages are identified by unique message identifier.
112
113 {{warning}}
114 Sending multiple messages with the same Message-ID is no more supported since it does not respect the RFC-822 standard.
115 {{/warning}}
116
117 Reusing the same Message-ID for retrying a failed message is allowed and will be tracked by the same status if the batch identifier is also reused.
118
119 == API Breakages ==
120
121 The following APIs were modified since XWiki 7.0.1:
122
123 * Add support for advanced search(((
124 {{code language="none"}}
125 org.xwiki.extension.repository.ExtensionRepositoryManager: Method 'public org.xwiki.extension.repository.result.IterableResult search(org.xwiki.extension.repository.search.ExtensionQuery)' has been added to an interface
126 {{/code}}
127 )))
128 * Add support for named steps(((
129 {{code language="none"}}
130 org.xwiki.job.event.status.JobProgress: Method 'public org.xwiki.job.event.status.JobProgressStep getCurrentStep()' has been added to an interface
131 org.xwiki.job.event.status.JobProgress: Method 'public org.xwiki.job.event.status.JobProgressStep getRootStep()' has been added to an interface
132 org.xwiki.job.event.status.JobProgressManager: Method 'public void endStep(java.lang.Object)' has been added to an interface
133 org.xwiki.job.event.status.JobProgressManager: Method 'public void pushLevelProgress(java.lang.Object)' has been added to an interface
134 org.xwiki.job.event.status.JobProgressManager: Method 'public void startStep(java.lang.Object)' has been added to an interface
135 org.xwiki.job.event.status.JobProgressManager: Method 'public void startStep(java.lang.Object, java.lang.String)' has been added to an interface
136 org.xwiki.job.event.status.JobProgressManager: Method 'public void startStep(java.lang.Object, java.lang.String, java.lang.String, java.lang.Object[])' has been added to an interface
137 org.xwiki.job.event.status.JobProgressManager: Method 'public void startStep(java.lang.Object, org.xwiki.logging.Message)' has been added to an interface
138 {{/code}}
139 )))
140 * Add new helper(((
141 {{code language="none"}}
142 org.xwiki.job.event.status.JobProgressManager: Method 'public java.lang.Object call(java.util.concurrent.Callable, java.lang.Object)' has been added to an interface
143 org.xwiki.job.event.status.JobProgressManager: Method 'public java.lang.Object call(java.util.concurrent.Callable, int, java.lang.Object)' has been added to an interface
144 {{/code}}
145 )))
146 * Add a new method to this young API(((
147 {{code language="none"}}
148 org.xwiki.skin.Skin: Method 'public org.xwiki.rendering.syntax.Syntax getOutputSyntax()' has been added to an interface
149 {{/code}}
150 )))
151 * Not really been removed but now return Object. Breaks code building that use this method but should be ok for runtime.(((
152 {{code language="none"}}
153 com.xpn.xwiki.XWiki: Method 'public com.xpn.xwiki.render.XWikiRenderingEngine getRenderingEngine()' has been removed
154 {{/code}}
155 )))
156 * Not used since a long time now (XWikiRenderingEngine is a component) and impossible to implement it without a trigerring most of the old rendering engine.(((
157 {{code language="none"}}
158 com.xpn.xwiki.XWiki: Method 'public void setRenderingEngine(com.xpn.xwiki.render.XWikiRenderingEngine)' has been removed
159 {{/code}}
160 )))
161 * Young API. Added handling of URL parameters(((
162 {{code language="none"}}
163 org.xwiki.url.ExtendedURL: In method 'public ExtendedURL(java.net.URL)' the number of arguments has changed
164 {{/code}}
165 )))
166 * Never supposed to be an API(((
167 {{code language="none"}}
168 com.xpn.xwiki.plugin.scheduler.StatusListener: Class com.xpn.xwiki.plugin.scheduler.StatusListener removed
169 {{/code}}
170 )))
171 * Young API. Remove useless Session argument since the MimeMessage will be given a valid Session when it's deserialized from the mail content store for sending.(((
172 {{code language="none"}}
173 org.xwiki.mail.MimeMessageFactory: In method 'public java.lang.Object createMessage(javax.mail.Session, java.lang.Object, java.util.Map)' the number of arguments has changed
174 {{/code}}
175 )))
176 * Young API. Allow load a single message status and added sorting capabilities for multiple statuses.(((
177 {{code language="none"}}
178 org.xwiki.mail.MailStatusStore: In method 'public java.util.List load(java.util.Map, int, int)' the number of arguments has changed
179 org.xwiki.mail.MailStatusStore: Return type of method 'public java.util.List load(java.util.Map, int, int)' has been changed to org.xwiki.mail.MailStatus
180 org.xwiki.mail.MailStatusStore: Method 'public java.util.List load(java.util.Map, int, int, java.lang.String, boolean)' has been added to an interface
181 {{/code}}
182 )))
183 * Young API. Large refactoring for adding the ability to register new URL Resource Types(((
184 {{code language="none"}}
185 org.xwiki.resource.AbstractResourceReference: Parameter 2 of 'public void addParameter(java.lang.String, java.lang.String)' has changed its type to java.lang.Object
186 org.xwiki.resource.ResourceReference: Parameter 2 of 'public void addParameter(java.lang.String, java.lang.String)' has changed its type to java.lang.Object
187 org.xwiki.resource.ResourceReferenceHandlerManager: Method 'public boolean canHandle(java.lang.Object)' has been added to an interface
188 org.xwiki.resource.ResourceReferenceResolver: Removed field TYPE_URL
189 org.xwiki.resource.ResourceReferenceResolver: In method 'public org.xwiki.resource.ResourceReference resolve(java.lang.Object, java.util.Map)' the number of arguments has changed
190 org.xwiki.resource.ResourceType: Method 'public org.xwiki.resource.ResourceType fromString(java.lang.String)' has been removed
191 {{/code}}
192 )))
193 * Young API. Rename MimeMessageWrapper into ScriptMimeMessage (not a wrapper anymore). Velocity scripts are not affected by the change.(((
194 {{code language="none"}}
195 org.xwiki.mail.script.MailSenderScriptService: Return type of method 'public org.xwiki.mail.script.MimeMessageWrapper createMessage(java.lang.String, java.lang.Object, java.util.Map)' has been changed to org.xwiki.mail.script.ScriptMimeMessage
196 org.xwiki.mail.script.MailSenderScriptService: Return type of method 'public org.xwiki.mail.script.MimeMessageWrapper createMessage(java.lang.String, java.lang.Object)' has been changed to org.xwiki.mail.script.ScriptMimeMessage
197 org.xwiki.mail.script.MailSenderScriptService: Return type of method 'public org.xwiki.mail.script.MimeMessageWrapper createMessage()' has been changed to org.xwiki.mail.script.ScriptMimeMessage
198 org.xwiki.mail.script.MailSenderScriptService: Return type of method 'public org.xwiki.mail.script.MimeMessageWrapper createMessage(java.lang.String, java.lang.String)' has been changed to org.xwiki.mail.script.ScriptMimeMessage
199 org.xwiki.mail.script.MailSenderScriptService: Return type of method 'public org.xwiki.mail.script.MimeMessageWrapper createMessage(java.lang.String, java.lang.String, java.lang.String)' has been changed to org.xwiki.mail.script.ScriptMimeMessage
200 org.xwiki.mail.script.MimeMessageWrapper: Class org.xwiki.mail.script.MimeMessageWrapper removed
201 {{/code}}
202 )))
203 * Young API. Change of API to fix bug in waitForProcessin(). Scripting API has not been broken, only the Java API has(((
204 {{code language="none"}}
205 org.xwiki.mail.MailResult: Method 'public boolean isProcessed()' has been removed
206 org.xwiki.mail.MailResult: Method 'public void waitTillProcessed(long)' has been removed
207 org.xwiki.mail.MailStatusResult: Method 'public long getProcessedMailCount()' has been added to an interface
208 org.xwiki.mail.MailStatusResult: Method 'public long getSize()' has been removed
209 org.xwiki.mail.MailStatusResult: Method 'public long getTotalMailCount()' has been added to an interface
210 org.xwiki.mail.MailStatusResult: Method 'public boolean isProcessed()' has been added to an interface
211 org.xwiki.mail.MailStatusResult: Method 'public void waitTillProcessed(long)' has been added to an interface
212 {{/code}}
213 )))
214 * Young API. Class moved to the "script" package. Script service usage is unchanged.(((
215 {{code language="none"}}
216 org.xwiki.mail.MailStorageScriptService: Class org.xwiki.mail.MailStorageScriptService removed
217 {{/code}}
218 )))

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected