This is the release notes for XWiki Commons, XWiki Rendering and XWiki Platform. They share the same release notes as they are released together and have the same version.

This release brings improved display of liked pages and users that like a page, usability improvements when changing page syntax, finer configuration options for skipping the recycle bin and a new and improved Ratings API.

New and Noteworthy (since XWiki 12.8)

Full list of issues fixed and Dashboard for 12.9.

For Users

Like information are displayed in a live table

 
People liking a page are now displayed in a live table.

Liked pages are displayed in a LiveTable

 
Liked pages are now displayed in a live table in the user profile.

Changing Page Syntax from Wiki Editor

 
Changing the page syntax from the Wiki Editor has suffered some updates:

• the style of the syntax conversion confirmation modal has been improved to be consistent with the other modals we use in XWiki
• the syntax conversion is not saved right away anymore but when you save the Wiki Editor; canceling the Wiki Editor will also cancel any unsaved syntax change
• XWiki will warn you when the syntax conversion is not supported

Checkout the Page Editing documentation for additional information.

Changing Page Syntax from WYSIWYG Editor

 
Changing the page syntax from the WYSIWYG Editor has suffered some updates:

• we don't reload the entire page anymore but only the WYSIWYG editor instance (in order to take into account the new syntax); the WYSIWYG editor has to be reloaded because the page syntax affects core editor configuration that cannot be changed on the fly (see the CKEditor Integration documentation for more information);
• the WYSIWYG editor is always reloaded when changing the syntax, no matter whether you choose to convert the content or not (for the reason mentioned above)
• the editing mode (Source vs. WYSIWYG) is preserved on reload
• if the new syntax doesn't support WYSIWYG editing (e.g. because it doesn't have a renderer) then the WYSIWYG editor will force the Source mode after the reload and disable the WYSIWYG mode, warning the user about the current limitation.

Checkout the Page Editing documentation for additional information.

Changing Page Syntax from View

 
Changing the page syntax from the Information tab, while viewing the page, has suffered some updates:

• XWiki will now propose to convert the page content and meta data to the new syntax, if the conversion is supported, but note that the changes will be saved only after saving the syntax
• if the syntax conversion is not supported then XWiki will warn the user about the limitation
• the page title and content are reloaded in order to allow the user to preview the effect of the syntax change before saving the new syntax
• canceling the syntax change will also reload the page title and content

For Admins

Finer configuration of the "can skip the recycle bin" feature

 
Allowing Advanced user to skip the recycle bin can now be configured on three locations:

• In the global administration of the current wiki
• In the global administration of the main wiki
• In xwiki.properties (see the property details below)

If the default value is found on one location, the next one is tried. If no value is found, the recycle bin skipping is not activated.

Details of the configuration on xwiki.properties:

Miscellaneous

• Mail Resender: XWiki can be configured to not resend failed emails at restart (it does by default).

• The Delete section of the Content category of the global administration is now hidden when the recycle bin is not activated.

For Developers

Async Rendering improvements

 
When the context document is selected in an asynchronous rendering execution it's also added to "used" entities. That means that if that document is modified the cache result will be invalidated automatically. 

Provide a new API for Ratings

 
The Ratings API has been rewritten in order to support new use-cases, such as performing rates on different kinds of elements (not only pages) but also using different scales for ratings. This works leads to breaking the existing Ratings API: the Rating Application is automatically supported (you just have to update the extension) but if you used directly the Ratings API for some custom extensions you might be interested about this small guide for migrating it.

Miscellaneous

• URLTool improvement: A new toURL(String) has been added to the Velocity $urltool to convert a String to an URL object.

Upgrades

The following runtime dependencies have been upgraded (they have a different release cycle than XWiki Commons, XWiki Rendering and XWiki Platform):

