Maven assembly plugin examples

Posted on May 17, 2015 by

This extends the Maven assembly plugin with additional examples to create an assembly by controlling what artifacts get included in the archive.

Example 1: dev-assembly.xml

The datasource and properties files are packaged for DEV environment.

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
    <id>dev</id>
    <baseDirectory>/</baseDirectory>
    <formats>
        <format>zip</format>
    </formats>
    <fileSets>
        <fileSet>
            <directory>${basedir}/src/config/dev/ds</directory>
            <outputDirectory>ds</outputDirectory>
            <includes>
                <include>*-ds.xml</include>
                <include>*-jboss-beans.xml</include>
            </includes>
        </fileSet>
        <fileSet>
            <directory>${basedir}/src/config/dev/app-properties</directory>
            <outputDirectory>app-properties</outputDirectory>
            <includes>
                <include>**/*</include>
            </includes>
        </fileSet>
    </fileSets>
</assembly>

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">

</formats>

<directory>${basedir}/src/config/dev/ds</directory>

<include>*-jboss-beans.xml</include>

</includes>

</fileSet>

<directory>${basedir}/src/config/dev/app-properties</directory>

<outputDirectory>app-properties</outputDirectory>

</includes>

</fileSet>

</fileSets>

</assembly>

Example 2: dev-assembly.xml

Control what maven dependency jars and class files are included in the archive.

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
    <id>dev</id>
    <baseDirectory>/</baseDirectory>
    <formats>
        <format>zip</format>
    </formats>
    <fileSets>
        <fileSet>
            <directory>src/main/resources</directory>
            <outputDirectory>conf</outputDirectory>
        </fileSet>
        <fileSet>
            <outputDirectory>/</outputDirectory>
            <directory>target/classes</directory>
            <includes>
                <include>com/**/replay/*.*</include>
            </includes>
        </fileSet>
    </fileSets>
    <dependencySets>
        <dependencySet>
            <includes>
                <include>org.springframework:spring-core:jar</include>
            </includes>
            <outputDirectory>lib</outputDirectory>
        </dependencySet>
    </dependencySets>
</assembly>

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">

</formats>

<directory>src/main/resources</directory>

</fileSet>

<directory>target/classes</directory>

<include>com/**/replay/*.*</include>

</includes>

</fileSet>

</fileSets>

<include>org.springframework:spring-core:jar</include>

</includes>

</dependencySet>

</dependencySets>

</assembly>

Example 2: dev-assembly.xml

to include all the jar dependencies in the pom.xml, but exclude some

<dependencySets>
        <dependencySet>
            <excludes>
                <exclude>com.myapp.enabler:app-enabler-service:jar</exclude>
                 <exclude>com.myapp.enabler:app-enabler-common:jar</exclude>
                  <exclude>com.myapp.enabler:app-enabler-schema:jar</exclude>
            </excludes>
            <outputDirectory>lib</outputDirectory>
        </dependencySet>
    </dependencySets>

<exclude>com.myapp.enabler:app-enabler-service:jar</exclude>

<exclude>com.myapp.enabler:app-enabler-common:jar</exclude>

<exclude>com.myapp.enabler:app-enabler-schema:jar</exclude>

</excludes>

</dependencySet>

</dependencySets>

Example 3

The power of includes and excludes. In this example, the whole spring libraries were included from the pom, and out of the inclusions some were excluded.

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
    <id>myapp-replay</id>
    <baseDirectory>/</baseDirectory>
    <formats>
        <format>zip</format>
    </formats>
    <fileSets>
        <fileSet>
            <directory>src/main/resources</directory>
            <outputDirectory>conf</outputDirectory>
            <includes>
                <include>context/myappReplayContext.xml</include>
                <include>certificates/*</include>
                <include>config/*</include>
            </includes>
        </fileSet>
        <fileSet>
            <outputDirectory>/</outputDirectory>
            <directory>target/classes</directory>
            <includes>
                <include>com/**/replay/*.*</include>
                <include>com/mycompany/wrap/myapp/enabler/ssl/*</include>
                <include>com/mycompany/wrap/myapp/enabler/ssl/client/*</include>
            </includes>
        </fileSet>
    </fileSets>
    <dependencySets>
        <dependencySet>
            <includes>
                <include>javax.inject:javax.inject:jar</include>
                <include>org.springframework:**:jar</include>
                <include>org.apache.httpcomponents:**:jar</include>
                <include>com.mycompany.wrap.config:wrap-config-certificates:jar</include>
                <include>org.slf4j:*:jar</include>
                <include>ch.qos.logback:*:jar</include>
                <include>cgilib:*:jar</include>
                <include>antlr:*:jar</include>
                <include>aopalliance:*:jar</include>
                <include>org.aspectj:*:jar</include>
                <include>com.google.guava:*:jar</include>
                <include>org.apache.commons:*:jar</include>
            </includes>
            <excludes>
                <exclude> org.springframework:spring-jdbc:jar</exclude>
                <exclude> org.springframework:spring-orm:jar</exclude>
                <exclude> org.springframework:spring-oxm:jar</exclude>
                <exclude> org.springframework:spring-tx:jar</exclude>
            </excludes>
            <outputDirectory>lib</outputDirectory>
        </dependencySet>
    </dependencySets>
</assembly>

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">

<id>myapp-replay</id>

</formats>

<directory>src/main/resources</directory>

<include>context/myappReplayContext.xml</include>

<include>certificates/*</include>

<include>config/*</include>

</includes>

</fileSet>

<directory>target/classes</directory>

<include>com/**/replay/*.*</include>

<include>com/mycompany/wrap/myapp/enabler/ssl/*</include>

<include>com/mycompany/wrap/myapp/enabler/ssl/client/*</include>

</includes>

</fileSet>

</fileSets>

<include>javax.inject:javax.inject:jar</include>

<include>org.springframework:**:jar</include>

<include>org.apache.httpcomponents:**:jar</include>

<include>com.mycompany.wrap.config:wrap-config-certificates:jar</include>

<include>ch.qos.logback:*:jar</include>

<include>cgilib:*:jar</include>

<include>antlr:*:jar</include>

<include>aopalliance:*:jar</include>

<include>org.aspectj:*:jar</include>

<include>com.google.guava:*:jar</include>

<include>org.apache.commons:*:jar</include>

</includes>

<exclude> org.springframework:spring-jdbc:jar</exclude>

<exclude> org.springframework:spring-orm:jar</exclude>

<exclude> org.springframework:spring-oxm:jar</exclude>

<exclude> org.springframework:spring-tx:jar</exclude>

</excludes>

</dependencySet>

</dependencySets>

</assembly>

About
Latest Posts

Arulkumaran Kumaraswamipillai

Mechanical Engineer to self-taught Java engineer within 2 years & a freelancer within 3 years. Freelancing since 2003. Preparation empowered me to attend 190+ job interviews & choose from 150+ job offers with sought-after contract rates. Author of the book "Java/J2EE job interview companion", which sold 35K+ copies & superseded by this site with 2,050+ registered users. Amazon.com profile | Reviews | LinkedIn | LinkedIn Group | YouTube

Contact us: java-interview@hotmail.com

Latest posts by Arulkumaran Kumaraswamipillai (see all)

300+ Big Data Interview Questions & Answers - July 11, 2022
800+ Java interview questions & answers - July 11, 2022
What does this Unix code snippet do? - July 2, 2022

The contents in this Java-Success are copyrighted and from EmpoweringTech pty ltd. The EmpoweringTech pty ltd has the right to correct or enhance the current content without any prior notice. These are general advice only, and one needs to take his/her own circumstances into consideration. The EmpoweringTech pty ltd will not be held liable for any damages caused or alleged to be caused either directly or indirectly by these materials and resources. Any trademarked names or labels used in this blog remain the property of their respective trademark owners. Links to external sites do not imply endorsement of the linked-to sites. Privacy Policy

Responsive WordPress Theme powered by CyberChimps

Top

Maven assembly plugin examples

Example 1: dev-assembly.xml

Example 2: dev-assembly.xml

Example 2: dev-assembly.xml

Example 3

Java Developer Interview Q&As

Java Architect Interview Q&As

Big Data Interview Q&As

800+ Java Interview Q&As

Disclaimer