What has changed since Magnolia 5.1
The primary areas of impact in this release were internationalization (i18n), templating and activation. Magnolia 5.1.1 delivers the following fixes and enhancements:
- Internationalization (i18n). Default keys are now used for columns and a greater number of actions and messages. Missing keys have been fixed. Click Reload i18n properties files to reload message bundles; no restart required.
- Templating. Resolved a PathNotFoundException caused by an attempt to access an image size property that was not present. Fixed a rendering issue in which an optional area that was not added on author instance was rendered on public anyway. In the contentNavigation template, the
ulelement is now used outside lists.
- Activation. Moving and deleting items now updates the activation status. Previously the status icon for a page remained green even when the page was moved.
If you are updating from an earlier release, look out for these changes:
extended-templating-kitmodule was renamed to
magnolia-module-multisite. Update your POM with the new module name. The module version has also changed. We start versioning from 1.0.
Group ID of enterprise webapps changed from
info.magnolia.eebundlein . Update your POM with the new group ID. Example:
- App Launcher layout configuration was moved from
ui-admincentralmodule. Update your bootstrap files and update tasks.
- Command catalogs have changed. In 5.0, commands were available only in functional catalogs such as
versioned. In 5.1, we reintroduce the pattern used in 4.x series where catalogs are named after workspaces.
- Jackrabbit search index parameter
respectDocumentOrderis now set to
trueby default. This parameter was temporarily set to
falseto improve sorting performance but it did not have the desired effect.
- Added support for version ranges using Maven syntax. This is useful for specifying module dependencies.
- Updated Tika parser libraries to version 1.4.
- Enabled Maven's
importdependency scope in
magnolia-projectwhich allows you to import dependencies from Magnolia POMs.
An aggregated change log for 5.1.1 contains all the changes.
This release is a recommended update for all users of Magnolia 5.
This release includes the following new module versions:
- Magnolia Community Edition 5.1.1
- Magnolia Enterprise Edition 5.1.1
- Activation 5.1
- Admin Interface Legacy 5.1.1
- Cache 5.1
- Contacts 1.1.1
- Content Dependencies 1.3.1
- DAM 1.1.1
- Data 2.1
- Forum 3.1
- Groovy 2.1.1
- In-place Templating 2.1.1
- License 1.4.1
- Mail 5.0.3
- Resources 2.1.1
- RSS Aggregator 2.1
- Standard Templating Kit 2.6.1
- Workflow 5.1.1
The Magnolia team would also like to thank everyone who reported issues, contributed patches, or simply commented on issues for this release. Your continued interest helps us make Magnolia better. Special thanks go to: Archie Cobbs, Marcus Grieder, Rico Jansen, Kaushal Parikh, Marvin Kerkhoff.
How to update from Magnolia 4.5
We recommend that you wait until release 5.2, which is due later in 2013, before updating your project. The 5.2 release will include migration scripts, migration support and migration documentation.
How to migrate from Magnolia 4.4
Updating from 4.4 is a three-step process:
- Update your project first to the latest 4.4 series release. At minimum, update to Magnolia 4.4.6, not older.
- Migrate your project to 4.5. Understand that migration is not a simple update but an effort that needs to be planned ahead. Follow the procedures described in Migration.
- Wait for the 5.2 release later this year. Then update your project to 5.2
Reloading a page in the editor causes a 404 error
When you open a page for editing and reload it in the browser, an extra semicolon is added to the URL fragment and the server returns a 404 error. Every subsequent reload adds another semicolon. This issue occurs with older versions of the Tomcat application server. To resolve this issue, upgrade to Tomcat 7.0.47+. See MGNLUI-2426 - Getting issue details... STATUS
JBoss AS 5 class loading issue with Xerces
If you get an exception about SAX parser when deploying Magnolia on JBoss AS 5 you are hitting an issue with Xerces class loading:
To resolve, remove the Xerces JAR from Magnolia webapps:
- If you deploy using WAR files, remove the JAR from the archive, for example with the following Unix command:
zip -d path-to-magnolia.war WEB-INF/lib/xercesImpl-2.8.1.jar
- If you deploy using an exploded directory, remove the
See MAGNOLIA-2577 - Getting issue details... STATUS for details.
JBoss AS 7 class loading issue with Weld
Using JBoss AS 7 together with Weld dependency injection leads to a class loading issue. The symptom is an error message such as:
To resolve this issue, remove the dependency on Weld. Create a JBoss deployment structure XML file with the following content:
Place the file in
JBoss AS 7 and log4j
JBoss 7 Application Server adds its own log4j logging configuration. If you want to use your own log4j logging configuration in your deployment, exclude the JBoss configuration first.
Create a new file
jboss-deployment-structure.xml under the
WEB-INF folder with this content:
JBoss AS 7 issue loading Vaadin applications
JBoss AS 7 requires that you deploy a
gwt-user.jar when deploying a Vaadin application such as Magnolia. Magnolia does not need the JAR at runtime but if you don't supply it JBoss AS 7 will throw an error:
To resolve this issue, download
gwt-user.jar and copy it into the Web application's classpath. Classpath is a parameter that tells the Java Virtual Machine or the Java compiler where to look for user-defined classes and packages. The classpath of a Magnolia webapp includes any JAR files in
/WEB-INF/lib and any classes and resources in
Oracle WebLogic 9 conflict with JDOM library
Oracle WebLogic 9 also ships with an old version of JDom which later leads to issues in parsing of XML documents. Issues will be noted as exceptions such as:
To resolve, provide newer JDOM/Jaxen libraries by adding
PRE_CLASSPATH variable in the
Oracle WebLogic 10 conflict with commons-lang library
When deploying on Oracle WebLogic 10, there is a version conflict while using
commons-lang. While Oracle WebLogic-10 is distributed with
commons-lang-2.3.jar, JackRabbit and Magnolia need at least
commons-lang-2.4.jar. To resolve this issue, modify
setDomainEnv.sh of Oracle WebLogic and add
commons-lang-2.4.jar to the
PRE_CLASSPATH. Since version 2.4
commons-lang doesn't remove any methods, but only adds new API and fixes known bugs, there is no adverse effect from this change to the Oracle WebLogic installation.
Oracle WebLogic 12c conflict with Bouncy Castle library
Magnolia uses the Bouncy Castle cryptography package to decode the license key and to secure the activation process. Oracle WebLogic 12c is distributed with
bcprov-jdk16-1.45.jar but Magnolia is distributed with
bcprov-jdk16-1.46.jar. This leads to a library version conflict.
Symptom: after inserting valid license key into the Magnolia license form, the error message "License is empty" is displayed.
To resolve, do one of the following:
setDomainEnv.shin Oracle WebLogic and add
bcprov-jdk16-1.45.jarfrom Oracle WebLogic 12c common libraries.
Oracle WebLogic and IBM WebSphere deployment issue with jBPM 6
jBPM 6 cannot be deployed on Oracle WebLogic or IBM WebSphere. jBPM is included in the Magnolia Workflow module. All deployment methods are affected: Administration Console, weblogic.Deployer, wldeploy Ant task and autodeploy directory.
- Deploy an application which doesn't contain Magnolia Workflow with jBPM6, for example Magnolia 5.2.2 or Magnolia 5.3 without the Workflow module.
- In the deployment target location, replace the deployed webapp with a new webapp that contains workflow with jBPM6
Oracle WebLogic 12c conflict with Google Guava library
weblogic.xml file in your application's
WEB-INF folder with the
Mac OS X 10.5 - Leopard
If you use Mac OS X 10.5 or 10.6, you should update to at least 10.5.8 or 10.6.2. Earlier versions cause issues where, when two or more instances are started in the same container, some or all connections are dropped.
The symptoms are that Tomcat is unreachable ("kCFErrorDomainCFNetwork:302") but no log message clearly identifies the issue. Sometimes pages can be loaded but resources cannot, leading to missing images or stylesheets. Another symptom is that you have to kill the Tomcat process to stop it (-HUP works) because the shutdown script cannot reach the running process either. See MAGNOLIA-1959 for more details and comment on your own experience.
Too many open files
This error can occur on some Linux systems when using the embedded Derby database. Derby opens several file handles and may run over the maximum limit set by the system.
The solution is to increase the limit. The exact procedure varies from one Linux distribution to the next. The procedure below works on Ubuntu. For other systems, see Too many open files.
To set a system wide limit for open files on Ubuntu Linux:
- Find the current maximum number of open files per user in a single session:
By default the number is 1024 which is too small.
- Edit the
sudo gedit /etc/security/limits.conf
- Add the following lines to the file:
* soft nofile 10000
* hard nofile 50000
This sets for all users a soft limit of 10000 open files and a hard limit of 50000. These are just example numbers. Set them according to your system needs. Note that the wildcard option applies only to regular users, not to superuser. If you run Magnolia as superuser replace the asterisk with
- Save the file.
- Edit the configuration file for session-related modules:
sudo gedit /etc/pam.d/common-session
- Add the following line to the file:
session required pam_limits.so
- Save the file.
- Restart Ubuntu.
- Verify the new maximum number of open files:
The command should now return 10000.
When installing or updating to a new version, you may see this error message:
This can be due to changes in signatures of classes that are stored in user sessions, such as permissions, user, etc. The error happens when Tomcat attempts to de-serialize serialized sessions as the container starts. The de-serialization causes the loss of persisted sessions. Users will have to log in again. Otherwise it is a harmless error and can be ignored.
If you see the following error message in your logs:
Add the Xalan jar to the
WEB-INF/lib folder of your Magnolia instances, delete the repositories and start again. Please see MAGNOLIA-1958 for more details and comment on your own experience.
Port 8080 is already in use
Port 8080 is the default port for Tomcat. You can see it at the end of the default address
<CATALINA_HOME>/conf/server.xmlin a text editor. This file is under your Magnolia installation directory.
Find the following section and set the value of
portto something other than 8080, for example 8090:
defaultBaseUrl property which is used to generate links in emails or other external systems. To do this, you need to now access Magnolia at the new port 8090.
- Log into the author instance at
- Go to Configuration.
- Set the value of
- Log into the public instance at
- Go to Configuration.
- Set the value of
Now the Welcome page at
has the correct URLs too.
The port also needs to be changed in publishing configuration, otherwise activating changes from the author to public instance fails.
- On the author instance, go to Configuration > Activation > Subscribers.
- Under the
magnoliaPublic8080subscriber, set the
- Rename the subscriber to
- Activate the modified subscriber including its subnodes.
If you want to run two different Tomcats simultaneously you need to change other ports too. This is useful if you want to run different versions of Magnolia at the same time. In
<CATALINA_HOME>/conf/server.xml, change the port numbers for the shutdown and AJP sections and any custom sections you have enabled.
Windows Firewall is blocking Java
Allow an exception in Windows Firewall for Java.
- Go to Control Panel > Windows Firewall.
- Go to the Exceptions tab.
- Click Add Program and browse to the java.exe file in the Java installation directory, for example
- Click OK.
If you get a security alert during startup, check the Private networks checkbox and click Allow access.
CATALINA_HOME environment variable is not defined
CATALINA_HOME environment variable identifies the Tomcat home directory, for example
C:\Program Files\magnolia\apache-tomcat. Usually Magnolia finds this directory automatically. When you type
magnolia_control.bat start in the
bin directory to start the system, a second script named
startup.bat tries to find Tomcat home. It assumes that Tomcat home is one level above the
bin directory where you issued the command, and sets the value of CATALINA_HOME to that directory.
However, if you added the
bin directory to your PATH environment variable you can execute
magnolia_control.bat from anywhere. This means
startup.bat does not find Tomcat home directory by simply moving up one level from where you are and displays the following error:
To correct this define CATALINA_HOME in environment variables. Follow the instructions in Set JAVA_HOME environment variable.
Java out of memory
If the Java Virtual Machine (JVM) does not have enough memory you may see a
java.lang.OutOfMemoryError in the startup log and Magnolia fails to start.
Increase Java heap size to allocate more memory to JVM:
- Stop the server.
- Open file
/apache-tomcat/bin/setenv.baton Windows) in a text editor.
- Edit the
Xmxparameter to set a new maximum heap size. Default size for Magnolia is 512M, try a higher amount such as 1024M.
- Save the file and start the server.
./magnolia_control.sh start && tail -f ../logs/catalina.out
JAR file does not start
When installing the Enterprise Edition on Windows, you can start the installer by double-clicking the JAR file. If this does not work there is a chance that some application on your system has registered the .jar extension.
You can try to fix it yourself by restoring the association of the .jar extension with the
javaw.exe executable. .Right-click the JAR file and select Open With. Typically the
javaw.exe file is in
C:\Program Files (x86)\java\jre6\bin). Alternatively, start the installer from a command prompt with the following command:
java -jar magnolia-enterprise-installer-x.y.z.jar. Make sure the file extension is .jar. Internet Explorer has a tendency to append or change it to .zip.