• CSS4J 3.0.0
• XWiki Syntax Highlighting Application 4.5.2
• CKEditor Integration 1.51
• httpclient 4.5.13
• cssparser 0.9.28
• Woodstox 6.2.3
• Snakeyaml 1.27
• PostgresSQL connector 42.2.17
• MariaDB connector 2.7.0
• Jackson 2.11.3
• JNR POSIX 3.1.2
• JNR Netdb 1.2.0
• JNR FFI 2.2.0
• JNR Constants 0.10.0
• JGroups 4.2.7
• JFFI 1.3.0
• JBoss Marshalling 2.0.10.Final
• Hibernate 5.4.22
• Commons Pool 2.9.0
• Commons Net 3.7.2
• Commons DBCP2 2.8.0
• Commons CLI 1.4
• Checker Qual 3.7.0
• Caffeine 2.8.6
• Byte Buddy 1.10.16
• ASM 9.0

Translations

The following translations have been updated:

• Spanish
• French
• Croatian
• Latvian
• Marathi
• Norwegian
• Russian
• Slovak
• Simplified Chinese

Tested Browsers & Databases

Here is the list of browsers we support and how they have been tested for this release:

	Browser	Tested on:
	Google Chrome 86	Not Tested
	Mozilla Firefox 81	Not Tested
	Microsoft Edge 86	Not Tested
	Internet Explorer 11	Jira Tickets Marked as Fixed in the Release Notes
	Safari 14	Not Tested

Here is the list of databases we support and how they have been tested for this release:

	Database	Tested on:
	HyperSQL 2.5.1	Not Tested
	MySQL 8	Not Tested
	Oracle 19c	Not Tested
	PostgreSQL 12	Jira Tickets Marked as Fixed in the Release Notes
	MariaDB 10.5	Not Tested

Here is the list of Servlet Containers we support and how they have been tested for this release:

	Servlet Container	Tested on:
	Tomcat 9.0.39	Jira Tickets Marked as Fixed in the Release Notes
	Jetty 9.4.29 (XWiki Standalone packaging)	Not Tested
	Jetty 9.4.29	Not Tested

Known issues

• Bugs we know about

Backward Compatibility and Migration Notes

General Notes

• When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
  • xwiki.cfg
  • xwiki.properties
  • web.xml
  • hibernate.cfg.xml
• Add xwiki.store.migration=1 in xwiki.cfg so that XWiki will attempt to automatically migrate your current database to any new schema. Make sure you backup your Database before doing anything.

Issues specific to XWiki 12.9RC1

The Ratings API have been rewritten in order to support more usecases, but we voluntarely broke the backward compatibility when doing so. If you are upgrading from XWiki 12.7RC1 or after, or from an XWiki version on which Ratings Application is installed, you might see some logs like that at first restart:

If not nice, those errors are expected: they are showing that our internal Extension Manager found that the Ratings API compatibility was broken. This error will prevent using the Ratings Application or the Like Application until you have completely performed the upgrade. 

During the upgrade, you will be proposed to remove the old Ratings API extension: keep the default value for it (it should be checked) to avoid any inconsistency. 

Also note that at first start, a data migration of Ratings and Likes will be performed, you might see some logs like that:

Finally if you have a custom extension or custom scripts using the Ratings API, you will be interested about this migration guide.

API Breakages

The following APIs were modified since XWiki 12.8:

• Should not cause any retro compatibility issue in practice
  • Violation type:
    java.class.nonFinalClassInheritsFromNewClass
  • Code:
    ## Old:
    class org.xwiki.extension.wrap.WrappingCoreExtension<T extends org.xwiki.extension.CoreExtension>
    
    ## New:
    class org.xwiki.extension.wrap.WrappingCoreExtension<T extends org.xwiki.extension.CoreExtension>
• Should not cause any retro compatibility issue in practice
  • Violation type:
    java.class.nonFinalClassInheritsFromNewClass
  • Code:
    ## Old:
    class org.xwiki.extension.wrap.WrappingExtension<E extends org.xwiki.extension.Extension>
    
    ## New:
    class org.xwiki.extension.wrap.WrappingExtension<E extends org.xwiki.extension.Extension>
• Should not cause any retro compatibility issue in practice
  • Violation type:
    java.class.nonFinalClassInheritsFromNewClass
  • Code:
    ## Old:
    class org.xwiki.extension.wrap.WrappingInstalledExtension<E extends org.xwiki.extension.InstalledExtension>
    
    ## New:
    class org.xwiki.extension.wrap.WrappingInstalledExtension<E extends org.xwiki.extension.InstalledExtension>
• Should not cause any retro compatibility issue in practice
  • Violation type:
    java.class.nonFinalClassInheritsFromNewClass
  • Code:
    ## Old:
    class org.xwiki.extension.wrap.WrappingLocalExtension<T extends org.xwiki.extension.LocalExtension>
    
    ## New:
    class org.xwiki.extension.wrap.WrappingLocalExtension<T extends org.xwiki.extension.LocalExtension>
• Should not cause any retro compatibility issue in practice
  • Violation type:
    java.class.nonFinalClassInheritsFromNewClass
  • Code:
    ## Old:
    class org.xwiki.extension.wrap.WrappingRatingExtension<T extends org.xwiki.extension.rating.RatingExtension>
    
    ## New:
    class org.xwiki.extension.wrap.WrappingRatingExtension<T extends org.xwiki.extension.rating.RatingExtension>
• Should not cause any retro compatibility issue in practice
  • Violation type:
    java.class.nonFinalClassInheritsFromNewClass
  • Code:
    ## Old:
    class org.xwiki.extension.wrap.WrappingRemoteExtension<T extends org.xwiki.extension.RemoteExtension>
    
    ## New:
    class org.xwiki.extension.wrap.WrappingRemoteExtension<T extends org.xwiki.extension.RemoteExtension>
• Source breakage but not a backward compatible one. We consider it's acceptable
  • Violation type:
    java.class.noLongerInheritsFromClass
  • Code:
    ## Old:
    class org.xwiki.rendering.wikimodel.xhtml.impl.LocalEntityResolver
    
    ## New:
    class org.xwiki.rendering.wikimodel.xhtml.impl.LocalEntityResolver
• Source breakage but not a backward compatible one. We consider it's acceptable
  • Violation type:
    java.class.nonFinalClassInheritsFromNewClass
  • Code:
    ## Old:
    class org.xwiki.rendering.wikimodel.xhtml.impl.LocalEntityResolver
    
    ## New:
    class org.xwiki.rendering.wikimodel.xhtml.impl.LocalEntityResolver
• Source breakage but not a backward compatible one. We consider it's acceptable
  • Violation type:
    java.class.nonFinalClassInheritsFromNewClass
  • Code:
    ## Old:
    class org.xwiki.rendering.wikimodel.xhtml.impl.LocalEntityResolver
    
    ## New:
    class org.xwiki.rendering.wikimodel.xhtml.impl.LocalEntityResolver
• Unstable API: not breaking.
  • Violation type:
    java.method.returnTypeChanged
  • Code:
    ## Old:
    method org.xwiki.like.LikedEntity org.xwiki.like.LikeManager::getEntityLikes(org.xwiki.model.reference.EntityReference) throws org.xwiki.like.LikeException
    
    ## New:
    method long org.xwiki.like.LikeManager::getEntityLikes(org.xwiki.model.reference.EntityReference) throws org.xwiki.like.LikeException
• Unstable API: not breaking.
  • Violation type:
    java.method.addedToInterface
  • Code:
    ## Old:
    
    
    ## New:
    method java.util.List<org.xwiki.user.UserReference> org.xwiki.like.LikeManager::getLikers(org.xwiki.model.reference.EntityReference, int, int) throws org.xwiki.like.LikeException
• Unstable API: not breaking.
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method java.util.List<org.xwiki.like.LikedEntity> org.xwiki.like.LikeManager::getUserLikes(org.xwiki.user.UserReference) throws org.xwiki.like.LikeException
    
    ## New:
    method java.util.List<org.xwiki.model.reference.EntityReference> org.xwiki.like.LikeManager::getUserLikes(org.xwiki.user.UserReference, int, int) throws org.xwiki.like.LikeException
• Unstable API: not breaking.
  • Violation type:
    java.method.returnTypeChanged
  • Code:
    ## Old:
    method org.xwiki.like.LikedEntity org.xwiki.like.LikeManager::saveLike(org.xwiki.user.UserReference, org.xwiki.model.reference.EntityReference) throws org.xwiki.like.LikeException
    
    ## New:
    method long org.xwiki.like.LikeManager::saveLike(org.xwiki.user.UserReference, org.xwiki.model.reference.EntityReference) throws org.xwiki.like.LikeException
• Unstable API: not breaking.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    interface org.xwiki.like.LikedEntity
• Unstable API: not breaking.
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method java.util.List<org.xwiki.like.LikedEntity> org.xwiki.like.script.LikeScriptService::getUserLikes(org.xwiki.user.UserReference)
    
    ## New:
    method java.util.List<org.xwiki.model.reference.EntityReference> org.xwiki.like.script.LikeScriptService::getUserLikes(org.xwiki.user.UserReference, int, int)
• Redesign of Ratings API: this class has actually been moved to org.xwiki.ratings.events.AbstractRatingEvent but deeply changed internally.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.ratings.AbstractRatingEvent
• Redesign of Ratings API: Several new methods have been added to AverageRating class.
  • Violation type:
    java.method.addedToInterface
  • Code:
    ## Old:
    
    
    ## New:
    method .+ org.xwiki.ratings.AverageRating::.+
• Redesign of Ratings API: This method has been removed since it should be handled by a dedicated manager and not there.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method void org.xwiki.ratings.AverageRating::save() throws org.xwiki.ratings.RatingsException
• Redesign of Ratings API: this interface now only provide getters.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method void org.xwiki.ratings.AverageRating::set.+
• Redesign of Ratings API: this method is no longer needed with the new architecture.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method java.lang.String org.xwiki.ratings.AverageRating::getMethod()
• Redesign of Ratings API: only the AverageRating interface should now be used.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.ratings.AverageRatingApi
• Redesign of Ratings API: this class is useless with the new architecture.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    interface org.xwiki.ratings.ConfiguredProvider<T>
• Redesign of Ratings API: this class is useless with the new architecture.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.ratings.ConfiguredRatingsManagerProvider
• Redesign of Ratings API: the reputation is no longer supported by this extension.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.ratings.ConfiguredReputationAlgorithmProvider
• Redesign of Ratings API: this method is not directly related to rating.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method java.lang.String org.xwiki.ratings.Rating::display(java.lang.String, java.lang.String)
• Redesign of Ratings API: this method was too generic for this API.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method java.lang.Object org.xwiki.ratings.Rating::get(java.lang.String)
• Redesign of Ratings API: this method implied that Rating were always stored as xobject which is not always true.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method com.xpn.xwiki.objects.BaseObject org.xwiki.ratings.Rating::getAsObject() throws org.xwiki.ratings.RatingsException
• Redesign of Ratings API: Following our new User API practice, a user is represented by a UserReference.
  • Violation type:
    java.method.returnTypeChanged
  • Code:
    ## Old:
    method org.xwiki.model.reference.DocumentReference org.xwiki.ratings.Rating::getAuthor()
    
    ## New:
    method org.xwiki.user.UserReference org.xwiki.ratings.Rating::getAuthor()
• Redesign of Ratings API: Rating interface expose now new data that are available through the interface.
  • Violation type:
    java.method.addedToInterface
  • Code:
    ## Old:
    
    
    ## New:
    method .+ org.xwiki.ratings.Rating::.+
• Redesign of Ratings API: two dates are now available, the creation date and the last update date.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method java.util.Date org.xwiki.ratings.Rating::getDate()
• Redesign of Ratings API: Rating is now not only for documents but for any entity. See Rating#getReference().
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method org.xwiki.model.reference.DocumentReference org.xwiki.ratings.Rating::getDocumentReference()
• Redesign of Ratings API: there is now a unique ID available with Rating#getId().
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method java.lang.String org.xwiki.ratings.Rating::getGlobalRatingId()
• Redesign of Ratings API: there is now a unique ID available with Rating#getId().
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method java.lang.String org.xwiki.ratings.Rating::getRatingId()
• Redesign of Ratings API: this API is now handled only through the RatingsManager.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method boolean org.xwiki.ratings.Rating::remove() throws org.xwiki.ratings.RatingsException
• Redesign of Ratings API: this API is now handled only through the RatingsManager.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method void org.xwiki.ratings.Rating::save() throws org.xwiki.ratings.RatingsException
• Redesign of Ratings API: Only getters are now available in this interface.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method void org.xwiki.ratings.Rating::set.+
• Redesign of Ratings API: RatingsConfiguration now defines configuration methods for Ratings. Check out the documentation.
  • Violation type:
    java.method.addedToInterface
  • Code:
    ## Old:
    
    
    ## New:
    method .+ org.xwiki.ratings.RatingsConfiguration::.+
• Redesign of Ratings API: RatingsConfiguration now defines configuration methods for Ratings. Check out the documentation.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method com.xpn.xwiki.doc.XWikiDocument org.xwiki.ratings.RatingsConfiguration::getConfigurationDocument(org.xwiki.model.reference.DocumentReference)
• Redesign of Ratings API: RatingsConfiguration now defines configuration methods for Ratings. Check out the documentation.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method java.lang.String org.xwiki.ratings.RatingsConfiguration::getConfigurationParameter(org.xwiki.model.reference.DocumentReference, java.lang.String, java.lang.String)
• Redesign of Ratings API: RatingsException does not extend anymore XWikiException.
  • Violation type:
    java.field.removedWithConstant
  • Code:
    ## Old:
    field .+ @ org.xwiki.ratings.RatingsException
• Redesign of Ratings API: Error codes have been removed from RatingsException, we only rely on meaningfull messages.
  • Violation type:
    java.field.removedWithConstant
  • Code:
    ## Old:
    field org.xwiki.ratings.RatingsException.[A-Z_]+
• Redesign of Ratings API: Error codes have been removed from RatingsException, we only rely on meaningfull messages.
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method void org.xwiki.ratings.RatingsException::<init>()
    
    ## New:
    method void org.xwiki.ratings.RatingsException::<init>(java.lang.String)
• Redesign of Ratings API: Error codes have been removed from RatingsException, we only rely on meaningfull messages.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method .+ org.xwiki.ratings.RatingsException::.+
• Redesign of Ratings API: RatingsException does not extend anymore XWikiException.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method .+ com.xpn.xwiki.XWikiException::.+ @ org.xwiki.ratings.RatingsException
• Redesign of Ratings API: RatingsException does not extend anymore XWikiException.
  • Violation type:
    java.class.noLongerInheritsFromClass
  • Code:
    ## Old:
    class org.xwiki.ratings.RatingsException
    
    ## New:
    class org.xwiki.ratings.RatingsException
• Redesign of Ratings API: Constants have been removed from RatingsManager since they were tightly linked to the storage representation.
  • Violation type:
    java.field.removedWithConstant
  • Code:
    ## Old:
    field org.xwiki.ratings.RatingsManager.[A-Z_]+
• Redesign of Ratings API: Constants have been removed from RatingsManager since they were tightly linked to the storage representation.
  • Violation type:
    java.field.removed
  • Code:
    ## Old:
    field org.xwiki.ratings.RatingsManager.[A-Z_]+
• Redesign of Ratings API: some new methods have been added because of new needs.
  • Violation type:
    java.method.addedToInterface
  • Code:
    ## Old:
    
    
    ## New:
    method .+ org.xwiki.ratings.RatingsManager::.+
• Redesign of Ratings API: ratings now apply on entities not just documents.
  • Violation type:
    java.method.parameterTypeChanged
  • Code:
    ## Old:
    parameter org.xwiki.ratings.AverageRating org.xwiki.ratings.RatingsManager::getAverageRating(===org.xwiki.model.reference.DocumentReference===) throws org.xwiki.ratings.RatingsException
    
    ## New:
    parameter org.xwiki.ratings.AverageRating org.xwiki.ratings.RatingsManager::getAverageRating(===org.xwiki.model.reference.EntityReference===) throws org.xwiki.ratings.RatingsException
• Redesign of Ratings API: the API of RatingsManager have been greatly simplified.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method .+ org.xwiki.ratings.RatingsManager::.+
• Redesign of Ratings API: the method to retrieve ratings in RatingsManager have been made more generic.
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method java.util.List<org.xwiki.ratings.Rating> org.xwiki.ratings.RatingsManager::getRatings(org.xwiki.model.reference.DocumentReference, int, int, boolean) throws org.xwiki.ratings.RatingsException
    
    ## New:
    method java.util.List<org.xwiki.ratings.Rating> org.xwiki.ratings.RatingsManager::getRatings(java.util.Map<org.xwiki.ratings.RatingsManager.RatingQueryField, java.lang.Object>, int, int, org.xwiki.ratings.RatingsManager.RatingQueryField, boolean) throws org.xwiki.ratings.RatingsException
