Release Notes for XWiki Enterprise 3.3

Last modified by Sergiu Dumitriu on 2011/12/17

Following the goals established for the 3.x cycle, XWiki Enterprise 3.3 delivers the first usable but experimental versions of App Within Minutes and Extension Manager features.

New and Noteworthy since XWiki Enterprise 3.2

The full unabridged list of issues fixed in this release is available in our JIRA Dashboard.

App Within Minutes (Experimental)

This feature is experimental at this point which means you shouldn't use it in production at this stage. However we need the maximum number of feedback on this new feature in order to finalize it and to make it reach the production-ready status which we'd like to reach in 3.4 or 3.5.

This feature offers a wizard to help you create collaborative web applications within minutes, based on XWiki's powerful structured data management system.

Check the App Within Minutes documentation for more details.

Extension Manager (Experimental)

This feature is experimental at this point which means you shouldn't use it in production at this stage. However we need the maximum number of feedback on this new feature in order to finalize it and to make it reach the production-ready status which we'd like to reach in 3.4 or 3.5.

Allows installing extensions in a running XWiki Enterprise. There are currently more than 400 extensions on the XWiki Extension Repository.

Check the Extension Manager Application documentation for more details.

em.png

Link Checker

It's now possible to check the statuses of all external links found in your wiki.

externallinks.png

FAQ Application

A new FAQ application is now made available (but not bundled by default in XWiki Enterprise):

faq.png

Better support for exporting CJK documents as PDF

CJK characters, shorthand for Chinese, Japanese and Korean, need special fonts not provided in the standard 14 fonts required by the PDF specification, nor in the FreeFonts distributed and enabled by default with XWiki. Starting with this version we also distribute three new free fonts, along with the configuration needed to enable them for their target languages.

cjk.png

LDAP user membership improvements

Organization unit and search filter support have been added in the group membership mapping settings. To use them, replace the group DN with an organization unit DN or with any search filter.

Attachments improvements

Since the filesystem attachment storage allows uploading very large files, a necessary improvement is to be able to pause and resume downloads. Starting with this version, it is possible to do so, since the /download/ action now respects the Range HTTP header.

Several bugs with downloading attachments when the filesystem storage is enabled have also been fixed, making this feature ready for production use.

Debian packages

Debian packages and repositories are now available.

You can add one of the following list files to /etc/debian/apt/source.list.d/:

sudo wget http://maven.xwiki.org/stable/xwiki-stable.list -P /etc/apt/sources.list.d

For Developers

Script services for Application Manager and Wiki Manager

There are script services now available for the old application and wiki manager plugins. You can access them via $services.applicationmanager and $services.wikimanager, and call all the methods previously exposed by their respective plugin APIs. For the moment the plugins are still there, with the script services just bridging them to the new preferred way of accessing APIs from Velocity scripts.

Cache improvements

Several bugfixes and improvements have been committed, affecting the rendering cache, the cache macro, and the cache infrastructure in general. An important change is the introduction of an infinispan-based cache implementation, replacing JBossCache as the default one.

New xdom+xml syntax

The rendering now come with two reference XML based syntaxes which are the exact representation of rendering events.

Two variants are provided:

  • 1.0: a stable syntax which represent the rendering events in the state they had when this version has been released. If anything change a new version of the syntax will be created (1.1, etc.)
  • current: always in sync with rendering events whatever the version but also mean that it can change anytime without warning, only use that for internal use when you are sure you will render and parse with the same version of XWiki Rendering

XE and XEM XAR changes

The XAR plugin by default doesn't bundle dependencies anymore, so the XE and XEM XARs now come in two variants:

  • the old xwiki-enterprise-wiki module has been renamed into xwiki-enterprise-ui, and produces a XAR only with the documents specific to XWiki Enterprise, without dependencies;
  • the full XAR with all the dependencies bundled in it is now produced by the xwiki-enterprise-ui-all module.

JSR330 Provider Support

