WSO2, Birt 4.4.1, and Maven

The following was originally posted on StackOverflow: <a data-ipb='nomediaparse' href='http://stackoverflow.com/questions/27836264/wso2-birt-4-4-1-and-maven'>http://stackoverflow.com/questions/27836264/wso2-birt-4-4-1-and-maven</a>

I am deploying a web service on WSO2 Application Server 5.2.1 which loads a reportDesign definition from a database table, renders a PDF stream, which is then stored as a file in an outgoing ftp server directory. 
 
The same code listed below works perfectly for a command line utility environment, but not when deployed to WSO2 Application Server v5.2.1 (which is essentially Axis2)
 
My pom.xml file (for Maven) when deploying to WSO2 embeds Birt 4.4.1 runtime in my aar file, which is then deployed as part of a larger car file. This car file contains the Birt runtime jar, as I have not deployed Birt directly to the WSO2 server. Birt jar files are correctly picked up by my web service, but execution does not get too far.

<build> 
<plugins> 
<plugin> 
<groupId>org.apache.maven.plugins</groupId> 
<artifactId>maven-dependency-plugin</artifactId> 
<version>2.8</version> 
<executions> 
<execution> 
<id>copy</id> 
<phase>package</phase> 
<goals> 
<goal>copy</goal> 
</goals> 
<configuration> 
.... 
<artifactItem> 
<groupId>org.eclipse.birt.runtime</groupId> 
<artifactId>org.eclipse.birt.runtime</artifactId> 
<version>4.4.1</version> 
<type>jar</type> 
<overWrite>false</overWrite> 
<outputDirectory>${project.build.directory}/aar/lib</outputDirectory> 
</artifactItem> 
... 
</configuration> 
</execution> 
</executions> 
</plugin> 
... 
</plugins> 
</build> 
<dependencies> 
... 
<dependency> 
<groupId>org.eclipse.birt.runtime</groupId> 
<artifactId>org.eclipse.birt.runtime</artifactId> 
<version>4.4.1</version> 
</dependency> 
... 
</dependencies>
<div> </div>
<div>

</div>
<div>
I am getting a NoClassDefFoundError when calling Platform.startup(config), which is a subclass of Throwable, not Exception... so I've modified my code as follows to catch this error.

