Loading BIRT with separate classloader

For development/testing I want to load the the BIRT runtime with a separate classloader into a commandline app. Unfortunately [font="'courier new', courier, monospace;"]Platform.createFactoryObject()[/font] returns null

. 
 
But from the beginning: 
I've deployed for production a BirtService including the BIRT runtime as MBean (inside a SAR file) on JBoss 5.1 and it's working fine. All the jars of the lib folder of the runtime are placed at the root folder of the SAR and my classes (like the BirtService and the MBean) are placed inside the SAR with their packages as folders (as normally inside a JAR). 
 
For development/testing I want to load the content of this SAR with a separate classloader into a commandline app. Therefore I've extracted the SAR to a folder, created a URLClassLoader populated with the URLs of all the extracted JARs and the folder itself to get the contained classes. 
 
Now I'm able to load my BirtService using this CL by reflection and call it to start the Platform. But <pre class="_prettyXprint">Platform.createFactoryObject(IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY)</pre>is failing with a <pre class="_prettyXprint">java.lang.ClassNotFoundException: org.eclipse.osgi.util.NLS</pre>If I'm creating a folder "plugins" inside the extraction folder I'm getting <pre class="_prettyXprint">org.eclipse.birt.core.framework.FrameworkException: Could not find the Framework...</pre>If I'm copying all the JARs to the "plugins" folder (now I have them twice!) createFactoryObject is returning null. The used config is<pre class="_prettyXprint">engineConfig.getAppContext().put( EngineConstants.APPCONTEXT_CLASSLOADER_KEY, Thread.currentThread().getContextClassLoader() );engineConfig.setEngineHome( new File( "req_comp/sarExtractionFolder" ).getAbsolutePath() );</pre>The contextCL is the CL I've used to load the content of the SAR. What is the difference of my deployment and the deployment as SAR inside JBoss? I don't understand why BIRT / OSGI (?) is starting up in a different way. Thanks,Sam

Find more posts tagged with

Comments

fmakwsi

first of all you dont need to set enginehome anymore. I'll post my example for that what i think u wanna do <pre class="_prettyXprint _lang-js"></pre><pre class="_prettyXprint _lang-js"> private void runReport(final HTMLRenderOption renderOptions, final List<String> paramz) { IReportEngine engine = null; EngineConfig config = null; IRunAndRenderTask task = null; try { config = new EngineConfig(); config.setLogConfig(null, Level.OFF); HashMap<String, ClassLoader> map = config.getAppContext(); map.put(EngineConstants.APPCONTEXT_CLASSLOADER_KEY, CompanyData.class.getClassLoader()); // includes the class into the birt classpath by adding it to the // config for the birt engine config.setAppContext(map); Platform.startup(config); final IReportEngineFactory factory = (IReportEngineFactory) Platform .createFactoryObject(IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY); engine = factory.createReportEngine(config); final IReportRunnable design = engine.openReportDesign(REPORT_FILE_PATH); task = engine.createRunAndRenderTask(design); task.setParameterValue("EmployeeName", paramz.get(0)); task.setParameterValue("ProjectId", paramz.get(1)); final Date firstDate = convertStringToLong(paramz.get(2)); final Date secondDate = convertStringToLong(paramz.get(3)); task.setParameterValue("StartDate", firstDate); task.setParameterValue("EndDate", secondDate); task.validateParameters(); task.setRenderOption(renderOptions); task.run();} catch (Exception e) {getLogger().error(e.getMessage(), e);} finally {if (task != null) {task.close();}if (engine != null) {engine.destroy();}Platform.shutdown();}</pre>if you dont understand it or if you got questions ask :-)

sam03

My code is looking pretty the same as yours. I'm able to create a report as long as I do not load BIRT using another classloader. Only that's the issue.If I don't set EngineHome (in my case) I get a<pre class="_prettyXprint">java.lang.ClassNotFoundException: org.eclipse.osgi.util.NLS</pre>Sam

fmakwsi

strange because actually you dont need the enginehome in an OSGI enviroment. Could you pls post the whole method, so i can have a look on it

sam03

The startup code is:<pre class="_prettyXprint">EngineConfig engineConfig = new EngineConfig();engineConfig.getAppContext().put( EngineConstants.APPCONTEXT_CLASSLOADER_KEY, Thread.currentThread().getContextClassLoader() );engineConfig.setLogConfig(null, Level.FINEST); try{ Platform.startup( engineConfig ); IReportEngineFactory factory = (IReportEngineFactory)Platform.createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY ); engine = factory.createReportEngine( engineConfig ); ...}catch(...){ ...}</pre>But the issue is IMHO related to the used classloader. Let's start with the main method:<pre class="_prettyXprint">public static void main( String[] args ){ Object mb = SarLoader.loadObjectFromSar( "req_comp/sarExtractionFolder", "mypackage.ReportServiceMBean" ); Thread.currentThread().setContextClassLoader( mb.getClass().getClassLoader() ); mb.getClass().getMethod( "start", null ).invoke( mb, null );}</pre>Next comes the core part of SarLoader.loadObjectFromSar():<pre class="_prettyXprint">// contains one URL per JAR + one URL of the folder "req_comp/sarExtractionFolder"URL[] jarUrlArray = jarUrls.toArray( new URL[jarUrls.size()] );URLClassLoader sarClassLoader = new URLClassLoader( jarUrlArray, SarLoader.class.getClassLoader() );Class<?> repServiceClass = Class.forName( className, true, sarClassLoader );return repServiceClass.newInstance();</pre>This returns an instance of "mypackage.ReportServiceMBean" which is stored in folder "req_comp/sarExtractionFolder".The method "start" called from the main method contains the startup code listed at the beginning. Please come back if you want a running project. Sam

fmakwsi

Try to use the classload of your class that contains your main method <pre class="_prettyXprint _lang-js">engineConfig.getAppContext().put( EngineConstants.APPCONTEXT_CLASSLOADER_KEY, Thread.currentThread().getContextClassLoader() );</pre>on that line. its the only difference i can see. you've try it through the thread and i'll take the class it self

sam03

The main CL could not load the BIRT classes as they are not part of it's classpath.I tried it an got the same CNFException: org.eclipse.osgi.util.NLS The main difference of our solutions is that you don't not use a separate CL.

sam03

I got it!Spring was part of the classpath (but not referenced) of the main class and that caused the issue. In detail the JAR aspectjtools.jar. It contains equinox classes! Removing the JARs from the classpath solved the issue.As I want to call the report service from a Spring bean I have to try how I could manage that. But that's another story. Thanks,Sam

sam03

This seems to be the same as <a data-ipb='nomediaparse' href='https://bugs.eclipse.org/bugs/show_bug.cgi?id=171186'>https://bugs.eclipse.org/bugs/show_bug.cgi?id=171186</a>. Just a hint for a possible solution to this issue regarding a aspectjtools.jar: For my project it was possible to change the parentCL at<pre class="_prettyXprint">URLClassLoader sarClassLoader = new URLClassLoader( jarUrlArray, SarLoader.class.getClassLoader() );</pre>to<pre class="_prettyXprint">URLClassLoader sarClassLoader = new URLClassLoader( jarUrlArray, null );</pre>Because of that change the classes loaded by this CL can only access the classes/JARs referenced in jarUrlArray and the classes of the JRE. For me that's ok. Sam