Add a property to exclude all java modules ('jar') from application.xml generation

1 Need a way to mark all transitive dependency of a java module to be marked library hence, added the module as class path item inside MANIFEST.MF and excluded during generation of application.xml

• This is very useful for project that needs bundling of 3rd party library but we don't have to mess up the ear pom.xml by declaring every single items that depends of 3rd party library .

2 Need a way to mark all transitive dependency of a java module to be marked excluded hence, excluded during generation of application.xml

• To make this feature to be consistent with the first comment.

Hi,

Sorry for double posting:

• How about introducing a property that make all artifact with <packaging>jar</packaging (not ejb/war) to be excluded during application.xml generation?
• OR, to only generate artifact as <java> iff artifacts packaging is <packaging>ejb-client</packaging>.

Stephane, does this make any sense to you? I'm not sure why it was assigned directly - perhaps a discussion you had on the list. I'm not an expert on ejb/ear.

FWIW, there is no such packaging as ejb-client though.

Hi,

I'm sorry for the assigneed directly, I accidentally cloned a jira issued on similar problem last night.

Now, in regards to the problem:
If we have a project like the sample project provided by this link
http://jira.codehaus.org/browse/MNG-743

Let's simplify ear/pom.xml to:
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>root.project</groupId>
<artifactId>ear</artifactId>
<packaging>ear</packaging>
<version>1.0</version>
<name>ear assembly</name>
<parent>
<groupId>root</groupId>
<artifactId>project</artifactId>
<version>1.0</version>
</parent>
<dependencies>
<dependency>
<groupId>root.project</groupId>
<artifactId>ejbs</artifactId>
<type>ejb</type>
</dependency>
<dependency>
<groupId>root.project.servlets</groupId>
<artifactId>servlet</artifactId>
<type>war</type>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-ear-plugin</artifactId>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
</manifest>
</archive>
</configuration>
</plugin>
</plugins>
</build>
</project>

When "m2 package" is invoked the generated target/application.xml:
<application>
<display-name>ear</display-name>
<module>
<java>fop-0.20.5.jar</java>
</module>
<module>
<java>primary-source-1.0.jar</java>
</module>
<module>
<java>logging-1.0.jar</java>
</module>
<module>
<web>
<web-uri>servlet-1.0.war</web-uri>
<context-root>/servlet</context-root>
</web>
</module>
<module>
<ejb>ejbs-1.0.jar</ejb>
</module>
</application>

The problem here is logging-1.0.jar, primary-source-1.0.jar, fop-0.20.5.jar are not ejb-client of ejbs-1.0.jar. Hence these jars shouldn't be mentioned inside application.xml and should be identified as library by default.

Now, the next question would be, how are we going to identify ejb-client or standard library without modifying any ear pom.xml
I.e.
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-ear-plugin</artifactId>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
</manifest>
</archive>
<javaModule>
<groupId>group1</groupId>
<artifactId>ejbClient1</artifactId>
</javaModule>
</modules>
</configuration>
</plugin>
</plugins>
</build>

Would it be nicer if we have ejb-client type for example? hence, all we have to do is by adding an extra node inside <dependency> (i.e. <dependency> ... <type>ejb-client</type></dependency> for ejb-client or blank for standard library) or use another <packaging> type inside ejb pom.xml, that way we can skip the <build> node all together

Regards,
Edward

Guys,

I am just coming back from holidays. I will try to have a look to your request shortly.

Brett, yes it does make sense.

> How about introducing a property that make all artifact with <packaging>jar</packaging (not ejb/war)
> to be excluded during application.xml generation?

Sure, why not.

> OR, to only generate artifact as <java> iff artifacts packaging is <packaging>ejb-client</packaging>

I am not fan of this one. I know the spec states that a <java> entry should be made for an ejb-client jar only but I have business cases where we need to put 3rd party libraries in a <java> entry. I agree it does not fully respect the spec but I think it's too restrictive to restrict <java> entries to ejb-client artifacts.

Edward, regarding your original request I will add a property 'ignoreJavaModules' ; If it is set to true, no entry will be put in the application.xml for jar artifacts. It won't be used if application.xml generation is turned off.

WDYT? Perhaps anyone has a better property's name: 'ignoreJavaModules' might be confusing.

Edward,

I have thought a bit about it ; I think my original proposal is wrong.

We DO have ejb-client type so you can do this already.

What I'll do:

• Ignore 'jar' type by default from application.xml generation
• add a 'includeInApplicationXml' property for JavaModule only ; If set this particular dep will be included in the application.xml

I think this solution is closer to the spec and opens the door only if someone wants some specific behavior.

okay?

Note also that there is a 'library' tag on the JavaModule to make it a library. This property will be removed as from this improvment.

• Jar dependencies are not included in the generated application.xml ; Hence 'library' is the default behavior and has been removed
• Added includeInApplicationXml property on JavaModule to allow it to be included in the generated application.xml