Version 5.1 by Thomas Mortagne on 2014/12/03

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 This is the release notes for [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]], [[XWiki Platform>>http://platform.xwiki.org]] and [[XWiki Enterprise>>http://enterprise.xwiki.org]]. They share the same release notes as they are released together and have the same version.
6
7 <insert description of release here>
8
9 = New and Noteworthy (since XWiki 6.4-milestone-1) =
10
11 [[Full list of issues fixed and Dashboard for <version>>>http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=<fill id here>]].
12
13 == <feature N> ==
14
15 <description of feature N>
16
17 == Miscellaneous ==
18
19 * The new [[Mail Sender API>>extensions:Extension.Mail Sender API]] now checks for permission before sending emails, when using it from scripts (i.e. when using the Mail Sender Script Service). There are currently 2 possible strategies that you configure in your ##xwiki.properties## file(((
20 {{code language="none"}}
21 #-# [Since 6.4M2]
22 #-# Defines which authorization checks are done when sending mails using the Mail Sender Script Service.
23 #-# Example of valid values:
24 #-# - "programmingrights": the current document must have Programming Rights
25 #-# - "alwaysallow": no check is performed. This is useful when running XWiki in a secure environment where we
26 #-# want to allow all users to be able to send emails through the Script Service.
27 #-# The default is:
28 # mail.sender.scriptServiceCheckerHint = programmingrights
29 {{/code}}
30 )))
31
32 See the [[full list of JIRA issues>>http://jira.xwiki.org/sr/jira.issueviews:searchrequest-printable/temp/SearchRequest.html?jqlQuery=project+in+%28XCOMMONS%2C+XRENDERING%2C+XWIKI%2C+XE%29+and+status+%3D+Closed+and+resolution+%3D+Fixed+and+fixVersion+%3D+%22<version>%22&tempMax=1000]] fixed in this release.
33
34 = For Developers =
35
36 == Mail Sender Permissions ==
37
38 There's now a [[pluggable permission checker>>extensions:Extension.Mail Sender API||anchor="HPluggablePermissionChecker"]] used for checking if a mail should be sent, when using the Mail Sender Script Service. Two implementations are provided (see above) but you can also provide your own implementation by implementing the ##org.xwiki.mail.script.ScriptServicePermissionChecker## component role:
39
40 {{code language="java"}}
41 @Role
42 @Unstable
43 public interface ScriptServicePermissionChecker
44 {
45 /**
46 * @param message the message to check for authorization
47 * @exception MessagingException if the message is not allowed to be sent
48 */
49 void check(MimeMessage message) throws MessagingException;
50 }
51 {{/code}}
52
53 For example you could imagine implementing checks on the size of the email or who the recipients are, run the content of the mail through some filter, etc.
54
55 == Deprecated and Retired projects ==
56
57 <description of deprecated and retired projects>
58
59 == Upgrades ==
60
61 The following dependencies have been upgraded:
62
63 * [[JGroups 3.6.1>>http://jira.xwiki.org/browse/XWIKI-11523]]
64 * [[Pygments 2.0.1>>http://jira.xwiki.org/browse/XWIKI-11522]]
65 * [[Joda-Time 2.6>>http://jira.xwiki.org/browse/XWIKI-11516]]
66
67 == Miscellaneous ==
68
69 <other dev stuff to add and link to JIRA for all issues fixed>
70
71 = Translations =
72
73 The following translations have been updated:
74
75 {{language codes="none, none"/}}
76
77 = Tested Browsers & Databases =
78
79 {{include reference="TestReports.ManualTestReportTemplateSummary"/}}
80
81 = Performances tests compared to <last super stable version> =
82
83 <a summary of the comparison with latest super stable version>
84
85 More details on <link to the test report>.
86
87 = Known issues =
88
89 * [[Bugs we know about>>http://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]]
90
91 = Backward Compatibility and Migration Notes =
92
93 == General Notes ==
94
95 When upgrading make sure you compare your ##xwiki.cfg##, ##xwiki.properties## and ##web.xml## files with the newest version since some configuration parameters may have been modified or 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.
96
97 == Issues specific to XWiki <version> ==
98
99 <issues specific to the project>
100
101 == API Breakages ==
102
103 The following APIs were modified since <project> <version - 1>:
104
105 {{code language="none"}}
106 <clirr output here>
107 {{/code}}

Get Connected