OSGi Runtime: Opening report design containing a chart with design session is failing

[blatra]

With BIRT OSGi 4.10 I can not open a rptdesign containing a chart via the design session, because a MissingResourceException is thrown.

Sample Code:

System.out.println("Call openReportDesign()");
IDesignEngineFactory designFactory = (IDesignEngineFactory) Platform.createFactoryObject (IDesignEngineFactory.EXTENSION_DESIGN_ENGINE_FACTORY);
IDesignEngine designEngine = designFactory.createDesignEngine(designConfig);
SessionHandle designSession = designEngine.newSessionHandle(ULocale.ENGLISH);
ReportDesignHandle design = designSession.openDesign("/path/to/design_with_chart.rptdesign");

If the code is run, following error arises:

Call openReportDesign()
Exception in thread "main" java.lang.ExceptionInInitializerError
	at org.eclipse.birt.chart.util.ChartUtil.<clinit>(ChartUtil.java:125)
	at org.eclipse.birt.chart.reportitem.ChartReportItemImpl.doCompatibility(ChartReportItemImpl.java:282)
	at org.eclipse.birt.chart.reportitem.ChartReportItemImpl.deserialize(ChartReportItemImpl.java:264)
	at org.eclipse.birt.report.model.extension.PeerExtensibilityProvider.initializeReportItem(PeerExtensibilityProvider.java:512)
	at org.eclipse.birt.report.model.elements.ExtendedItem.initializeReportItem(ExtendedItem.java:295)
	at org.eclipse.birt.report.model.parser.ExtendedItemState.end(ExtendedItemState.java:141)
	at org.eclipse.birt.report.model.util.XMLParserHandler.endElement(XMLParserHandler.java:177)
	at java.xml/com.sun.org.apache.xerces.internal.parsers.AbstractSAXParser.endElement(AbstractSAXParser.java:610)
	at java.xml/com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl.scanEndElement(XMLDocumentFragmentScannerImpl.java:1718)
	at java.xml/com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl$FragmentContentDriver.next(XMLDocumentFragmentScannerImpl.java:2883)
	at java.xml/com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl.next(XMLDocumentScannerImpl.java:605)
	at java.xml/com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl.scanDocument(XMLDocumentFragmentScannerImpl.java:534)
	at java.xml/com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:888)
	at java.xml/com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:824)
	at java.xml/com.sun.org.apache.xerces.internal.parsers.XMLParser.parse(XMLParser.java:141)
	at java.xml/com.sun.org.apache.xerces.internal.parsers.AbstractSAXParser.parse(AbstractSAXParser.java:1216)
	at java.xml/com.sun.org.apache.xerces.internal.jaxp.SAXParserImpl$JAXPSAXParser.parse(SAXParserImpl.java:635)
	at java.xml/com.sun.org.apache.xerces.internal.jaxp.SAXParserImpl.parse(SAXParserImpl.java:324)
	at org.eclipse.birt.report.model.parser.ModuleReader.readModule(ModuleReader.java:94)
	at org.eclipse.birt.report.model.parser.ModuleReader.readModule(ModuleReader.java:210)
	at org.eclipse.birt.report.model.parser.DesignReader.read(DesignReader.java:124)
	at org.eclipse.birt.report.model.core.DesignSessionImpl.openDesign(DesignSessionImpl.java:228)
	at org.eclipse.birt.report.model.core.DesignSessionImpl.openDesign(DesignSessionImpl.java:208)
	at org.eclipse.birt.report.model.api.SessionHandleImpl.openDesign(SessionHandleImpl.java:199)
	at org.eclipse.birt.report.model.api.SessionHandle.openDesign(SessionHandle.java:1)
	at de.test.minimalbirtapplication.MinimalBIRTApplication.openReportDesign(MinimalBIRTApplication.java:151)
	at de.test.minimalbirtapplication.MinimalBIRTApplication.main(MinimalBIRTApplication.java:71)
Caused by: java.util.MissingResourceException: Could not find the bundle org.eclipse.birt.chart.engine.i18n.nls_en_US
	at com.ibm.icu.impl.ResourceBundleWrapper.getBundleInstance(ResourceBundleWrapper.java:134)
	at com.ibm.icu.util.UResourceBundle.instantiateBundle(UResourceBundle.java:389)
	at com.ibm.icu.util.UResourceBundle.getBundleInstance(UResourceBundle.java:149)
	at com.ibm.icu.util.UResourceBundle.getBundleInstance(UResourceBundle.java:278)
	at org.eclipse.birt.chart.engine.i18n.Messages.<clinit>(Messages.java:39)
	... 27 more

It seems that this error happens, because the library jar file ReportEngine/lib/chartitemapi.jar of BIRT 4.10 OSGi does not contain the file /org/eclipse/birt/chart/engine/i18n/nls.properties.

With BIRT 4.8 everything is fine. Probably because the file is present in its ReportEngine/lib/chartitemapi.jar.

Do you know why this fallback resource file is missing in BIRT 4.10?

[blatra]

I can confirm that the error is gone, if I provide the file /org/eclipse/birt/chart/engine/i18n/nls.properties manually.

I'm sure this resource file has to be added to future BIRT releases again.

[wimjongman]

The properties file is not included in the jar. In all other similar cases, the properties file is included. I can't find any evidence that this was ever included but still, in 4.8 it is there.

I have updated the build scripts to include the properties file for this package.