• Redesign of Ratings API: the method to remove a rating in RatingsManager now only take an identifier.
  • Violation type:
    java.method.parameterTypeChanged
  • Code:
    ## Old:
    parameter boolean org.xwiki.ratings.RatingsManager::removeRating(===org.xwiki.ratings.Rating===) throws org.xwiki.ratings.RatingsException
    
    ## New:
    parameter boolean org.xwiki.ratings.RatingsManager::removeRating(===java.lang.String===) throws org.xwiki.ratings.RatingsException
• Redesign of Ratings API: Reputation was never finished and is no longer supported in Ratings.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    interface org.xwiki.ratings.ReputationAlgorithm
• Redesign of Ratings API: Reputation was never finished and is no longer supported in Ratings.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    interface org.xwiki.ratings.ReputationAlgorithmGroovy
• Redesign of Ratings API: Reputation was never finished and is no longer supported in Ratings.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.ratings.ReputationException
• Redesign of Ratings API: this class has been refactored, an equivalent is now in org.xwiki.ratings.events.UpdatedRatingEvent.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.ratings.UpdateRatingEvent
• Redesign of Ratings API: we removed the begin/end event for Ratings. They only exist for AverageRating for technical reasons.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.ratings.UpdateRatingFailedEvent
• Redesign of Ratings API: we removed the begin/end event for Ratings. They only exist for AverageRating for technical reasons.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.ratings.UpdatingRatingEvent
• Redesign of Ratings API: only the Rating interface should now be used.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.ratings.script.RatingApi
• Redesign of Ratings API: User reputation is not supported anymore.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method org.xwiki.ratings.AverageRatingApi org.xwiki.ratings.script.RatingsScriptService::getUserReputation.*
• Redesign of Ratings API: this method was already deprecated.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method org.xwiki.ratings.script.RatingApi org.xwiki.ratings.script.RatingsScriptService::getRating(com.xpn.xwiki.api.Document, java.lang.String)
• Redesign of Ratings API: this method was already deprecated.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method org.xwiki.ratings.AverageRatingApi org.xwiki.ratings.script.RatingsScriptService::getAverageRating(com.xpn.xwiki.api.Document, java.lang.String)
• Redesign of Ratings API: this method does not make sense in the new design.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method com.xpn.xwiki.api.Document org.xwiki.ratings.script.RatingsScriptService::getConfigurationDocument(org.xwiki.model.reference.DocumentReference)
• Redesign of Ratings API: allow to retrieve average rating for any reference (not only DocumentReference).
  • Violation type:
    java.method.parameterTypeChanged
  • Code:
    ## Old:
    parameter org.xwiki.ratings.AverageRatingApi org.xwiki.ratings.script.RatingsScriptService::getAverageRating(===com.xpn.xwiki.api.Document===)
    
    ## New:
    parameter java.util.Optional<org.xwiki.ratings.AverageRating> org.xwiki.ratings.script.AbstractScriptRatingsManager::getAverageRating(===org.xwiki.model.reference.EntityReference===) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: use new best practices for script service return if type is nullable.
  • Violation type:
    java.method.returnTypeChanged
  • Code:
    ## Old:
    method org.xwiki.ratings.AverageRatingApi org.xwiki.ratings.script.RatingsScriptService::getAverageRating(com.xpn.xwiki.api.Document)
    
    ## New:
    method java.util.Optional<org.xwiki.ratings.AverageRating> org.xwiki.ratings.script.AbstractScriptRatingsManager::getAverageRating(org.xwiki.model.reference.EntityReference) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: clean up of deprecated methods or methods that are not relevant on the new design.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method org.xwiki.ratings.AverageRatingApi org.xwiki.ratings.script.RatingsScriptService::getAverageRating.*
