Skip to Content

Version 28.1 by Thomas Mortagne on 2015/06/05
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 This is mostly an improvements release on new performance report design, Solr search UI and Watchlist notifications. It also introduce the experimental support for flavors in the Distribution Wizard.
8
9 = New and Noteworthy (since XWiki 7.1M2) =
10
11 [[Full list of issues fixed and Dashboard for 7.1>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=13193]].
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 The realtime watchlist messages are now handled separately from the schedules (hourly, daily, weekly) notifications. We have a separate template for them and, because of this, can now display them in a more user-friendly way and they can be threaded/grouped by your email client by the document they occurred in. For more information and screenshots, please see the [[documentation>>extensions:Extension.Watchlist Application||anchor="HRealtimenotifications"]].
32
33 {{image reference="watchlistRealtimeChangesMailConversation.png"}}{{/image}}
34
35 == New Solr search UI options ==
36
37 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.
38
39 {{image reference="solr_options.png"/}}
40
41 See [[extensions:Extension.Solr Search Application||anchor="HSearchUIoptions"]].
42
43 == Miscellaneous ==
44
45 * The default document cache size has been increased from 100 to 500 elements
46 * Minor visual consistency improvement of the tag cloud header of the LiveTable
47
48 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.
49
50 = For Developers =
51
52 == Script oriented advanced extension search API ==
53
54 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"]].
55
56 == Upgrades ==
57
58 The following dependencies have been upgraded:
59
60 * [[Bootstrap 3.3.4>>http://jira.xwiki.org/browse/XWIKI-11999]]
61 * [[Bootswatch 3.3.4+1>>http://jira.xwiki.org/browse/XWIKI-12100]]
62 * [[reflections 0.9.10>>http://jira.xwiki.org/browse/XCOMMONS-808]]
63 * [[Infinispan 7.2.2>>http://jira.xwiki.org/browse/XWIKI-12138]]
64
65 == Miscellaneous ==
66
67 * Extension upgrade plan job now support checking specific list of installed extensions (instead of the top level installed extensions)
68 * You can now [[disable the automatic start of Distribution Wizard>>platform:Features.DistributionWizard||anchor="HDisabletheautomaticstartofDistributionWizard"]] with two new options.
69 * It's possible to disable minification from xwiki.properties configuration file. Set ##debug.minify## to ##false##.
70
71 = Translations =
72
73 The following translations have been updated:
74
75 {{language codes="fr"/}}
76
77 = Tested Browsers & Databases =
78
79 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
80
81 = Known issues =
82
83 * [[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]]
84
85 = Backward Compatibility and Migration Notes =
86
87 == General Notes ==
88
89 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.
90
91 == Mail API changes ==
92
93 The young mail API has been refactored to provide better and more detailed error reporting.
94
95 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()##).
96
97 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.##
98
99 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.
100
101 {{warning}}
102 Sending multiple messages with the same Message-ID is no more supported since it does not respect the RFC-822 standard.
103 {{/warning}}
104
105 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.
106
107 == API Breakages ==
108
109 The following APIs were modified since XWiki 7.0.1:
110
111 * Add support for advanced search(((
112 {{code language="none"}}
113 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
114 {{/code}}
115 )))
116 * Add support for named steps(((
117 {{code language="none"}}
118 org.xwiki.job.event.status.JobProgress: Method 'public org.xwiki.job.event.status.JobProgressStep getCurrentStep()' has been added to an interface
119 org.xwiki.job.event.status.JobProgress: Method 'public org.xwiki.job.event.status.JobProgressStep getRootStep()' has been added to an interface
120 org.xwiki.job.event.status.JobProgressManager: Method 'public void endStep(java.lang.Object)' has been added to an interface
121 org.xwiki.job.event.status.JobProgressManager: Method 'public void pushLevelProgress(java.lang.Object)' has been added to an interface
122 org.xwiki.job.event.status.JobProgressManager: Method 'public void startStep(java.lang.Object)' has been added to an interface
123 org.xwiki.job.event.status.JobProgressManager: Method 'public void startStep(java.lang.Object, java.lang.String)' has been added to an interface
124 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
125 org.xwiki.job.event.status.JobProgressManager: Method 'public void startStep(java.lang.Object, org.xwiki.logging.Message)' has been added to an interface
126 {{/code}}
127 )))
128 * Add new helper(((
129 {{code language="none"}}
130 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
131 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
132 {{/code}}
133 )))
134 * Add a new method to this young API(((
135 {{code language="none"}}
136 org.xwiki.skin.Skin: Method 'public org.xwiki.rendering.syntax.Syntax getOutputSyntax()' has been added to an interface
137 {{/code}}
138 )))
139 * Not really been removed but now return Object. Breaks code building that use this method but should be ok for runtime.(((
140 {{code language="none"}}
141 com.xpn.xwiki.XWiki: Method 'public com.xpn.xwiki.render.XWikiRenderingEngine getRenderingEngine()' has been removed
142 {{/code}}
143 )))
144 * 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.(((
145 {{code language="none"}}
146 com.xpn.xwiki.XWiki: Method 'public void setRenderingEngine(com.xpn.xwiki.render.XWikiRenderingEngine)' has been removed
147 {{/code}}
148 )))
149 * Young API. Added handling of URL parameters(((
150 {{code language="none"}}
151 org.xwiki.url.ExtendedURL: In method 'public ExtendedURL(java.net.URL)' the number of arguments has changed
152 {{/code}}
153 )))
154 * Never supposed to be an API(((
155 {{code language="none"}}
156 com.xpn.xwiki.plugin.scheduler.StatusListener: Class com.xpn.xwiki.plugin.scheduler.StatusListener removed
157 {{/code}}
158 )))
159 * 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.(((
160 {{code language="none"}}
161 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
162 {{/code}}
163 )))
164 * Young API. Allow load a single message status and added sorting capabilities for multiple statuses.(((
165 {{code language="none"}}
166 org.xwiki.mail.MailStatusStore: In method 'public java.util.List load(java.util.Map, int, int)' the number of arguments has changed
167 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
168 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
169 {{/code}}
170 )))
171 * Young API. Large refactoring for adding the ability to register new URL Resource Types(((
172 {{code language="none"}}
173 org.xwiki.resource.AbstractResourceReference: Parameter 2 of 'public void addParameter(java.lang.String, java.lang.String)' has changed its type to java.lang.Object
174 org.xwiki.resource.ResourceReference: Parameter 2 of 'public void addParameter(java.lang.String, java.lang.String)' has changed its type to java.lang.Object
175 org.xwiki.resource.ResourceReferenceHandlerManager: Method 'public boolean canHandle(java.lang.Object)' has been added to an interface
176 org.xwiki.resource.ResourceReferenceResolver: Removed field TYPE_URL
177 org.xwiki.resource.ResourceReferenceResolver: In method 'public org.xwiki.resource.ResourceReference resolve(java.lang.Object, java.util.Map)' the number of arguments has changed
178 org.xwiki.resource.ResourceType: Method 'public org.xwiki.resource.ResourceType fromString(java.lang.String)' has been removed
179 {{/code}}
180 )))
181 * Young API. Rename MimeMessageWrapper into ScriptMimeMessage (not a wrapper anymore). Velocity scripts are not affected by the change.(((
182 {{code language="none"}}
183 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
184 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
185 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
186 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
187 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
188 org.xwiki.mail.script.MimeMessageWrapper: Class org.xwiki.mail.script.MimeMessageWrapper removed
189 {{/code}}
190 )))
191 * Young API. Change of API to fix bug in waitForProcessin(). Scripting API has not been broken, only the Java API has(((
192 {{code language="none"}}
193 org.xwiki.mail.MailResult: Method 'public boolean isProcessed()' has been removed
194 org.xwiki.mail.MailResult: Method 'public void waitTillProcessed(long)' has been removed
195 org.xwiki.mail.MailStatusResult: Method 'public long getProcessedMailCount()' has been added to an interface
196 org.xwiki.mail.MailStatusResult: Method 'public long getSize()' has been removed
197 org.xwiki.mail.MailStatusResult: Method 'public long getTotalMailCount()' has been added to an interface
198 org.xwiki.mail.MailStatusResult: Method 'public boolean isProcessed()' has been added to an interface
199 org.xwiki.mail.MailStatusResult: Method 'public void waitTillProcessed(long)' has been added to an interface
200 {{/code}}
201 )))
202 * Young API. Class moved to the "script" package. Script service usage is unchanged.(((
203 {{code language="none"}}
204 org.xwiki.mail.MailStorageScriptService: Class org.xwiki.mail.MailStorageScriptService removed
205 {{/code}}
206 )))

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected