Last modified by Thomas Mortagne on 2023/10/13

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
5 This is the release notes for XWiki Platform, XWiki Enterprise and XWiki Enterprise Manager. They share the same release notes as they are released together and have the same version.
7 This is the second and last milestone of the XWiki 4.3 version ([[Roadmap>>xwiki:Main.Roadmap]]). This release brings a new and experimental Solr Search engine, new default date, user and group pickers, a new localization module allowing applications to register translations, REST API additions and various other improvements.
9 = New and Noteworthy (since XWiki 4.3 Milestone 1) =
11 == Experimental Solr based search engine ==
13 A new and experimental search engine based on [[Apache Solr>>]] is now available.
15 The new search UI offers advanced search features and results highlighting. Future versions will also include [[Faceted Search>>]].
17 {{image reference="solrSearchFilters.png"/}}
19 The new engine has it's own index, separate from the Lucene one, which is stored by default in the ##<permanent directory>/solr## folder. In the same folder you can also access Solr's configuration files together with the index's schema.xml which you can tweak to achieve better results. To change this folder's location, you can either pass the ##-Dsolr.solr.home## system property when you start the application container (tomcat/jetty/etc.) or you can set the ##search.solr.home## property in ##WEB-INF/
21 For now, indexing is done only __manually__ by using the Search Administration UI. Because of this, in order to get any search results, you have to go to ##Administration > Applications > Search## and index/reindex the wiki. Any changes in the content of the wiki will not be searchable until you manually reindex. This limitation will be removed in future versions, once the feature matures.
23 {{image reference="solrSearchAdmin.png"/}}
25 This new search engine is not enable by default, since Lucene is still the default one, but, if you wish to try it out, it can be enable by going to ##Administration > Applications > Search > Search engine to use## and selecting ##Solr (Experimental)##.
27 == Default date picker ==
29 The date picker from [[AppWithinMinutes>>extensions:Extension.App Within Minutes Application]] is now the default picker for all [[XClass>>Documentation.DevGuide.DataModel]] properties of type Date. This means that you'll get a date picker when editing an object with a Date property even if you didn't use AppWithinMinutes to create the XClass.
31 {{image reference="DatePicker.png"/}}
33 If for some reason you don't want to use the new date picker then you can edit the XClass and uncheck "Use Date Picker" for the Date property.
35 == User and Group picker ==
37 We added a user and group picker that is used by default for all [[XClass>>Documentation.DevGuide.DataModel]] properties of type "List of Users" and "List of Groups". When multiple selection is enabled, each selected user is added to the list above the picker. You can remove individual users from the list of selected users or you can clear the entire list.
39 {{image reference="userPicker-editMultiple.png"/}}
41 In single selection mode whenever you select an user it overwrites the previously selected user.
43 {{image reference="userPicker-editSingle-objectEditor.png"/}}
45 The list of selected users is displayed in view mode in a similar way. For each user there is a link to their profile page.
47 {{image reference="userPicker-viewMultiple.png"/}}
49 The group picker behaves in the same way. The group alias is the name of the group document, the group name is the title of the group document while the group avatar is the first image attached to the group document.
51 {{image reference="groupPicker-editMultiple.png"/}}
53 The user and group picker can be configured to display a scope toggle that can be used to switch between local and global user/group suggestions.
55 {{image reference="userPicker-scope.png"/}}
57 You can check this if you edit a group from a subwiki (in a multiwiki environment).
59 {{image reference="groupSheet-edit.png"/}}
61 == New 'Title' and 'Content' fields for App Within Minutes ==
63 We added two new field types to the field palette: Title and Content. They are very useful if you want to store some of your data in the title and/or the content of your application entries. All the rest of the field types store their values in object properties, i.e. in an object attached to the application entry. See the [[App Within Minutes documentation>>extensions:Extension.App Within Minutes Application||anchor="HFieldPalette"]] for more details.
65 {{image reference="AWM-fieldPalette.png"/}}
67 == Miscellaneous ==
69 * Search Admin UI improvements ({{jira style="enum" url=""}}XWIKI-8408{{/jira}}):(((
70 {{image reference="searchAdminUINew.png"/}}
71 )))
72 * Automatically register translations for the FAQ and IRCBot applications
74 See the [[full list of JIRA issues>>]] fixed in this release.
76 = For Developers =
78 == New Localization Module ==
80 A new localization module has been introduced to replace the old XWikiMessageTool.
82 See [[extensions:Extension.Localization Module]] for more details.
84 == REST API Improvements ==
86 Some improvements have been done to the REST API with respect to wiki management.
88 * XARs can be imported in Wikis by POSTing it to the /wikis/{wikiName}
89 * New wikis can be created using the /wikimanager resource. (This resource is only available with XWiki Enterprise Manager)
91 For more information see [[XWiki RESTful API>>Documentation.UserGuide.Features.XWikiRESTfulAPI]]
93 In addition there was an XWiki REST API refactoring done with the introduction of a new ##xwiki-platform-rest-api## module containing all resource declarations. This is important for client and modules willing to use the REST API so that they can have all the information about resources using Java annotation. See [[XWiki RESTful API>>Documentation.UserGuide.Features.XWikiRESTfulAPI]].
95 == Easy creation of new XClass property types ==
97 It's now possible to create your own [[XClass property types>>Documentation.DevGuide.DataModel||anchor="HXWikiClasses2CObjects2CandProperties"]] without having to patch XWiki's old core. [[Adding a new property type>>Documentation.DevGuide.CreatingNewXClassPropertyTypes]] is as easy as implementing a component. This means you can extend the [[class editor>>Documentation.UserGuide.Features.PageEditing||anchor="HClasseseditingmode"]] and even the [[App Within Minutes>>extensions:Extension.App Within Minutes Application||anchor="HFieldPalette-1"]].
99 == Execution context property declarations ==
101 Execution context properties can now be associated with various metadata attributes. See [[the documentation on the execution context>>Documentation.DevGuide.SavingData||anchor="HExecutionContext"]] for more information.
103 == New Scope property for wiki components and UI extensions ==
105 A scope can now be defined for [[wiki components>>extensions:Extension.WikiComponent Module]] and [[UI extensions>>extensions:Extension.UIExtension Module]], it allows to restrict for which wiki(s) or which user they will be available:
107 * Current Wiki, the component/UI extension will be available in the current wiki
108 * Global, the component/UI extension will be available in all the wikis (wiki farms)
109 * Current User, the component/UI extension will only be available for its author
111 == Upgrades ==
113 The following dependencies have been upgraded:
115 * [[guava 13.0.1>>]]
116 * [[Lucene 3.6.1>>]]
117 * [[XStream 1.4.3>>]]
118 * [[commons-io 2.4>>]]
119 * [[httpclient 4.2.2>>]]
120 * [[commons-configuration 1.9>>]]
121 * [[jcl-over-slf4j and log4j-over-slf4j 1.7.2>>]]
122 * Groovy [[1.8.7>>]] [[1.8.8>>]]
123 * [[JGroups 3.2.0.Final>>]]
124 * [[Xerces-J 2.10.0>>]]
125 * [[JavaMail 1.4.5>>]]
127 == Miscellaneous ==
129 * Fixed a bug about incorrect results in multi-wiki lucene search in the REST API.
130 * Add a ##java.util.Locale## converter which allow:
131 ** using Locale in rendering macro parameter(s)
132 ** support Java method with Locale parameter(s) in Velocity. See [[Method Arguments Uberspector>>extensions:Extension.Velocity Module||anchor="HMethodArgumentsUberspector"]] for more details.
133 * Various String language based API of ##com.xpn.xwiki.XWiki## and ##com.xpn.xwiki.doc.XWikiDocument## classes are now deprecated for their newly introduced ##java.util.Locale## equivalents.
135 = Translations =
137 The following translations have been updated:
139 {{language codes="da, de, fr"/}}
141 = Known issues =
143 * [[Bugs we know about>>]]
145 = Backward Compatibility and Migration Notes =
147 == General Notes ==
149 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
151 {{warning}}
152 Always make sure you compare your ##xwiki.cfg## and files with the newest version since some configuration parameters were added. Note that you should add so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.
153 {{/warning}}
155 == Issues specific to XWiki 4.3 Milestone 2 ==
157 * The methods setUrlPatternMatcher and getUrlPatternMatcher have been removed from the core class com.xpn.xwiki.XWiki. The underlying URLPatternMatcher could not really be used as a singleton instance and was causing irregular failures in the basic authentication method. Thus these methods cannot be meaningfully relied upon and have therefore been removed.
158 * When setting the value using setValue (or setList) on a list field in an XWiki object, the list will now be copied. To be able to update the list, you must call getValue (or getList) and update the returned list. This is due to {{jira style="enum" url=""}}XWIKI-8398{{/jira}}.
159 * The behaviour of ##com.xpn.xwiki.api.PropertyClass#getClassType()## (public API) and ##com.xpn.xwiki.objects.classes.PropertyClass#getClassType()## (protected API) has changed. They don't return the canonical Java class name of the property implementation anymore but an implementation hint. Here's the code:(((
160 {{code language="java"}}
161 /**
162 * Each type of XClass property is identified by a string that specifies the data type of the property value (e.g.
163 * 'String', 'Number', 'Date') without disclosing implementation details. The internal implementation of an XClass
164 * property type can change over time but its {@code classType} should not.
165 * <p>
166 * The {@code classType} can be used as a hint to lookup various components related to this specific XClass property
167 * type. See {@link com.xpn.xwiki.internal.objects.classes.PropertyClassProvider} for instance.
168 *
169 * @return an identifier for the data type of the property value (e.g. 'String', 'Number', 'Date')
170 */
171 public String getClassType()
172 {
173 // By default the hint is computed by removing the Class suffix, if present, from the Java simple class name
174 // (without the package). Subclasses can overwrite this method to use a different hint format.
175 return StringUtils.removeEnd(getClass().getSimpleName(), "Class");
176 }
177 {{/code}}
179 This means that instead of returning ##com.xpn.xwiki.objects.classes.DBListClass## these methods now return ##DBList##. This is due to {{jira style="enum" url=""}}XWIKI-8355{{/jira}}.
180 )))
182 == API Breakages ==
184 The following APIs were modified since 4.2:
186 * [Young API] Introduce API to associate dependency status to the namespace.(((
187 {{code language="none"}}
188 org.xwiki.extension.InstalledExtension: Method 'public boolean isDependency(java.lang.String)' has been added to an interface
189 {{/code}}
190 )))
192 * [Young API] Introduce ExtensionRepositoryDescriptor as a replacement of ExtensionRepositoryId(((
193 {{code language="none"}}
194 org.xwiki.extension.ExtensionManagerConfiguration: Method 'public java.util.Collection getExtensionRepositoryDescriptors()' has been added to an interface
195 org.xwiki.extension.repository.ExtensionRepository: Method 'public org.xwiki.extension.repository.ExtensionRepositoryDescriptor getDescriptor()' has been added to an interface
196 org.xwiki.extension.repository.ExtensionRepositoryFactory: Method 'public org.xwiki.extension.repository.ExtensionRepository createRepository(org.xwiki.extension.repository.ExtensionRepositoryDescriptor)' has been added to an interface
197 org.xwiki.extension.repository.ExtensionRepositoryManager: Method 'public org.xwiki.extension.repository.ExtensionRepository addRepository(org.xwiki.extension.repository.ExtensionRepositoryDescriptor)' has been added to an interface
198 org.xwiki.extension.repository.ExtensionRepositorySource: Method 'public java.util.Collection getExtensionRepositoryDescriptors()' has been added to an interface
199 {{/code}}
200 )))
202 * The ##userdirectory## and ##usertools## plugins have been retired(((
203 {{code language="none"}}
204 com.xpn.xwiki.plugin.userdirectory.Group: Class com.xpn.xwiki.plugin.userdirectory.Group removed
205 com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin: Class com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin removed
206 com.xpn.xwiki.plugin.userdirectory.UserDirectoryPluginAPI: Class com.xpn.xwiki.plugin.userdirectory.UserDirectoryPluginAPI removed
207 com.xpn.xwiki.plugin.usertools.XWikiUserManagementTools: Class com.xpn.xwiki.plugin.usertools.XWikiUserManagementTools removed
208 com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsAPI: Class com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsAPI removed
209 com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl: Class com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl removed
210 {{/code}}
211 )))
213 * This should be fixed: a new 'sendMessageFromTemplate' method was added before the 4.2 release and then removed only from master (4.3-SNAPSHOT). We need to decide what we do with this method.(((
214 {{code language="none"}}
215 com.xpn.xwiki.plugin.mailsender.MailSender: Method 'public int sendMessageFromTemplate(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)' has been removed
216 {{/code}}
217 )))
219 * Many REST API module classes that were not meant to be public have been moved to internal package.(((
220 {{code language="none"}}
221 Class removed
222 Field ALLOWED_VALUES_ATTRIBUTE_NAME has been removed, but it was previously a constant
223 Field RELEASABLE_COMPONENT_REFERENCES has been removed, but it was previously a constant
224 Field XWIKI_COMPONENT_MANAGER has been removed, but it was previously a constant
225 Class removed
226 Class removed
227 Class removed
228 Class removed
229 Class removed
230 Class removed
231 Class removed
232 Class removed
233 Class removed
234 Class removed
235 Class removed
236 Class removed
237 Class removed
238 Class removed
239 Class removed
240 Class removed
241 Class removed
242 Class removed
243 Class removed
244 Class removed
245 Class removed
246 Class removed
247$AttachmentInfo: Class$AttachmentInfo removed
248 Class removed
249$SearchScope: Class$SearchScope removed
250 Class removed
251 Class removed
252 Class removed
253 Class removed
254 Class removed
255 Class removed
256 Class removed
257 Class removed
258 Class removed
259 Class removed
260 Class removed
261 Class removed
262 Class removed
263 Class removed
264 Class removed
265 Class removed
266 Class removed
267 Class removed
268 Class removed
269 Class removed
270 Class removed
271 Class removed
272 Class removed
273 Class removed
274 Class removed
275 Class removed
276 Class removed
277 Class removed
278 Class removed
279 Class removed
280 Class removed
281 Class removed
282 Class removed
283 Class removed
284 Class removed
285 Class removed
286 Class removed
287 Class removed
288 Class removed
289 Class removed
290 Class removed
291 Class removed
292 Class removed
293 Class removed
294 Class removed
295 Class removed
296 Class removed
297 Class removed
298 Class removed
299 Class removed
300 {{/code}}
301 )))
303 * The version field has been moved from Page to PageSummary which is the superclass of Page(((
304 {{code language="none"}}
305 Removed field version
306 {{/code}}
307 )))
309 * Added methods for creating workspaces and retrieving workspace templates.(((
310 {{code language="none"}}
311 org.xwiki.workspace.WorkspaceManager: Method 'public com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer createWorkspace(java.lang.String, com.xpn.xwiki.plugin.wikimanager.doc.XWikiServer, java.lang.String)' has been added to an interface
312 org.xwiki.workspace.WorkspaceManager: Method 'public java.util.List getWorkspaceTemplates()' has been added to an interface
313 {{/code}}
314 )))
316 * The plugin has been moved to its own module. Not a breakage.(((
317 {{code language="none"}}
318 com.xpn.xwiki.plugin.feed.FeedPlugin: Class com.xpn.xwiki.plugin.feed.FeedPlugin removed
319 com.xpn.xwiki.plugin.feed.FeedPlugin$EntriesComparator: Class com.xpn.xwiki.plugin.feed.FeedPlugin$EntriesComparator removed
320 com.xpn.xwiki.plugin.feed.FeedPlugin$SyndEntryComparator: Class com.xpn.xwiki.plugin.feed.FeedPlugin$SyndEntryComparator removed
321 com.xpn.xwiki.plugin.feed.FeedPluginApi: Class com.xpn.xwiki.plugin.feed.FeedPluginApi removed
322 com.xpn.xwiki.plugin.feed.SyndEntryDocumentSource: Class com.xpn.xwiki.plugin.feed.SyndEntryDocumentSource removed
323 com.xpn.xwiki.plugin.feed.SyndEntryDocumentSource$PropertySelector: Class com.xpn.xwiki.plugin.feed.SyndEntryDocumentSource$PropertySelector removed
324 com.xpn.xwiki.plugin.feed.SyndEntrySource: Class com.xpn.xwiki.plugin.feed.SyndEntrySource removed
325 com.xpn.xwiki.plugin.feed.SyndEntrySourceApi: Class com.xpn.xwiki.plugin.feed.SyndEntrySourceApi removed
326 com.xpn.xwiki.plugin.feed.UpdateThread: Class com.xpn.xwiki.plugin.feed.UpdateThread removed
327 com.xpn.xwiki.plugin.feed.XWikiFeedFetcher: Class com.xpn.xwiki.plugin.feed.XWikiFeedFetcher removed
328 com.xpn.xwiki.plugin.feed.XWikiFeedFetcher$CredentialSupplier: Class com.xpn.xwiki.plugin.feed.XWikiFeedFetcher$CredentialSupplier removed
329 {{/code}}
330 )))
332 * IRCBot is still a young API. Added a new initialize() method to support installing the IRC Bot application in a subwiki(((
333 {{code language="none"}}
334 org.xwiki.ircbot.IRCBot: Method 'public void initialize(java.lang.String)' has been added to an interface
335 {{/code}}
336 )))
338 * WikiComponent is still a young API. Moved the class to the internal package(((
339 {{code language="none"}}
340 Class removed
341 Class removed
342 {{/code}}
343 )))
345 * WikiComponent is still a young API. Replaced the getRole() method with getRoleType() to implement XWIKI-8233, "Allow wiki components to implement parameterized types"(((
346 {{code language="none"}}
347 Method 'public java.lang.Class getRole()' has been removed
348 Method 'public java.lang.reflect.Type getRoleType()' has been added to an interface
349 {{/code}}
350 )))
352 * WikiComponent is still a young API. Removed some unnecessary methods(((
353 {{code language="none"}}
354 Method 'public java.util.Map getHandledMethods()' has been removed
355 Method 'public java.util.List getImplementedInterfaces()' has been removed
356 {{/code}}
357 )))
359 * WikiComponent is still a young API. Added this method to implement XWIKI-8234, "Allow wiki components to be registered at different levels (user / wiki / global)"(((
360 {{code language="none"}}
361 Method 'public org.xwiki.model.reference.DocumentReference getAuthorReference()' has been added to an interface
362 Method 'public getScope()' has been added to an interface
363 {{/code}}
364 )))
366 * UIExtension is still a young API. Replaced the List of Block by a Block since Block can now hold a list of Block(((
367 {{code language="none"}}
368 org.xwiki.uiextension.UIExtension: Return type of method 'public java.util.List execute()' has been changed to org.xwiki.rendering.block.Block
369 {{/code}}
370 )))
372 * UIExtension is still a young API. getName() has been renamed to getId()(((
373 {{code language="none"}}
374 org.xwiki.uiextension.UIExtension: Method 'public java.lang.String getId()' has been added to an interface
375 org.xwiki.uiextension.UIExtension: Method 'public java.lang.String getName()' has been removed
376 {{/code}}
377 )))
379 * Added a common method to all elements to set all the data from another element. Technically this does not really break anything because all elements are supposed to extends BaseElement(((
380 {{code language="none"}}
381 com.xpn.xwiki.objects.ElementInterface: Method 'public boolean apply(com.xpn.xwiki.objects.ElementInterface, boolean)' has been added to an interface
382 {{/code}}
383 )))
385 * Elemenents must be added to the wrapping NotifyOnList to ensure that the property is marked 'dirty' when updated. To avoid that this mechanism is circumvented, the field is made final.(((
386 {{code language="none"}}
387 com.xpn.xwiki.objects.ListProperty: Field list is now final
388 {{/code}}
389 )))
391 * Removed language field because the information is now stored as Locale instead of String and it should have never been protected anyway.(((
392 {{code language="none"}}
393 com.xpn.xwiki.doc.XWikiDocument: Removed field language
394 {{/code}}
395 )))
397 * URLPatternMatcher instances cannot generally be reused (because the underlaying Perl5Matcher cannot be reused) on different strings and with different patterns and a new instance must be produced on demand. It is, thus, meaningless to set an instance. If there is any code relying on this method, it is broken already. Thus, we should remove this without going through deprecation. We might as well remove the getter.(((
398 {{code language="none"}}
399 com.xpn.xwiki.XWiki: Method 'public void setUrlPatternMatcher(org.securityfilter.filter.URLPatternMatcher)' has been removed
400 com.xpn.xwiki.XWiki: Method 'public org.securityfilter.filter.URLPatternMatcher getUrlPatternMatcher()' has been removed
401 {{/code}}
402 )))
404 * Removed unused field(((
405 {{code language="none"}}
406 com.xpn.xwiki.tool.backup.ImportMojo: Field MPNAME_DESCRIPTION has been removed, but it was previously a constant
407 {{/code}}
408 )))

Get Connected