• Redesign of Ratings API: this change shouldn't impact using the script service.
  • Violation type:
    java.class.nonFinalClassInheritsFromNewClass
  • Code:
    ## Old:
    class org.xwiki.ratings.script.RatingsScriptService
    
    ## New:
    class org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: allow to retrieve average rating for any reference (not only DocumentReference)
  • Violation type:
    java.method.parameterTypeChanged
  • Code:
    ## Old:
    parameter org.xwiki.ratings.script.RatingApi org.xwiki.ratings.script.RatingsScriptService::getRating(===com.xpn.xwiki.api.Document===, java.lang.String)
    
    ## New:
    parameter java.util.Optional<org.xwiki.ratings.Rating> org.xwiki.ratings.script.AbstractScriptRatingsManager::getRating(===org.xwiki.model.reference.EntityReference===, org.xwiki.user.UserReference) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: use new best practices for specifying a user by using the UserReference.
  • Violation type:
    java.method.parameterTypeChanged
  • Code:
    ## Old:
    parameter org.xwiki.ratings.script.RatingApi org.xwiki.ratings.script.RatingsScriptService::getRating(com.xpn.xwiki.api.Document, ===java.lang.String===)
    
    ## New:
    parameter java.util.Optional<org.xwiki.ratings.Rating> org.xwiki.ratings.script.AbstractScriptRatingsManager::getRating(org.xwiki.model.reference.EntityReference, ===org.xwiki.user.UserReference===) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: use new best practices for script service return if type is nullable.
  • Violation type:
    java.method.returnTypeChanged
  • Code:
    ## Old:
    method org.xwiki.ratings.script.RatingApi org.xwiki.ratings.script.RatingsScriptService::getRating(com.xpn.xwiki.api.Document, java.lang.String)
    
    ## New:
    method java.util.Optional<org.xwiki.ratings.Rating> org.xwiki.ratings.script.AbstractScriptRatingsManager::getRating(org.xwiki.model.reference.EntityReference, org.xwiki.user.UserReference) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: the changes above actually apply to that one.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method org.xwiki.ratings.script.RatingApi org.xwiki.ratings.script.RatingsScriptService::getRating(org.xwiki.model.reference.DocumentReference, org.xwiki.model.reference.DocumentReference)
• Redesign of Ratings API: allow to retrieve rating for any reference (not only DocumentReference)
  • Violation type:
    java.method.parameterTypeChanged
  • Code:
    ## Old:
    parameter java.util.List<org.xwiki.ratings.script.RatingApi> org.xwiki.ratings.script.RatingsScriptService::getRatings(===com.xpn.xwiki.api.Document===, int, int)
    
    ## New:
    parameter java.util.List<org.xwiki.ratings.Rating> org.xwiki.ratings.script.AbstractScriptRatingsManager::getRatings(===org.xwiki.model.reference.EntityReference===, int, int) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: actually the method with this number of parameter existed (see below)
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method java.util.List<org.xwiki.ratings.script.RatingApi> org.xwiki.ratings.script.RatingsScriptService::getRatings(org.xwiki.model.reference.DocumentReference, int, int)
    
    ## New:
    method java.util.List<org.xwiki.ratings.Rating> org.xwiki.ratings.script.AbstractScriptRatingsManager::getRatings(org.xwiki.model.reference.EntityReference, int, int, boolean) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: this method was actually not removed but we used an EntityReference instead of Document API. See above.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method java.util.List<org.xwiki.ratings.script.RatingApi> org.xwiki.ratings.script.RatingsScriptService::getRatings(org.xwiki.model.reference.DocumentReference, int, int, boolean)
• Redesign of Ratings API: removal of deprecated methods using Document parameter.
  • Violation type:
    java.method.removed
  • Code:
    ## Old:
    method java.util.List<org.xwiki.ratings.script.RatingApi> org.xwiki.ratings.script.RatingsScriptService::getRatings(com.xpn.xwiki.api.Document, int, int, boolean)
