Release Notes for XWiki Enterprise 3.3 Milestone 2
Second (and last) milestone release of the 3.3 version.
New and Noteworthy (since XWiki Enterprise 3.3 Milestone 1)
New User Interface for the Extension Manager
Although there's no back-end repository where to search for new extensions yet, the new UI for the Extension Manager is starting to shape up. The previous experimental UI has been replaced by a new category in the Administration dedicated to the extension manager, with three different sections.
Link Checker
It's now possible to check the statuses of all external links found in your wiki.
FAQ Application
A new FAQ application is now made available (but not bundled by default in XWiki Enterprise):
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.
Updated the installation process of Workspaces
The Workspace Application requires that an admin provides the initial workspace template (as before), but now it can be anything the admin wants to use as base. The admin only has to rename it to "workspace-template.xar" and attach it to the WorkspaceManager.Install page. The workspace-related pages and settings will be applied to the template automatically.
For Developers
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
Miscellaneous
- 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.
Translations
No translations have been updated.
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
Known issues
Test Report
You can check the manual test report to learn about what was tested and the results on various browsers.
Backward Compatibility and Migration Notes
General Notes
You may also want to import the default wiki XAR in order to benefit from all the improvements listed above.
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.rendering.configuration.RenderingConfiguration: Method 'public java.util.List getTransformationNames()' has been added to an interface
org.xwiki.rendering.configuration.RenderingConfiguration: Method 'public java.util.List getTransformations()' has been removed
org.xwiki.rendering.listener.chaining.TextOnNewLineStateChainingListener: Class org.xwiki.rendering.listener.chaining.TextOnNewLineStateChainingListener removed
org.xwiki.rendering.macro.box.AbstractBoxMacro: Return type of method 'protected org.xwiki.rendering.internal.macro.MacroContentParser getMacroContentParser()' has been changed to org.xwiki.rendering.macro.MacroContentParser
org.xwiki.rendering.transformation.icon.IconTransformationConfiguration: Method 'public void addMapping(java.lang.String, java.lang.String)' has been added to an interface
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.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
org.xwiki.query.QueryExecutorProvider: Class org.xwiki.query.QueryExecutorProvider removed
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.annotation.reference.IndexedObjectReference: Accessibility of method 'public void setName(java.lang.String)' has been decreased from public to protected
org.xwiki.annotation.event.AbstractAnnotationEvent: Added abstract modifier to class
org.xwiki.cache.eviction.EntryEvictionConfiguration: Method 'public void setAlgotithm(org.xwiki.cache.eviction.EntryEvictionConfiguration$Algorithm)' has been removed
