Last modified by Thomas Mortagne on 2023/10/13

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 Following the [[goals established for the 3.x cycle>>Main.Roadmap#HXWikiEnterprise3.xCycle]], XWiki Enterprise 3.3 delivers the first usable but experimental versions of App Within Minutes and Extension Manager features.
6
7 = New and Noteworthy since XWiki Enterprise 3.2 =
8
9 The full unabridged list of issues fixed in this release is available in our [[JIRA Dashboard>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=10590]].
10
11 == App Within Minutes (Experimental) ==
12
13 {{info}}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.{{/info}}
14
15 This feature offers a wizard to help you create collaborative web applications within minutes, based on XWiki's powerful structured data management system.
16
17 Check the [[App Within Minutes documentation>>extensions:Extension.App Within Minutes Application]] for more details.
18
19 {{gallery}}
20 image:AppWithinMinutes-Step0.png
21 image:AppWithinMinutes-Step1.png
22 image:AppWithinMinutes-Step2.png
23 image:AppWithinMinutes-Step3.png
24 image:AppWithinMinutes-HomePage.png
25 {{/gallery}}
26
27 == Extension Manager (Experimental) ==
28
29 {{info}}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.{{/info}}
30
31 Allows installing extensions in a running XWiki Enterprise. There are currently more than 400 extensions on the [[XWiki Extension Repository>>extensions:Main.WebHome]].
32
33 Check the [[Extension Manager Application documentation>>extensions:Extension.Extension Manager Application]] for more details.
34
35 [[image:em.png||class="screenshot"]]
36
37 == Link Checker ==
38
39 It's now possible to [[check the statuses of all external links found in your wiki>>extensions:Extension.Link Checker Application]].
40
41 [[image:externallinks.png||class="screenshot"]]
42
43 == FAQ Application ==
44
45 A [[new FAQ application>>extensions:Extension.FAQ Application]] is now made available (but not bundled by default in XWiki Enterprise):
46
47 [[image:extensions:Extension.FAQ [email protected]||class="screenshot"]]
48
49 == Better support for exporting CJK documents as PDF ==
50
51 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.
52
53 [[image:cjk.png||class="screenshot"]]
54
55 == LDAP user membership improvements ==
56
57 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.
58
59 == Attachments improvements ==
60
61 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.
62
63 Several bugs with downloading attachments when the filesystem storage is enabled have also been fixed, making this feature ready for production use.
64
65 == Debian packages ==
66
67 Debian packages and repositories are now available.
68
69 You can add one of the following list files to ##/etc/debian/apt/source.list.d/##:
70 * http://maven.xwiki.org/stable/xwiki-stable.list : all stable releases starting with 3.3
71 * http://maven.xwiki.org/releases/xwiki-releases.list : all releases starting with 3.3 Milestone 1
72 * http://maven.xwiki.org/snapshots/xwiki-snapshots.list : all snapshots release starting with the 3.3 branch
73
74 {{code}}
75 sudo wget http://maven.xwiki.org/stable/xwiki-stable.list -P /etc/apt/sources.list.d
76 {{/code}}
77
78 = For Developers =
79
80 == Script services for Application Manager and Wiki Manager ==
81
82 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.
83
84 == Cache improvements ==
85
86 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.
87
88 == New xdom+xml syntax ==
89
90 The rendering now come with two reference XML based syntaxes which are the exact representation of rendering events.
91
92 Two variants are provided:
93 * 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.)
94 * 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
95
96 == XE and XEM XAR changes ==
97
98 The XAR plugin by default doesn't bundle dependencies anymore, so the XE and XEM XARs now come in two variants:
99
100 * the old ##xwiki-enterprise-wiki## module has been renamed into [[##xwiki-enterprise-ui##>>https://github.com/xwiki/xwiki-enterprise/tree/xwiki-enterprise-3.3-milestone-1/xwiki-enterprise-ui]], and produces a XAR only with the documents specific to XWiki Enterprise, without dependencies;
101 * the full XAR with all the dependencies bundled in it is now produced by the [[##xwiki-enterprise-ui-all##>>https://github.com/xwiki/xwiki-enterprise/tree/xwiki-enterprise-3.3-milestone-1/xwiki-enterprise-distribution/xwiki-enterprise-ui-all]] module.
102
103 == JSR330 Provider Support ==
104
105 XWiki now [[supports JSR330 Providers>>extensions:Extension.Component Module#HRegisteringandUsingaProvider]].
106
107 They are useful for the following use cases:
108 * You wish to break a cyclic dependency
109 * You wish to lazily get a component instance (instead of it getting injected when your Component is looked up the first time)
110 * 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
111
112 == Component Event Improvements ==
113
114 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.
115
116 == New Disposable interface for Components ==
117
118 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:
119 * the component role and hints is explicitly unregistered
120 * another component role with same hints is registered and therefore replace the existing component
121 * the component instance is explicitly released calling the release function in the manager
122
123 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.
124
125 == Upgrades ==
126
127 The following dependencies have been upgraded:
128
129 * commons-lang 3.1
130 * Groovy 1.8.4
131 * LogBack 1.0
132 * Selenium 2.13.0
133 * SLF4J 1.6.4
134 * Maven AntRun Plugin 1.7
135 * Maven Shade Plugin 1.5
136 * Maven Checkstyle Plugin 2.8
137 * CSS4J 0.13
138 * JGroups 2.12.2
139 * Reflections 0.9.6
140
141 == Miscellaneous ==
142
143 * Make it simple to add Icon Transformation mappings when using the Rendering in standalone mode
144 * Add support for being able to override components more than once TODO: Document it and linke to the documentation
145 * Bundle the Icon and WikiWord Transformations in the Rendering Standalone JAR
146 * Comments Macro is not bundled in the Rendering Standalone JAR
147 * Allow setting time to live and max entries when using the Cache macro
148 * IRC Bot application improvements
149 * Move to JBoss Infinispan as default cache implementation
150 * 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 {{code language="velocity"}}$services.applicationmanager{{/code}} and {{code language="velocity"}}$services.wikimanager{{/code}}.
151 * The Dashboard feature which was part of several applications (XWiki Enterprise Application and Administration Application) has been extracted into in a separate [[Dashboard Application>>extensions:Extension.Dashboard Application]]. There's now a new ##Dashboard## space which is visible in the list of spaces on the XE home page.
152 * 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.
153
154 == Translations ==
155
156 The following translations have been updated:
157
158 {{language codes="cs, fr, it, lv, pl, pt_BR, ru, sv, uk"/}}
159
160 = Supported Browsers =
161
162 Here's the list of supported browsers for this version (i.e. browsers that we've tested as working):
163
164 {{browser name="iexplorer" version="8"/}}
165
166 {{browser name="iexplorer" version="9"/}}
167
168 {{browser name="firefox" version="3.6"/}}
169
170 {{browser name="firefox" version="8"/}}
171
172 {{browser name="chrome" version="15"/}}
173
174 = Supported Databases =
175
176 Here's the list of supported databases for this version (i.e. databases that we've tested as working):
177 * HSQLDB
178 * Oracle 10g and 11g (note that Oracle support was broken in XWiki Enterprise 3.2 and is now fixed in 3.3)
179 * MySQL 5.x
180
181 = Known issues =
182
183 * [[Bugs we know about>>https://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]]
184 * 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.
185
186 = Test Report =
187
188 You can check the [[manual test reports>>http://www.xwiki.org/xwiki/bin/view/TestReports/WebHome]] to learn about what was tested and the results on various browsers.
189
190 = Backward Compatibility and Migration Notes =
191
192 == General Notes ==
193
194 {{warning}}
195 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,...//.
196 {{/warning}}
197
198 You may also want to [[import the default wiki XAR>>Main.Download]] in order to benefit from all the improvements listed above.
199
200 {{warning}}
201 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.
202 {{/warning}}
203
204 == Issues specific to XWiki Enterprise 3.3 ==
205
206 === Default Cache implementation changed ===
207
208 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.
209
210 === Maven XAR plugin behavior changed ===
211
212 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>>#HXEandXEMXARchanges]]. 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##.
213
214 === Entity references are now immutable ===
215
216 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:
217 * 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.
218 * 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.
219 * 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
220 * EntityReference#replaceParent(oldParent,newParent) allow creating a new entity with one of the parent in the parent chain replaced
221 * 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.
222
223 == API Breakages ==
224
225 The following APIs were modified since XWiki Enterprise 3.2:
226
227 {{code language="none"}}
228 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
229 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
230 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
231 org.xwiki.annotation.event.AbstractAnnotationEvent: Added abstract modifier to class
232 org.xwiki.annotation.reference.IndexedObjectReference: Accessibility of method 'public void setName(java.lang.String)' has been decreased from public to protected
233 com.xpn.xwiki.plugin.applicationmanager.ApplicationManagerPlugin: Removed org.xwiki.observation.EventListener from the set of implemented interfaces
234 com.xpn.xwiki.plugin.applicationmanager.ApplicationManagerPlugin: Method 'public java.util.List getEvents()' has been removed
235 com.xpn.xwiki.plugin.applicationmanager.ApplicationManagerPlugin: Method 'public void onEvent(org.xwiki.observation.event.Event, java.lang.Object, java.lang.Object)' has been removed
236 org.xwiki.cache.eviction.EntryEvictionConfiguration: Method 'public void setAlgotithm(org.xwiki.cache.eviction.EntryEvictionConfiguration$Algorithm)' has been removed
237 org.xwiki.model.reference.AttachmentReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
238 org.xwiki.model.reference.AttachmentReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
239 org.xwiki.model.reference.ClassPropertyReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
240 org.xwiki.model.reference.ClassPropertyReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
241 org.xwiki.model.reference.DocumentReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
242 org.xwiki.model.reference.DocumentReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
243 org.xwiki.model.reference.DocumentReference: Method 'public void setWikiReference(org.xwiki.model.reference.WikiReference)' has been removed
244 org.xwiki.model.reference.EntityReference: Method 'public org.xwiki.model.reference.EntityReference clone()' has been removed
245 org.xwiki.model.reference.EntityReference: Method 'public java.lang.Object clone()' has been removed
246 org.xwiki.model.reference.EntityReference: Method 'public org.xwiki.model.reference.EntityReference getChild()' has been removed
247 org.xwiki.model.reference.EntityReference: Method 'public java.lang.String getName()' is now final
248 org.xwiki.model.reference.EntityReference: Method 'public org.xwiki.model.reference.EntityReference getParent()' is now final
249 org.xwiki.model.reference.EntityReference: Method 'public org.xwiki.model.EntityType getType()' is now final
250 org.xwiki.model.reference.EntityReference: Method 'public void setChild(org.xwiki.model.reference.EntityReference)' has been removed
251 org.xwiki.model.reference.EntityReference: Accessibility of method 'public void setName(java.lang.String)' has been decreased from public to protected
252 org.xwiki.model.reference.EntityReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
253 org.xwiki.model.reference.EntityReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
254 org.xwiki.model.reference.ObjectPropertyReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
255 org.xwiki.model.reference.ObjectPropertyReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
256 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
257 org.xwiki.model.reference.ObjectReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
258 org.xwiki.model.reference.ObjectReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
259 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
260 org.xwiki.model.reference.SpaceReference: Accessibility of method 'public void setParent(org.xwiki.model.reference.EntityReference)' has been decreased from public to protected
261 org.xwiki.model.reference.SpaceReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
262 org.xwiki.model.reference.WikiReference: Accessibility of method 'public void setType(org.xwiki.model.EntityType)' has been decreased from public to protected
263 com.xpn.xwiki.api.XWiki: Method 'public com.xpn.xwiki.plugin.query.XWikiQuery createQueryFromRequest(java.lang.String)' has been removed
264 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String displaySearch(java.lang.String, java.lang.String)' has been removed
265 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
266 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
267 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String displaySearchColumns(java.lang.String, com.xpn.xwiki.plugin.query.XWikiQuery)' has been removed
268 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
269 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String displaySearchOrder(java.lang.String, com.xpn.xwiki.plugin.query.XWikiQuery)' has been removed
270 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
271 com.xpn.xwiki.api.XWiki: Method 'public java.util.List search(com.xpn.xwiki.plugin.query.XWikiQuery)' has been removed
272 com.xpn.xwiki.api.XWiki: Method 'public java.lang.String searchAsTable(com.xpn.xwiki.plugin.query.XWikiQuery)' has been removed
273 org.xwiki.query.QueryExecutorProvider: Class org.xwiki.query.QueryExecutorProvider removed{{/code}}

Get Connected