• Redesign of Ratings API: removal of deprecated methods using Document parameter. A new API has been introduced and revapi considers it replaces it.
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method org.xwiki.ratings.script.RatingApi org.xwiki.ratings.script.RatingsScriptService::setRating(com.xpn.xwiki.api.Document, java.lang.String, int)
    
    ## New:
    method java.util.Optional<org.xwiki.ratings.Rating> org.xwiki.ratings.script.AbstractScriptRatingsManager::setRating(org.xwiki.model.reference.EntityReference, int) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: use new best practices for script service return if type is nullable.
  • Violation type:
    java.method.returnTypeChanged
  • Code:
    ## Old:
    method org.xwiki.ratings.script.RatingApi org.xwiki.ratings.script.RatingsScriptService::setRating(com.xpn.xwiki.api.Document, java.lang.String, int)
    
    ## New:
    method java.util.Optional<org.xwiki.ratings.Rating> org.xwiki.ratings.script.AbstractScriptRatingsManager::setRating(org.xwiki.model.reference.EntityReference, int) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: allow to set rating for any reference (not only DocumentReference)
  • Violation type:
    java.method.parameterTypeChanged
  • Code:
    ## Old:
    parameter org.xwiki.ratings.script.RatingApi org.xwiki.ratings.script.RatingsScriptService::setRating(===org.xwiki.model.reference.DocumentReference===, org.xwiki.model.reference.DocumentReference, int)
    
    ## New:
    parameter java.util.Optional<org.xwiki.ratings.Rating> org.xwiki.ratings.script.AbstractScriptRatingsManager::setRating(===org.xwiki.model.reference.EntityReference===, org.xwiki.user.UserReference, int) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: use new best practices for specifying a user by using the UserReference.
  • Violation type:
    java.method.parameterTypeChanged
  • Code:
    ## Old:
    parameter org.xwiki.ratings.script.RatingApi org.xwiki.ratings.script.RatingsScriptService::setRating(org.xwiki.model.reference.DocumentReference, ===org.xwiki.model.reference.DocumentReference===, int)
    
    ## New:
    parameter java.util.Optional<org.xwiki.ratings.Rating> org.xwiki.ratings.script.AbstractScriptRatingsManager::setRating(org.xwiki.model.reference.EntityReference, ===org.xwiki.user.UserReference===, int) @ org.xwiki.ratings.script.RatingsScriptService
• Redesign of Ratings API: use new best practices for script service return if type is nullable.
  • Violation type:
    java.method.returnTypeChanged
  • Code:
    ## Old:
    method org.xwiki.ratings.script.RatingApi org.xwiki.ratings.script.RatingsScriptService::setRating(org.xwiki.model.reference.DocumentReference, org.xwiki.model.reference.DocumentReference, int)
    
    ## New:
    method java.util.Optional<org.xwiki.ratings.Rating> org.xwiki.ratings.script.AbstractScriptRatingsManager::setRating(org.xwiki.model.reference.EntityReference, org.xwiki.user.UserReference, int) @ org.xwiki.ratings.script.RatingsScriptService
• Unstable API.
  • Violation type:
    java.method.addedToInterface
  • Code:
    ## Old:
    
    
    ## New:
    method long org.xwiki.like.LikeManager::countUserLikes(org.xwiki.user.UserReference) throws org.xwiki.like.LikeException
• Unstable API.
  • Violation type:
    java.method.addedToInterface
  • Code:
    ## Old:
    
    
    ## New:
    method void org.xwiki.like.LikeManager::clearCache()
• Unstable API.
  • Violation type:
    java.method.addedToInterface
  • Code:
    ## Old:
    
    
    ## New:
    method void org.xwiki.like.LikeManager::clearCache(org.xwiki.model.reference.EntityReference)
• Unstable API: it has been moved in package org.xwiki.like.events.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.like.LikeEvent
• Unstable API: it has been moved in package org.xwiki.like.events.
  • Violation type:
    java.class.removed
  • Code:
    ## Old:
    class org.xwiki.like.UnlikeEvent

Credits

The following people have contributed code and translations to this release (sorted alphabetically):

Carlos Amengual
DenisF
Eduard Moraru
Francisco García Moreno
ignatescustefan
Jarle Sandmo
jason
Manuel Leduc
Marius Dumitru Florea
Simon Urli
Thomas Mortagne
Vincent Massol
xrichard