try { 
// The EngineConfig is used to set up engine-wide configuration 
// information. 
EngineConfig config = new EngineConfig(); 
// config.setEngineHome(""); 
config.setLogConfig(null, Level.OFF); 
if (config.getLogger() != null) 
System.out.println("

logger is not null"); 
if (config.getServletContext() != null) 
System.out.println("

servlet context is not null"); 
String engineHome = config.getBIRTHome(); 
String birtHome = config.getBIRTHome(); 
System.out.println("

EngineHome = " + engineHome); 
System.out.println("

BirtHome = " + birtHome); 
System.out.println("

Starting the Birt platform now."); 
Platform.startup(config); 
System.out.println("

Creating a report engine factory"); 
IReportEngineFactory reportEngineFactory = (IReportEngineFactory) Platform.createFactoryObject(IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY); 
if (reportEngineFactory == null) 
System.out.println("

reportEngineFactory is null"); 
else 
System.out.println("

reportEngineFactory is NOT null"); 
// Create the report engine itself. This engine can be used to run 
// multiple reports. 
System.out.println("

Creating a report engine"); 
IReportEngine engine = reportEngineFactory.createReportEngine(config); 
// ReportEngine engine = new ReportEngine(config); 
// Create a task to run the report and convert the output to PDF. 
IReportRunnable report = engine.openReportDesign(theReportName, theReportDesign); 
IRunAndRenderTask task = engine.createRunAndRenderTask(report); 
outputStream = new ByteArrayOutputStream(); 
// Define the report generation options 
HTMLRenderOption options = new HTMLRenderOption(); 
options.setOutputFormat(HTMLRenderOption.OUTPUT_FORMAT_PDF); 
options.setOutputStream(outputStream); 
task.setRenderOption(options); 
task.setErrorHandlingOption(IEngineTask.CONTINUE_ON_ERROR); 
// set the parameters to appear in the report 
task.setParameterValues(values); 
// Run the report. 
task.run(); 
} catch (EngineException e1) { 
e1.printStackTrace(); 
} catch (BirtException e) { 
System.out.println("

Got a Birt Exception: " + e.getMessage()); 
e.printStackTrace(); 
} catch (java.lang.NoClassDefFoundError e) { 
System.out.println("

Got an NoClassDefFoundError: " + e.getMessage()); 
e.printStackTrace(); 
} catch (Exception e) { 
System.out.println("

Got an Exception: " + e.getMessage()); 
e.printStackTrace(); 
} finally { 
.... 
}

The stack trace on the error is as as follows:
 
java.lang.NoClassDefFoundError: com/ibm/icu/util/UResourceBundle 
at org.eclipse.birt.core.framework.jar.ServiceLauncher.startup(ServiceLauncher.java:100) 
at org.eclipse.birt.core.framework.Platform.startup(Platform.java:75) 
at com.looppay.reports.generator.BirtReportGenerator.generatePdfReport(BirtReportGenerator.java:119) 
... 
Caused by: java.lang.ClassNotFoundException: Class Not found : com.ibm.icu.util.UResourceBundle 
at org.apache.axis2.deployment.DeploymentClassLoader.findClass(DeploymentClassLoader.java:92) 
at java.lang.ClassLoader.loadClass(ClassLoader.java:306) 
at org.apache.axis2.deployment.DeploymentClassLoader.loadClass(DeploymentClassLoader.java:280) 
at java.lang.ClassLoader.loadClass(ClassLoader.java:247)

But let's also look at the additional config parameters I've printed out:
- EngineHome = null
- BirtHome = null
<div> </div>
<div> </div>
<div>So... two questions:</div>
<ul><li>Are there Birt runtime dependencies which Maven does not pick up? This would cause my class not found issue with om.ibm.icu.util.UResourceBundle</li>
<li>Is it acceptable for both EngineHome and BirtHome to be null, if the Birt runtime classes are already loaded by the same class loader which loads my custom code?</li>
</ul><div> </div>
<div>Thanks in advance for your help.</div>
</div>

Find more posts tagged with

Comments

randalleleonard

<div style="margin:0px 5px 5px 0px;color:rgb(0,0,0);font-family:Arial, 'Liberation Sans', 'DejaVu Sans', sans-serif;">
Ok, figured it out.
First of all, it is acceptable for EngineHome and BirtHome to be null if the runtime engine is already in your path.
As such, my issue is that when building with maven, it is not sufficient just define the the birt runtime in your pom.xml. There are a number of jar files which are not automatically included in the build and are otherwise not found in the WSO2 environment.
To this end, I've thus far added tidy to my pom.xml file, and added the following jar files to my WSO2_HOME/repository/components/dropins folder:
com.lowagie.text_2.1.7.v201004222200.jar 
icu4j-54_1_1.jar 
mysql_connector_java_5.1.26_bin_1.0.0.jar 
org.apache.batik.bridge_1.6.0.v201011041432.jar 
org.apache.batik.css_1.6.0.v201011041432.jar 
org.apache.batik.dom.svg_1.6.0.v201011041432.jar 
org.apache.batik.dom_1.6.0.v201011041432.jar 
org.apache.batik.ext.awt_1.6.0.v201011041432.jar 
org.apache.batik.parser_1.6.0.v201011041432.jar 
org.apache.batik.pdf_1.6.0.v201105071520.jar 
org.apache.batik.svggen_1.6.0.v201011041432.jar 
org.apache.batik.transcoder_1.6.0.v201011041432.jar 
org.apache.batik.util.gui_1.6.0.v201011041432.jar 
org.apache.batik.util_1.6.0.v201011041432.jar 
org.apache.batik.xml_1.6.0.v201011041432.jar 
org.eclipse.datatools.connectivity.oda_3.4.3.v201405301249.jar 
org.w3c.css.sac_1.3.0.v200805290154.jar 
org.w3c.dom.smil_1.0.0.v200806040011.jar 
org.w3c.dom.svg_1.1.0.v201011041433.jar 
org.wso2.carbon.logging.propfile_1.0.0.jar I've also found it necessary to put the following line of code prior to the Platform.startup(config) statement:
// The following line is required in wso2: 
// <a data-ipb='nomediaparse' href='http://stackoverflow.com/questions/13241045/why-doesnt-websphere-like-birt'>http://stackoverflow.com/questions/13241045/why-doesnt-websphere-like-birt</a> 
RegistryProviderFactory.releaseDefault(); 
Platform.startup(config); I am now successfully generating reports in the WSO2 environment. With that said, I am sure of the following:
<ul><li>Additional missing jar files will likely be found as I build out more reports</li>
<li>Some of the jar files I manually added to the wso2 dropins folder may be replaced with additional pom.xml dependencies</li>
</ul>So more trial and error to come. But for now, am successfully generating reports in WSO2.
<div> </div>
</div>