XWiki now supports JSR330 Providers.

They are useful for the following use cases:

  • You wish to break a cyclic dependency
  • You wish to lazily get a component instance (instead of it getting injected when your Component is looked up the first time)
  • You wish to control how you return the instance you're providing for. For example you may wish to read the Component Hint from a configuration file and return the instance of the Component matching that Hint dynamically

Component Event Improvements

The registration and unregistration event triggered by a component manager is now perfectly paired. Registering an existing component role and hint now trigger the unregistration event before registering the new component.

New Disposable interface for Components

To prepare the future uninstallation feature of the Extension Manager, singleton components could now implements the Disposable interface. This interface require a single dispose() methods that will be call when a singleton component is unregistered from its component manager. When a singleton component has been created, this could happen in three cases:

  • the component role and hints is explicitly unregistered
  • another component role with same hints is registered and therefore replace the existing component
  • the component instance is explicitly released calling the release function in the manager

Components that require a singleton component should be aware that the instance provided is now subject release and should prevent from accessing a component that have been released. This could be done by observing the registration events of the component manager. The Unregister Event is always triggered when a component is released.

Upgrades

The following dependencies have been upgraded:

  • commons-lang 3.1
  • Groovy 1.8.4
  • LogBack 1.0
  • Selenium 2.13.0
  • SLF4J 1.6.4
  • Maven AntRun Plugin 1.7
  • Maven Shade Plugin 1.5
  • Maven Checkstyle Plugin 2.8
  • CSS4J 0.13
  • JGroups 2.12.2
  • Reflections 0.9.6

Miscellaneous

  • Make it simple to add Icon Transformation mappings when using the Rendering in standalone mode
  • Add support for being able to override components more than once TODO: Document it and linke to the documentation
  • Bundle the Icon and WikiWord Transformations in the Rendering Standalone JAR
  • Comments Macro is not bundled in the Rendering Standalone JAR
  • Allow setting time to live and max entries when using the Cache macro
  • IRC Bot application improvements
  • Move to JBoss Infinispan as default cache implementation
  • Application Manager and Wiki Manager plugins now expose a ScriptService and don't need to be added as plugin in xwiki.cfg file anymore. You can access they using $services.applicationmanager and $services.wikimanager.
  • The Dashboard feature which was part of several applications (XWiki Enterprise Application and Administration Application) has been extracted into in a separate Dashboard Application. There's now a new Dashboard space which is visible in the list of spaces on the XE home page.
  • Starting with XE 3.2 we had introduced caching of rendered content to improve performances but that led to a huge increase in memory needs. We've now tuned this and we've been able to keep the performance improvement and at the same time to drastically reduce the memory need.

Translations

The following translations have been updated: 

  • Czech
  • French
  • Italian
  • Latvian
  • Polish
  • Portuguese (Brazil)
  • Russian
  • Swedish
  • Ukrainian

Supported Browsers

Here's the list of supported browsers for this version (i.e. browsers that we've tested as working):

Internet Explorer
8
Internet Explorer
9
Firefox
3.6
Firefox
8
Chrome
15

Supported Databases

Here's the list of supported databases for this version (i.e. databases that we've tested as working):

  • HSQLDB
  • Oracle 10g and 11g (note that Oracle support was broken in XWiki Enterprise 3.2 and is now fixed in 3.3)
  • MySQL 5.x

Known issues

  • Bugs we know about
  • We've had reports that support for PostgreSQL has been broken since XWiki Enterprise 3.2. If you're using Postgre SQL we recommend you to stay on XWiki Enterprise 3.1.1 and wait for its support to be fixed in upcoming 3.3.1 or 3.4 versions.

Test Report

You can check the manual test reports to learn about what was tested and the results on various browsers.

Backward Compatibility and Migration Notes

General Notes

If you're running in a multiwiki setup you'll also need to define the property xwiki.store.migration.databases=all to your xwiki.cfg file or explicitly name all databases to be migrated as in xwiki.store.migration.databases=db1,db2,....

You may also want to import the default wiki XAR in order to benefit from all the improvements listed above.

Always make sure you compare your xwiki.cfg and xwiki.properties files with the newest version since some configuration parameters were 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.

Issues specific to XWiki Enterprise 3.3

Default Cache implementation changed

As mentioned above, a new cache implementation based on the successor of JBossCache, Infinispan, has been implemented and selected as the default cache provider. Any custom code that deals with caches should be checked for eventual incompatibilities.

Maven XAR plugin behavior changed

The Maven plugin used for packaging XAR modules has been changed so that by default it doesn't bundle the XAR dependencies. This is reflected in the default XE wiki, which now comes in two variants, described above. If you're counting on the old behavior for your custom projects, you can configure the plugin to bundle dependencies by setting the includeDependencies property to true.

Entity references are now immutable

EntityReference (and derived classes, DocumentReference...) has been refactored and are now immutable. This change has been introduced to prevent dangerous issues where a reference hold by an object could be changed by another one. This have a lot of consequences on the reference API and this break the backward compatibility. The following change should be noticed:

  • all setters on EntityReference is now protected and could not be used anymore by any public code. Deriving a reference to render it mutable is hardly discouraged.
  • EntityReference#getChild() has been removed, since a single entity may have more than one child. A EntityReference#getReversedParentChain() method has been added to allow easy iteration from the root entity to their children in a given parent chain.
  • EntityReference#clone() has been removed, a copy-construtor is still available, but is useless since an entity is immutable, there is no need to clone it
  • EntityReference#replaceParent(oldParent,newParent) allow creating a new entity with one of the parent in the parent chain replaced
  • EntityReference#appendParent() allow creating a new entity with an appended root parent, this one is useless on any derived class since the parent chain could not appended in them.

API Breakages

The following APIs were modified since XWiki Enterprise 3.2:

org.xwiki.component.annotation.ComponentAnnotationLoader: In method 'public void initialize(org.xwiki.component.manager.ComponentManager, java.lang.ClassLoader, java.util.List, java.util.List)' the number of arguments has changed
org.xwiki.component.manager.ComponentEventManager: Method 'public void notifyComponentRegistered(org.xwiki.component.descriptor.ComponentDescriptor, org.xwiki.component.manager.ComponentManager)' has been added to an interface
org.xwiki.component.manager.ComponentEventManager: Method 'public void notifyComponentUnregistered(org.xwiki.component.descriptor.ComponentDescriptor, org.xwiki.component.manager.ComponentManager)' has been added to an interface
org.xwiki.annotation.event.AbstractAnnotationEvent: Added abstract modifier to class
org.xwiki.annotation.reference.IndexedObjectReference: Accessibility of method 'public void setName(java.lang.String)' has been decreased from public to protected
com.xpn.xwiki.plugin.applicationmanager.ApplicationManagerPlugin: Removed org.xwiki.observation.EventListener from the set of implemented interfaces
com.xpn.xwiki.plugin.applicationmanager.ApplicationManagerPlugin: Method 'public java.util.List getEvents()' has been removed
com.xpn.xwiki.plugin.applicationmanager.ApplicationManagerPlugin: Method 'public void onEvent(org.xwiki.observation.event.Event, java.lang.Object, java.lang.Object)' has been removed
org.xwiki.cache.eviction.EntryEvictionConfiguration: Method 'public void setAlgotithm(org.xwiki.cache.eviction.EntryEvictionConfiguration$Algorithm)' has been removed
org.xwiki.model.reference.AttachmentReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
org.xwiki.model.reference.AttachmentReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
org.xwiki.model.reference.ClassPropertyReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
org.xwiki.model.reference.ClassPropertyReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
org.xwiki.model.reference.DocumentReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
org.xwiki.model.reference.DocumentReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
org.xwiki.model.reference.DocumentReference: Method 'public void setWikiReference(org.xwiki.model.reference.WikiReference)' has been removed
org.xwiki.model.reference.EntityReference: Method 'public org.xwiki.model.reference.EntityReference clone()' has been removed
org.xwiki.model.reference.EntityReference: Method 'public java.lang.Object clone()' has been removed
org.xwiki.model.reference.EntityReference: Method 'public org.xwiki.model.reference.EntityReference getChild()' has been removed
org.xwiki.model.reference.EntityReference: Method 'public java.lang.String getName()' is now final
org.xwiki.model.reference.EntityReference: Method 'public org.xwiki.model.reference.EntityReference getParent()' is now final
org.xwiki.model.reference.EntityReference: Method 'public org.xwiki.model.EntityType getType()' is now final
org.xwiki.model.reference.EntityReference: Method 'public void setChild(org.xwiki.model.reference.EntityReference)' has been removed
org.xwiki.model.reference.EntityReference: Accessibility of method 'public void setName(java.lang.String)' has been decreased from public to protected
org.xwiki.model.reference.EntityReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
org.xwiki.model.reference.EntityReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
org.xwiki.model.reference.ObjectPropertyReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
org.xwiki.model.reference.ObjectPropertyReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
org.xwiki.model.reference.ObjectPropertyReferenceResolver: Method 'public org.xwiki.model.reference.ObjectPropertyReference resolve(java.lang.Object, java.lang.Object[])' has been added to an interface
org.xwiki.model.reference.ObjectReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
org.xwiki.model.reference.ObjectReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
org.xwiki.model.reference.ObjectReferenceResolver: Method 'public org.xwiki.model.reference.ObjectReference resolve(java.lang.Object, java.lang.Object[])' has been added to an interface
org.xwiki.model.reference.SpaceReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
org.xwiki.model.reference.SpaceReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
org.xwiki.model.reference.WikiReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
com.xpn.xwiki.api.XWiki: Method 'public com.xpn.xwiki.plugin.query.XWikiQuery createQueryFromRequest(java.lang.String)' has been removed
com.xpn.xwiki.api.XWiki: Method 'public java.lang.String displaySearch(java.lang.String, java.lang.String)' has been removed
com.xpn.xwiki.api.XWiki: Method 'public java.lang.String displaySearch(java.lang.String, java.lang.String, com.xpn.xwiki.plugin.query.XWikiCriteria)' has been removed
com.xpn.xwiki.api.XWiki: Method 'public java.lang.String displaySearch(java.lang.String, java.lang.String, java.lang.String, com.xpn.xwiki.plugin.query.XWikiCriteria)' has been removed
com.xpn.xwiki.api.XWiki: Method 'public java.lang.String displaySearchColumns(java.lang.String, com.xpn.xwiki.plugin.query.XWikiQuery)' has been removed
com.xpn.xwiki.api.XWiki: Method 'public java.lang.String displaySearchColumns(java.lang.String, java.lang.String, com.xpn.xwiki.plugin.query.XWikiQuery)' has been removed
com.xpn.xwiki.api.XWiki: Method 'public java.lang.String displaySearchOrder(java.lang.String, com.xpn.xwiki.plugin.query.XWikiQuery)' has been removed
com.xpn.xwiki.api.XWiki: Method 'public java.lang.String displaySearchOrder(java.lang.String, java.lang.String, com.xpn.xwiki.plugin.query.XWikiQuery)' has been removed
com.xpn.xwiki.api.XWiki: Method 'public java.util.List search(com.xpn.xwiki.plugin.query.XWikiQuery)' has been removed
com.xpn.xwiki.api.XWiki: Method 'public java.lang.String searchAsTable(com.xpn.xwiki.plugin.query.XWikiQuery)' has been removed
org.xwiki.query.QueryExecutorProvider: Class org.xwiki.query.QueryExecutorProvider removed
Tags:
Created by Sorin Burjan on 2011/12/15

Get Connected