Skip to content

Latest commit

 

History

History
150 lines (122 loc) · 5.04 KB

Readme.md

File metadata and controls

150 lines (122 loc) · 5.04 KB
Raw

Skinny WARs with Skinny Configuration (and LTW Ready)

This maven plugin generates skinny WARs with skinny configuration. It will generate an ear with skinny wars using a standard layout or the load time weaver friendly 'communal war' layout discussed in AspectJ LTW in WebLogic 12. Unlike the skinny war functionality built into maven-ear-plugin, this plugin requires very little configuration.

After installing this plugin to the local maven repository, the calling project pom need only add the following section to its build plugins:

For a communal skinny WAR layout:

    <plugin>
        <groupId>net.segner.maven.plugins</groupId>
        <artifactId>skinnywar-maven-plugin</artifactId>
        <configuration>
            <communalWar>sharedwar.war</communalWar>
        </configuration>
        <extensions>true</extensions>
    </plugin>

For a standard skinny WAR layout

    <plugin>
        <groupId>net.segner.maven.plugins</groupId>
        <artifactId>skinnywar-maven-plugin</artifactId>
        <extensions>true</extensions>
    </plugin>

Without setting extension to true, the plugin may still be used with the slightly more verbose:

    <plugin>
        <groupId>net.segner.maven.plugins</groupId>
        <artifactId>skinnywar-maven-plugin</artifactId>
        <configuration>
            <communalWar>sharedwar.war</communalWar>
        </configuration>
        <executions>
            <execution>
                <phase>package</phase>
                <goals>
                    <goal>ear</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

Using EJB

When using EJBs in an application, some extra configuration must be added to your pom files to have the dependencies pushed to their correct locations for communal load time weaving

For each EJB:

  1. the EJB dependency scope must be marked provided in the EAR level pom 
        <dependencies>
    ...
        <dependency>
            <groupId>net.segner.poc.ejb</groupId>
            <artifactId>net-segner-poc-service</artifactId>
            <type>ejb</type>
            <scope>provided</scope>
        </dependency>
    </dependencies>
  2. the EJB dependency with type pom must be added as a dependency of the Communal WAR 
        <dependencies>
    ...
        <dependency>
            <groupId>net.segner.poc.ejb</groupId>
            <artifactId>net-segner-poc-service</artifactId>
            <type>pom</type>
        </dependency>
    </dependencies>

Installing Plugin Locally

This plugin requires a minimum maven version of 3.3.3. To use snapshot versions of the plugin, the snapshot repository should be added to the project pom

    <pluginRepositories>
    ...
        <pluginRepository>
            <id>ossrh</id>
            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        </pluginRepository>
    </pluginRepositories>

A local install can be run simply by downloading the project and building with the standard maven command shown below. This will install the plugin into your local maven repository

$ mvn clean install

Plugin Usage

  • communalWar
  • generateWeblogicLtwMetadata
    • true | false (default: true)
    • Generate metadata to facilitate load time weaving on WebLogic
      • <classloader-structure> section of EAR's weblogic-application.xml, creates file if it does not exist
    • Ignored if the communal war layout is not in use
  • warningBreaksBuild
    • true | false (default: true)
    • Force a warning to fail a build
  • forceAspectJLibToEar
    • true | false (default: true)
    • Add AspectJ related libraries to the ear libraries list below
  • addToManifestClasspath
    • true | false (default: false)
    • Inserts references to the shared libraries into the beginning of the MANIFEST.MF Class-Path attribute
  • earLibraries
    • List of libraries that must be relocated to the EAR, if found (rarely needed)
<earLibraries>
    <libraryPrefixFilter>spring-webmvc</libraryPrefixFilter>
    <libraryPrefixFilter>spring-web-</libraryPrefixFilter>
</earLibraries>
  • pinnedLibraries
    • List of libraries that should not be relocated. List should be specified in the same manner as ear libraries.

Demo Project

A publicly available demo project illustrating this plugins use may be found here: Plugin Demo Project

License