0% found this document useful (0 votes)

10 views

Maven

Maven is a project management tool that streamlines the build process for developers by automating tasks such as compilation, testing, and documentation through a standard directory layout and lifecycle. It uses an XML file called pom.xml to define project structure and dependencies, allowing for easy project management and collaboration across teams. The guide also outlines the installation process for Maven and Java, as well as the features and benefits of using Maven in software development.

Uploaded by

archanakumaresan4

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

10 views

Maven

Uploaded by

archanakumaresan4

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 96

Page 1 of 96

Maven - Quick Guide

Maven - Overview
What is Maven?
Maven is a project management and comprehension tool that provides developers a
complete build lifecycle framework. Development team can automate the project's build
infrastructure in almost no time as Maven uses a standard directory layout and a default
build lifecycle.

In case of multiple development teams environment, Maven can set-up the way to work as
per standards in a very short time. As most of the project setups are simple and reusable,
Maven makes life of developer easy while creating reports, checks, build and testing
automation setups.

Maven provides developers ways to manage the following −

Builds

Documentation

Reporting

Dependencies

SCMs

Releases

Distribution

Mailing list

To summarize, Maven simplifies and standardizes the project build process. It handles
compilation, distribution, documentation, team collaboration and other tasks seamlessly.
Maven increases reusability and takes care of most of the build related tasks.

Maven Evolution
Maven was originally designed to simplify building processes in Jakarta Turbine project.
There were several projects and each project contained slightly different ANT build files.
JARs were checked into CVS.

Apache group then developed Maven which can build multiple projects together, publish
projects information, deploy projects, share JARs across several projects and help in
collaboration of teams.
Page 2 of 96

Explore our latest online courses and learn new skills at your own pace. Enroll and
become a certified expert to boost your career.

Objective
The primary goal of Maven is to provide developer with the following −

A comprehensive model for projects, which is reusable, maintainable, and easier to

comprehend.

Plugins or tools that interact with this declarative model.

Maven project structure and contents are declared in an xml file, pom.xml, referred as
Project Object Model (POM), which is the fundamental unit of the entire Maven system. In
later chapters, we will explain POM in detail.

Convention over Configuration

Maven uses Convention over Configuration, which means developers are not required
to create build process themselves.

Developers do not have to mention each and every configuration detail. Maven provides
sensible default behavior for projects. When a Maven project is created, Maven creates
default project structure. Developer is only required to place files accordingly and he/she
need not to define any configuration in pom.xml.

As an example, following table shows the default values for project source code files,
resource files and other configurations. Assuming, ${basedir} denotes the project
location −

Item Default

source code ${basedir}/src/main/java

Resources ${basedir}/src/main/resources

Tests ${basedir}/src/test

Complied byte code ${basedir}/target

distributable JAR ${basedir}/target/classes

In order to build the project, Maven provides developers with options to mention life-cycle
goals and project dependencies (that rely on Maven plugin capabilities and on its default
conventions). Much of the project management and build related tasks are maintained by
Maven plugins.
Page 3 of 96

Developers can build any given Maven project without the need to understand how the
individual plugins work. We will discuss Maven Plugins in detail in the later chapters.

Features of Maven

Simple project setup that follows best practices.

Consistent usage across all projects.

Dependency management including automatic updating.

A large and growing repository of libraries.

Extensible, with the ability to easily write plugins in Java or scripting languages.

Instant access to new features with little or no extra configuration.

Model-based builds − Maven is able to build any number of projects into
predefined output types such as jar, war, metadata.

Coherent site of project information − Using the same metadata as per the
build process, maven is able to generate a website and a PDF including complete
documentation.

Release management and distribution publication − Without additional

configuration, maven will integrate with your source control system such as CVS
and manages the release of a project.

Backward Compatibility − You can easily port the multiple modules of a project
into Maven 3 from older versions of Maven. It can support the older versions also.
Automatic parent versioning − No need to specify the parent in the sub module
for maintenance.

Parallel builds − It analyzes the project dependency graph and enables you to
build schedule modules in parallel. Using this, you can achieve the performance
improvements of 20-50%.

Better Error and Integrity Reporting − Maven improved error reporting, and it
provides you with a link to the Maven wiki page where you will get full description
of the error.

Maven - Environment Setup

Step 1: Verify Java Installation in Your Machine
First of all, open the console and execute a java command based on the operating system
you are working on.

OS Task Command
Page 4 of 96

Windows Open Command Console c:\> java -version

Linux Open Command Terminal $ java -version

Mac Open Terminal machine:< joseph$ java -version

Let's verify the output for all the operating systems −

OS Output

java 11.0.11 2021-04-20 LTS

Java(TM) SE Runtime Environment 18.9 (build 11.0.11+9-LTS-194)
Windows
Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.11+9-LTS-194, mixed
mode)

java 11.0.11 2021-04-20 LTS

Java(TM) SE Runtime Environment 18.9 (build 11.0.11+9-LTS-194)
Linux
Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.11+9-LTS-194, mixed
mode)

java 11.0.11 2021-04-20 LTS

Java(TM) SE Runtime Environment 18.9 (build 11.0.11+9-LTS-194)
Mac
Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.11+9-LTS-194, mixed
mode)

If you do not have Java installed on your system, then download the Java Software
Development Kit (SDK) from the following link http://www.oracle.com. We are assuming
Java 11.0.11 as the installed version for this tutorial.

Step 2: Set JAVA Environment

Set the JAVA_HOME environment variable to point to the base directory location where
Java is installed on your machine. For example.

OS Output

Set the environment variable JAVA_HOME to C:\Program

Windows
Files\Java\jdk11.0.11

Linux export JAVA_HOME = /usr/local/java-current

Mac export JAVA_HOME = /Library/Java/Home

Append Java compiler location to the System Path.

OS Output
Page 5 of 96

Append the string C:\Program Files\Java\jdk11.0.11\bin at the end of

Windows
the system variable, Path.

Linux export PATH = $PATH:$JAVA_HOME/bin/

Mac not required

Verify Java installation using the command java -version as explained above.

Step 3 - Download Maven Archive

Download Maven 3.8.4 from https://maven.apache.org/download.cgi.

OS Archive name

Windows apache-maven-3.8.4-bin.zip

Linux apache-maven-3.8.4-bin.tar.gz

Mac apache-maven-3.8.4-bin.tar.gz

Step 4 - Extract the Maven Archive

Extract the archive, to the directory you wish to install Maven 3.8.4. The subdirectory
apache-maven-3.8.4 will be created from the archive.

OS Location (can be different based on your installation)

Windows C:\Program Files\Apache Software Foundation\apache-maven-3.8.4

Linux /usr/local/apache-maven

Mac /usr/local/apache-maven

Step 5 - Set Maven Environment Variables

Add M2_HOME, M2, MAVEN_OPTS to environment variables.

OS Output

Set the environment variables using system properties.

Windows M2_HOME=C:\Program Files\Apache Software Foundation\apache-maven-
3.8.4 M2=%M2_HOME%\bin MAVEN_OPTS=-Xms256m -Xmx512m

Linux Open command terminal and set environment variables.

Page 6 of 96

export M2_HOME=/usr/local/apache-maven/apache-maven-3.8.4 export

M2=$M2_HOME/bin
export MAVEN_OPTS=-Xms256m -Xmx512m

Open command terminal and set environment variables.

export M2_HOME=/usr/local/apache-maven/apache-maven-3.8.4
Mac
export M2=$M2_HOME/bin
export MAVEN_OPTS=-Xms256m -Xmx512m

Step 6 - Add Maven bin Directory Location to System Path

Now append M2 variable to System Path.

OS Output

Windows Append the string ;%M2% to the end of the system variable, Path.

Linux export PATH=$M2:$PATH

Mac export PATH=$M2:$PATH

Step 7 - Verify Maven Installation

Now open console and execute the following mvn command.

OS Task Command

Windows Open Command Console c:\> mvn --version

Linux Open Command Terminal $ mvn --version

Mac Open Terminal machine:~ joseph$ mvn --version

Finally, verify the output of the above commands, which should be as follows −

OS Output

Apache Maven 3.8.4 (9b656c72d54e5bacbed989b64718c159fe39b537)

Maven home: C:\Program Files\Apache Software Foundation\apache-maven-
3.8.4
Windows Java version: 11.0.11, vendor: Oracle Corporation, runtime: C:\Program
Files\Java\jdk11.0.11\
Default locale: en_IN, platform encoding: Cp1252
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

Linux Apache Maven 3.8.4 (9b656c72d54e5bacbed989b64718c159fe39b537)

Page 7 of 96

Java version: 11.0.11

Java home: /usr/local/java-current/jre

Apache Maven 3.8.4 (9b656c72d54e5bacbed989b64718c159fe39b537)

Mac Java version: 11.0.11
Java home: /Library/Java/Home/jre

Maven - POM
POM stands for Project Object Model. It is fundamental unit of work in Maven. It is an XML
file that resides in the base directory of the project as pom.xml.

The POM contains information about the project and various configuration detail used by
Maven to build the project(s).

POM also contains the goals and plugins. While executing a task or goal, Maven looks for
the POM in the current directory. It reads the POM, gets the needed configuration
information, and then executes the goal. Some of the configuration that can be specified in
the POM are following −

project dependencies

plugins
goals

build profiles
project version

developers
mailing list

Before creating a POM, we should first decide the project group (groupId), its name
(artifactId) and its version as these attributes help in uniquely identifying the project in
repository.

POM Example

<project xmlns = "http://maven.apache.org/POM/4.0.0"

xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.companyname.project-group</groupId>
Page 8 of 96

<artifactId>project</artifactId>
<version>1.0</version>
</project>

It should be noted that there should be a single POM file for each project.

All POM files require the project element and three mandatory fields: groupId,
artifactId, version.
Projects notation in repository is groupId:artifactId:version.

Minimal requirements for a POM −

Sr.No. Node & Description

Project root
1 This is project root tag. You need to specify the basic schema settings such as
apache schema and w3.org specification.

Model version
2
Model version should be 4.0.0.

groupId
This is an Id of project's group. This is generally unique amongst an
3
organization or a project. For example, a banking group com.company.bank
has all bank related projects.

artifactId
This is an Id of the project. This is generally name of the project. For example,
4
consumer-banking. Along with the groupId, the artifactId defines the artifact's
location within the repository.

version
This is the version of the project. Along with the groupId, It is used within an
5 artifact's repository to separate versions from each other. For example −
com.company.bank:consumer-banking:1.0
com.company.bank:consumer-banking:1.1.

Super POM
The Super POM is Maven’s default POM. All POMs inherit from a parent or default (despite
explicitly defined or not). This base POM is known as the Super POM, and contains values
inherited by default.

Maven use the effective POM (configuration from super pom plus project configuration) to
execute relevant goal. It helps developers to specify minimum configuration detail in
Page 9 of 96

his/her pom.xml. Although configurations can be overridden easily.

An easy way to look at the default configurations of the super POM is by running the
following command: mvn help:effective-pom

Create a pom.xml in any directory on your computer.Use the content of above mentioned
example pom.

In example below, We've created a pom.xml in C:\MVN\project folder.

Now open command console, go the folder containing pom.xml and execute the following
mvn command.

C:\MVN\project>mvn help:effective-pom

Maven will start processing and display the effective-pom.

C:\MVN>mvn help:effective-pom
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------< com.companyname.project-group:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-help-plugin:3.2.0:effective-pom (default-cli) @ project ---
[INFO]
Effective POMs, after inheritance, interpolation, and profiles are applied:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.261 s
[INFO] Finished at: 2021-12-10T19:54:53+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

Effective POM displayed as result in console, after inheritance, interpolation, and profiles
are applied.

<?xml version="1.0" encoding="Cp1252"?>

<!-- ======================================================================
<!--
Page 10 of 96

<!-- Generated by Maven Help Plugin on 2021-12-10T19:54:52+05:30

<!-- See: http://maven.apache.org/plugins/maven-help-plugin/
<!--
<!-- ======================================================================
<!-- ======================================================================
<!--
<!-- Effective POM for project
<!-- 'com.companyname.project-group:project:jar:1.0'
<!--
<!-- ======================================================================
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.project-group</groupId>
<artifactId>project</artifactId>
<version>1.0</version>
<repositories>
<repository>
<snapshots>
<enabled>false</enabled>
</snapshots>
<id>central</id>
<name>Central Repository</name>
<url>https://repo.maven.apache.org/maven2</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<releases>
<updatePolicy>never</updatePolicy>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
<id>central</id>
<name>Central Repository</name>
<url>https://repo.maven.apache.org/maven2</url>
</pluginRepository>
</pluginRepositories>
<build>
<sourceDirectory>C:\MVN\src\main\java</sourceDirectory>
<scriptSourceDirectory>C:\MVN\src\main\scripts</scriptSourceDirectory
<testSourceDirectory>C:\MVN\src\test\java</testSourceDirectory>
<outputDirectory>C:\MVN\target\classes</outputDirectory>
<testOutputDirectory>C:\MVN\target\test-classes</testOutputDirectory>
<resources>
Page 11 of 96

<resource>
<directory>C:\MVN\src\main\resources</directory>
</resource>
</resources>
<testResources>
<testResource>
<directory>C:\MVN\src\test\resources</directory>
</testResource>
</testResources>
<directory>C:\MVN\target</directory>
<finalName>project-1.0</finalName>
<pluginManagement>
<plugins>
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.3</version>
</plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.2-beta-5</version>
</plugin>
<plugin>
<artifactId>maven-dependency-plugin</artifactId>
<version>2.8</version>
</plugin>
<plugin>
<artifactId>maven-release-plugin</artifactId>
<version>2.5.3</version>
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<artifactId>maven-clean-plugin</artifactId>
<version>2.5</version>
<executions>
<execution>
<id>default-clean</id>
<phase>clean</phase>
<goals>
<goal>clean</goal>
</goals>
</execution>
</executions>
</plugin>
Page 12 of 96

<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>2.6</version>
<executions>
<execution>
<id>default-testResources</id>
<phase>process-test-resources</phase>
<goals>
<goal>testResources</goal>
</goals>
</execution>
<execution>
<id>default-resources</id>
<phase>process-resources</phase>
<goals>
<goal>resources</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-jar-plugin</artifactId>
<version>2.4</version>
<executions>
<execution>
<id>default-jar</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.1</version>
<executions>
<execution>
<id>default-compile</id>
<phase>compile</phase>
<goals>
<goal>compile</goal>
</goals>
</execution>
<execution>
Page 13 of 96

<id>default-testCompile</id>
<phase>test-compile</phase>
<goals>
<goal>testCompile</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.12.4</version>
<executions>
<execution>
<id>default-test</id>
<phase>test</phase>
<goals>
<goal>test</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-install-plugin</artifactId>
<version>2.4</version>
<executions>
<execution>
<id>default-install</id>
<phase>install</phase>
<goals>
<goal>install</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<version>2.7</version>
<executions>
<execution>
<id>default-deploy</id>
<phase>deploy</phase>
<goals>
<goal>deploy</goal>
</goals>
</execution>
Page 14 of 96

</executions>
</plugin>
<plugin>
<artifactId>maven-site-plugin</artifactId>
<version>3.3</version>
<executions>
<execution>
<id>default-site</id>
<phase>site</phase>
<goals>
<goal>site</goal>
</goals>
<configuration>
<outputDirectory>C:\MVN\target\site</outputDirectory>
<reportPlugins>
<reportPlugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</a
</reportPlugin>
</reportPlugins>
</configuration>
</execution>
<execution>
<id>default-deploy</id>
<phase>site-deploy</phase>
<goals>
<goal>deploy</goal>
</goals>
<configuration>
<outputDirectory>C:\MVN\target\site</outputDirectory>
<reportPlugins>
<reportPlugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</a
</reportPlugin>
</reportPlugins>
</configuration>
</execution>
</executions>
<configuration>
<outputDirectory>C:\MVN\target\site</outputDirectory>
<reportPlugins>
<reportPlugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifac
Page 15 of 96

</reportPlugin>
</reportPlugins>
</configuration>
</plugin>
</plugins>
</build>
<reporting>
<outputDirectory>C:\MVN\target\site</outputDirectory>
</reporting>
</project>

In above pom.xml, you can see the default project source folders structure, output
directory, plug-ins required, repositories, reporting directory, which Maven will be using
while executing the desired goals.

Maven pom.xml is also not required to be written manually. Maven provides numerous
archetype plugins to create projects, which in order, create the project structure and
pom.xml

Maven - Build Life Cycle

What is Build Lifecycle?
A Build Lifecycle is a well-defined sequence of phases, which define the order in which the
goals are to be executed. Here phase represents a stage in life cycle. As an example, a
typical Maven Build Lifecycle consists of the following sequence of phases.

Phase Handles Description

prepare-
resource copying Resource copying can be customized in this phase.
resources

Validating the Validates if the project is correct and if all

validate
information necessary information is available.

compile compilation Source code compilation is done in this phase.

Tests the compiled source code suitable for testing

Test Testing
framework.

This phase creates the JAR/WAR package as

package packaging
mentioned in the packaging in POM.xml.

This phase installs the package in local/remote

install installation
maven repository.
Page 16 of 96

Deploy Deploying Copies the final package to the remote repository.

There are always pre and post phases to register goals, which must run prior to, or after
a particular phase.

When Maven starts building a project, it steps through a defined sequence of phases and
executes goals, which are registered with each phase.

Maven has the following three standard lifecycles −

clean

default(or build)

site

A goal represents a specific task which contributes to the building and managing of a
project. It may be bound to zero or more build phases. A goal not bound to any build
phase could be executed outside of the build lifecycle by direct invocation.

The order of execution depends on the order in which the goal(s) and the build phase(s)
are invoked. For example, consider the command below. The clean and package
arguments are build phases while the dependency:copy-dependencies is a goal.

mvn clean dependency:copy-dependencies package

Here the clean phase will be executed first, followed by the dependency:copy-
dependencies goal, and finally package phase will be executed.

Clean Lifecycle
When we execute mvn post-clean command, Maven invokes the clean lifecycle consisting
of the following phases.

pre-clean

clean

post-clean

Maven clean goal (clean:clean) is bound to the clean phase in the clean lifecycle. Its
clean:cleangoal deletes the output of a build by deleting the build directory. Thus, when
mvn clean command executes, Maven deletes the build directory.

We can customize this behavior by mentioning goals in any of the above phases of clean
life cycle.
Page 17 of 96

In the following example, We'll attach maven-antrun-plugin:run goal to the pre-clean,

clean, and post-clean phases. This will allow us to echo text messages displaying the
phases of the clean lifecycle.

We've created a pom.xml in C:\MVN\project folder.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

<execution>
<id>id.clean</id>
<phase>clean</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>clean phase</echo>
</tasks>
</configuration>
Page 18 of 96

</execution>

<execution>
<id>id.post-clean</id>
<phase>post-clean</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>post-clean phase</echo>
</tasks>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

Now open command console, go to the folder containing pom.xml and execute the
following mvn command.

C:\MVN\project>mvn post-clean

Maven will start processing and displaying all the phases of clean life cycle.

C:\MVN>mvn post-clean
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.pre-clean) @ project ---
[INFO] Executing tasks
[echo] pre-clean phase
[INFO] Executed tasks
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ project ---
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.clean) @ project ---
Page 19 of 96

[INFO] Executing tasks

[echo] clean phase
[INFO] Executed tasks
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.post-clean) @ project ---
[INFO] Executing tasks
[echo] post-clean phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.740 s
[INFO] Finished at: 2021-12-10T20:03:53+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

You can try tuning mvn clean command, which will display pre-clean and clean. Nothing
will be executed for post-clean phase.

Default (or Build) Lifecycle

This is the primary life cycle of Maven and is used to build the application. It has the
following 21 phases.

Sr.No. Lifecycle Phase & Description

validate
1 Validates whether project is correct and all necessary information is available
to complete the build process.

initialize
2
Initializes build state, for example set properties.

generate-sources
3
Generate any source code to be included in compilation phase.

process-sources
4
Process the source code, for example, filter any value.

generate-resources
5
Generate resources to be included in the package.

6 process-resources
Page 20 of 96

Copy and process the resources into the destination directory, ready for
packaging phase.

compile
7
Compile the source code of the project.

process-classes
8 Post-process the generated files from compilation, for example to do bytecode
enhancement/optimization on Java classes.

generate-test-sources
9
Generate any test source code to be included in compilation phase.

process-test-sources
10
Process the test source code, for example, filter any values.

test-compile
11
Compile the test source code into the test destination directory.

process-test-classes
12
Process the generated files from test code file compilation.

test
13
Run tests using a suitable unit testing framework (Junit is one).

prepare-package
14 Perform any operations necessary to prepare a package before the actual
packaging.

package
15 Take the compiled code and package it in its distributable format, such as a
JAR, WAR, or EAR file.

pre-integration-test
16 Perform actions required before integration tests are executed. For example,
setting up the required environment.

integration-test
17 Process and deploy the package if necessary into an environment where
integration tests can be run.

post-integration-test
18 Perform actions required after integration tests have been executed. For
example, cleaning up the environment.

verify
19
Run any check-ups to verify the package is valid and meets quality criteria.
Page 21 of 96

install
20 Install the package into the local repository, which can be used as a
dependency in other projects locally.

deploy
21 Copies the final package to the remote repository for sharing with other
developers and projects.

There are few important concepts related to Maven Lifecycles, which are worth to mention
−

When a phase is called via Maven command, for example mvn compile, only
phases up to and including that phase will execute.

Different maven goals will be bound to different phases of Maven lifecycle

depending upon the type of packaging (JAR / WAR / EAR).

In the following example, we will attach maven-antrun-plugin:run goal to few of the

phases of Build lifecycle. This will allow us to echo text messages displaying the phases of
the lifecycle.

We've updated pom.xml in C:\MVN\project folder.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

<tasks>
<echo>validate phase</echo>
</tasks>
</configuration>
</execution>

<execution>
<id>id.compile</id>
<phase>compile</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>compile phase</echo>
</tasks>
</configuration>
</execution>

<execution>
<id>id.test</id>
<phase>test</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>test phase</echo>
</tasks>
</configuration>
</execution>

<execution>
<id>id.package</id>
<phase>package</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>package phase</echo>
</tasks>
</configuration>
</execution>
Page 23 of 96

<execution>
<id>id.deploy</id>
<phase>deploy</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>deploy phase</echo>
</tasks>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

Now open command console, go the folder containing pom.xml and execute the following
mvn command.

C:\MVN\project>mvn compile

Maven will start processing and display phases of build life cycle up to the compile phase.

C:\MVN>mvn compile
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.validate) @ project ---
[INFO] Executing tasks
[echo] validate phase
[INFO] Executed tasks
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ project ---
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. bu
[INFO] skip non existing resourceDirectory C:\MVN\src\main\resources
[INFO]
Page 24 of 96

[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ project ---

[INFO] No sources to compile
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.compile) @ project ---
[INFO] Executing tasks
[echo] compile phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 3.033 s
[INFO] Finished at: 2021-12-10T20:05:46+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

Site Lifecycle
Maven Site plugin is generally used to create fresh documentation to create reports,
deploy site, etc. It has the following phases −

pre-site

site

post-site

site-deploy

In the following example, we will attach maven-antrun-plugin:run goal to all the phases
of Site lifecycle. This will allow us to echo text messages displaying the phases of the
lifecycle.

We've updated pom.xml in C:\MVN\project folder.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.7</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>2.9</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.1</version>
<executions>
<execution>
<id>id.pre-site</id>
<phase>pre-site</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>pre-site phase</echo>
</tasks>
</configuration>
</execution>

<execution>
<id>id.site</id>
<phase>site</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>site phase</echo>
</tasks>
</configuration>
</execution>

<execution>
<id>id.post-site</id>
<phase>post-site</phase>
Page 26 of 96

<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>post-site phase</echo>
</tasks>
</configuration>
</execution>

<execution>
<id>id.site-deploy</id>
<phase>site-deploy</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>site-deploy phase</echo>
</tasks>
</configuration>
</execution>

</executions>
</plugin>
</plugins>
</build>
</project>

Now open the command console, go the folder containing pom.xml and execute the
following mvn command.

C:\MVN\project>mvn site

Maven will start processing and displaying the phases of site life cycle up to site phase.

C:\MVN>mvn site
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
Page 27 of 96

[INFO] --- maven-antrun-plugin:3.0.0:run (id.pre-site) @ project ---

[INFO] Executing tasks
[WARNING] [echo] pre-site phase
[INFO] Executed tasks
[INFO]
[INFO] --- maven-site-plugin:3.7:site (default-site) @ project ---
[WARNING] Input file encoding has not been set, using platform encoding Cp1252, i.e. bu
[WARNING] No project URL defined - decoration links will not be relativized!
[INFO] Rendering site with org.apache.maven.skins:maven-default-skin:jar:1.2 skin.
[INFO]
[INFO] --- maven-antrun-plugin:3.0.0:run (id.site) @ project ---
[INFO] Executing tasks
[WARNING] [echo] site phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4.323 s
[INFO] Finished at: 2021-12-10T20:22:31+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

Maven - Build Profiles

What is Build Profile?
A Build profile is a set of configuration values, which can be used to set or override default
values of Maven build. Using a build profile, you can customize build for different
environments such as Production v/s Development environments.

Profiles are specified in pom.xml file using its activeProfiles/profiles elements and are
triggered in variety of ways. Profiles modify the POM at build time, and are used to give
parameters different target environments (for example, the path of the database server in
the development, testing, and production environments).

Types of Build Profile

Build profiles are majorly of three types.

Type Where it is defined

Page 28 of 96

Per Project Defined in the project POM file, pom.xml

Per User Defined in Maven settings xml file (%USER_HOME%/.m2/settings.xml)

Global Defined in Maven global settings xml file (%M2_HOME%/conf/settings.xml)

Profile Activation
A Maven Build Profile can be activated in various ways.

Explicitly using command console input.

Through maven settings.

Based on environment variables (User/System variables).

OS Settings (for example, Windows family).

Present/missing files.

Profile Activation Examples

Let us assume the following directory structure of your project −

Now, under src/main/resources, there are three environment specific files −

Sr.No. File Name & Description

env.properties
1
default configuration used if no profile is mentioned.
Page 29 of 96

env.test.properties
2
test configuration when test profile is used.

env.prod.properties
3
production configuration when prod profile is used.

Explicit Profile Activation

In the following example, we will attach maven-antrun-plugin:run goal to test the phase.
This will allow us to echo text messages for different profiles. We will be using pom.xml to
define different profiles and will activate profile at command console using maven
command.

Assume, we've created the following pom.xml in C:\MVN\project folder.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>

Now open the command console, go to the folder containing pom.xml and execute the
following mvn command. Pass the profile name as argument using -P option.

C:\MVN\project>mvn test -Ptest

Maven will start processing and displaying the result of test build profile.

C:\MVN>mvn test -Ptest

[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ project ---
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. bu
[INFO] Copying 3 resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ project ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ project
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. bu
[INFO] skip non existing resourceDirectory C:\MVN\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ project ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ project ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (default) @ project ---
Page 31 of 96

[INFO] Executing tasks

[echo] Using env.test.properties
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.011 s
[INFO] Finished at: 2021-12-10T20:29:39+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

Now as an exercise, you can perform the following steps −

Add another profile element to profiles element of pom.xml (copy existing profile
element and paste it where profile elements ends).

Update id of this profile element from test to normal.

Update task section to echo env.properties and copy env.properties to target

directory.

Again repeat the above three steps, update id to prod and task section for
env.prod.properties.

That's all. Now you've three build profiles ready (normal/test/prod).

Now open the command console, go to the folder containing pom.xml and execute the
following mvn commands. Pass the profile names as argument using -P option.

C:\MVN\project>mvn test -Pnormal

C:\MVN\project>mvn test -Pprod

Check the output of the build to see the difference.

Profile Activation via Maven Settings

Open Maven settings.xml file available in %USER_HOME%/.m2 directory where
%USER_HOME% represents the user home directory. If settings.xml file is not there,
then create a new one.

Add test profile as an active profile using active Profiles node as shown below in example.
Page 32 of 96

<settings xmlns = "http://maven.apache.org/POM/4.0.0"

xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<mirrors>
<mirror>
<id>maven.dev.snaponglobal.com</id>
<name>Internal Artifactory Maven repository</name>
<url>http://repo1.maven.org/maven2/</url>
<mirrorOf>*</mirrorOf>
</mirror>
</mirrors>
<activeProfiles>
<activeProfile>test</activeProfile>
</activeProfiles>
</settings>

Now open command console, go to the folder containing pom.xml and execute the
following mvn command. Do not pass the profile name using -P option. Maven will display
result of test profile being an active profile.

C:\MVN\project>mvn test

Profile Activation via Environment Variables

Now remove active profile from maven settings.xml and update the test profile mentioned
in pom.xml. Add activation element to profile element as shown below.

The test profile will trigger when the system property "env" is specified with the value
"test". Create an environment variable "env" and set its value as "test".

Let's open command console, go to the folder containing pom.xml and execute the
following mvn command.
Page 33 of 96

C:\MVN\project>mvn test

Profile Activation via Operating System

Activation element to include os detail as shown below. This test profile will trigger when
the system is windows XP.

<profile>
<id>test</id>
<activation>
<os>
<name>Windows XP</name>
<family>Windows</family>
<arch>x86</arch>
<version>5.1.2600</version>
</os>
</activation>
</profile>

Now open command console, go to the folder containing pom.xml and execute the
following mvn commands. Do not pass the profile name using -P option. Maven will
display result of test profile being an active profile.

C:\MVN\project>mvn test

Profile Activation via Present/Missing File

Now activation element to include OS details as shown below. The test profile will trigger
when target/generated-sources/axistools/wsdl2java/com/companyname/group
is missing.

<profile>
<id>test</id>
<activation>
<file>
<missing>target/generated-sources/axistools/wsdl2java/
com/companyname/group</missing>
</file>
</activation>
</profile>
Page 34 of 96

Now open the command console, go to the folder containing pom.xml and execute the
following mvn commands. Do not pass the profile name using -P option. Maven will
display result of test profile being an active profile.

C:\MVN\project>mvn test

Maven - Repositories
What is a Maven Repository?
In Maven terminology, a repository is a directory where all the project jars, library jar,
plugins or any other project specific artifacts are stored and can be used by Maven easily.

Maven repository are of three types. The following illustration will give an idea regarding
these three types.

local

central

remote

Local Repository
Maven local repository is a folder location on your machine. It gets created when you run
any maven command for the first time.

Maven local repository keeps your project's all dependencies (library jars, plugin jars etc.).
When you run a Maven build, then Maven automatically downloads all the dependency jars
into the local repository. It helps to avoid references to dependencies stored on remote
machine every time a project is build.
Page 35 of 96

Maven local repository by default get created by Maven in %USER_HOME% directory. To

override the default location, mention another path in Maven settings.xml file available at
%M2_HOME%\conf directory.

<settings xmlns = "http://maven.apache.org/SETTINGS/1.0.0"

xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation = "http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<localRepository>C:/MyLocalRepository</localRepository>
</settings>

When you run Maven command, Maven will download dependencies to your custom path.

Central Repository
Maven central repository is repository provided by Maven community. It contains a large
number of commonly used libraries.

When Maven does not find any dependency in local repository, it starts searching in central
repository using following URL − https://repo1.maven.org/maven2/

Key concepts of Central repository are as follows −

This repository is managed by Maven community.

It is not required to be configured.

It requires internet access to be searched.

To browse the content of central maven repository, maven community has provided a URL
− https://search.maven.org/#browse. Using this library, a developer can search all the
available libraries in central repository.

Remote Repository
Sometimes, Maven does not find a mentioned dependency in central repository as well. It
then stops the build process and output error message to console. To prevent such
situation, Maven provides concept of Remote Repository, which is developer's own
custom repository containing required libraries or other project jars.

For example, using below mentioned POM.xml, Maven will download dependency (not
available in central repository) from Remote Repositories mentioned in the same pom.xml.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
Page 36 of 96

xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.projectgroup</groupId>
<artifactId>project</artifactId>
<version>1.0</version>
<dependencies>
<dependency>
<groupId>com.companyname.common-lib</groupId>
<artifactId>common-lib</artifactId>
<version>1.0.0</version>
</dependency>
<dependencies>
<repositories>
<repository>
<id>companyname.lib1</id>
<url>http://download.companyname.org/maven2/lib1</url>
</repository>
<repository>
<id>companyname.lib2</id>
<url>http://download.companyname.org/maven2/lib2</url>
</repository>
</repositories>
</project>

Maven Dependency Search Sequence

When we execute Maven build commands, Maven starts looking for dependency libraries in
the following sequence −

Step 1 − Search dependency in local repository, if not found, move to step 2 else
perform the further processing.

Step 2 − Search dependency in central repository, if not found and remote

repository/repositories is/are mentioned then move to step 4. Else it is downloaded
to local repository for future reference.

Step 3 − If a remote repository has not been mentioned, Maven simply stops the
processing and throws error (Unable to find dependency).

Step 4 − Search dependency in remote repository or repositories, if found then it

is downloaded to local repository for future reference. Otherwise, Maven stops
processing and throws error (Unable to find dependency).

Maven - Plugins
Page 37 of 96

What are Maven Plugins?

Maven is actually a plugin execution framework where every task is actually done by
plugins. Maven Plugins are generally used to −

create jar file

create war file

compile code files

unit testing of code

create project documentation

create project reports

A plugin generally provides a set of goals, which can be executed using the following
syntax −

mvn [plugin-name]:[goal-name]

For example, a Java project can be compiled with the maven-compiler-plugin's compile-
goal by running the following command.

mvn compiler:compile

Plugin Types
Maven provided the following two types of Plugins −

Sr.No. Type & Description

Build plugins
1 They execute during the build process and should be configured in the
<build/> element of pom.xml.

Reporting plugins
2 They execute during the site generation process and they should be configured
in the <reporting/> element of the pom.xml.

Following is the list of few common plugins −

Sr.No. Plugin & Description

Page 38 of 96

clean
1
Cleans up target after the build. Deletes the target directory.

compiler
2
Compiles Java source files.

surefire
3
Runs the JUnit unit tests. Creates test reports.

jar
4
Builds a JAR file from the current project.

war
5
Builds a WAR file from the current project.

javadoc
6
Generates Javadoc for the project.

antrun
7
Runs a set of ant tasks from any phase mentioned of the build.

Example

We've used maven-antrun-plugin extensively in our examples to print data on console.

Refer Build Profiles chapter. Let us understand it in a better way and create a pom.xml in
C:\MVN\project folder.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>clean phase</echo>
</tasks>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

Next, open the command console and go to the folder containing pom.xml and execute the
following mvn command.

C:\MVN\project>mvn clean

Maven will start processing and displaying the clean phase of clean life cycle.

C:\MVN>mvn clean
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ project ---
[INFO] Deleting C:\MVN\target
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.clean) @ project ---
[INFO] Executing tasks
[echo] clean phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.266 s
[INFO] Finished at: 2021-12-13T13:58:10+05:30
[INFO] ------------------------------------------------------------------------
Page 40 of 96

C:\MVN>

The above example illustrates the following key concepts −

Plugins are specified in pom.xml using plugins element.

Each plugin can have multiple goals.

You can define phase from where plugin should starts its processing using its phase
element. We've used clean phase.

You can configure tasks to be executed by binding them to goals of plugin. We've
bound echo task with run goal of maven-antrun-plugin.

Maven will then download the plugin if not available in local repository and start its
processing.

Maven - Creating Project

Maven uses archetype plugins to create projects. To create a simple java application, we'll
use maven-archetype-quickstart plugin. In example below, we'll create a maven based
java application project in C:\MVN folder.

Let's open the command console, go to the C:\MVN directory and execute the following
mvn command. Make sure that C:\MVN directory is empty before running the command.

C:\MVN>mvn archetype:generate
-DgroupId = com.companyname.bank
-DartifactId = consumerBanking
-DarchetypeArtifactId = maven-archetype-quickstart
-DinteractiveMode = false

Maven will start processing and will create the complete java application project structure.

C:\MVN>mvn archetype:generate -DgroupId=com.companyname.bank -DartifactId=cons

[INFO] <<< maven-archetype-plugin:3.2.0:generate (default-cli) < generate-sources @

[INFO]
[INFO]
[INFO] --- maven-archetype-plugin:3.2.0:generate (default-cli) @ standalone-pom ---
[INFO] Generating project in Batch mode
[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Old (1.x) Archetype: maven-
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: basedir, Value: C:\MVN
[INFO] Parameter: package, Value: com.companyname.bank
[INFO] Parameter: groupId, Value: com.companyname.bank
[INFO] Parameter: artifactId, Value: consumerBanking
[INFO] Parameter: packageName, Value: com.companyname.bank
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] project created from Old (1.x) Archetype in dir: C:\MVN\consumerBanking
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9.396 s
[INFO] Finished at: 2021-12-13T15:13:00+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

Now go to C:/MVN directory. You'll see a java application project created, named consumer
Banking (as specified in artifactId). Maven uses a standard directory layout as shown
below −
Page 42 of 96

Using the above example, we can understand the following key concepts −

Sr.No. Folder Structure & Description

consumerBanking
1
contains src folder and pom.xml

src/main/java
2 contains java code files under the package structure
(com/companyName/bank).

src/main/test
3 contains test java code files under the package structure
(com/companyName/bank).

src/main/resources
4 it contains images/properties files (In above example, we need to create this
structure manually).

If you observe, you will find that Maven also created a sample Java Source file and Java
Test file. Open C:\MVN\consumerBanking\src\main\java\com\companyname\bank folder,
you will see App.java.

package com.companyname.bank;

/**
* Hello world!
*
*/
public class App {
public static void main( String[] args ){
System.out.println( "Hello World!" );
}
}

Open C:\MVN\consumerBanking\src\test\java\com\companyname\bank folder to see

AppTest.java.

package com.companyname.bank;

import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;

/**
Page 43 of 96

* Unit test for simple App.

*/
public class AppTest extends TestCase {
/**
* Create the test case
*
* @param testName name of the test case
*/
public AppTest( String testName ) {
super( testName );
}

/**
* @return the suite of tests being tested
*/
public static Test suite() {
return new TestSuite( AppTest.class );
}

/**
* Rigourous Test :-)
*/
public void testApp() {
assertTrue( true );
}
}

Developers are required to place their files as mentioned in table above and Maven
handles all the build related complexities.

In the next chapter, we'll discuss how to build and test the project using maven Build and
Test Project.

Maven - Build & Test Project

What we learnt in Project Creation chapter is how to create a Java application using
Maven. Now we'll see how to build and test the application.

Go to C:/MVN directory where you've created your java application. Open

consumerBanking folder. You will see the POM.xml file with the following contents.
Update it to reflect the current java version.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
Page 44 of 96

http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.projectgroup</groupId>
<artifactId>project</artifactId>
<version>1.0</version>
<properties>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
</dependency>
</dependencies>
</project>

Here you can see, Maven already added Junit as test framework. By default, Maven adds a
source file App.java and a test file AppTest.java in its default directory structure, as
discussed in the previous chapter.

Let's open the command console, go the C:\MVN\consumerBanking directory and execute
the following mvn command.

C:\MVN\consumerBanking>mvn clean package

Maven will start building the project.

C:\MVN\consumerBanking>mvn clean package

[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.bank:consumerBanking >----------------
[INFO] Building consumerBanking 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ consumerBanking ---
[INFO] Deleting C:\MVN\consumerBanking\target
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ consumerBankin
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. bu
[INFO] skip non existing resourceDirectory C:\MVN\consumerBanking\src\main\resources
[INFO]
Page 45 of 96

[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ consumerBanking ---

[INFO] Changes detected - recompiling the module!
[WARNING] File encoding has not been set, using platform encoding Cp1252, i.e. build is
[INFO] Compiling 1 source file to C:\MVN\consumerBanking\target\classes
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ consum
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. bu
[INFO] skip non existing resourceDirectory C:\MVN\consumerBanking\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ consumerBan
[INFO] Changes detected - recompiling the module!
[WARNING] File encoding has not been set, using platform encoding Cp1252, i.e. build is
[INFO] Compiling 1 source file to C:\MVN\consumerBanking\target\test-classes
[INFO]
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ consumerBanking ---
[INFO] Surefire report directory: C:\MVN\consumerBanking\target\surefire-reports

-------------------------------------------------------
TESTS
-------------------------------------------------------
Running com.companyname.bank.AppTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.028 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO]
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ consumerBanking ---
[INFO] Building jar: C:\MVN\consumerBanking\target\consumerBanking-1.0-SNAPSHOT.j
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4.663 s
[INFO] Finished at: 2021-12-13T17:34:27+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN\consumerBanking>

You've built your project and created final jar file, following are the key learning concepts
−
Page 46 of 96

We give maven two goals, first to clean the target directory (clean) and then
package the project build output as jar (package).

Packaged jar is available in consumerBanking\target folder as consumerBanking-

1.0-SNAPSHOT.jar.

Test reports are available in consumerBanking\target\surefire-reports folder.

Maven compiles the source code file(s) and then tests the source code file(s).

Then Maven runs the test cases.

Finally, Maven creates the package.

Now open the command console, go the C:\MVN\consumerBanking\target\classes

directory and execute the following java command.

>java com.companyname.bank.App

You will see the result as follows −

Hello World!

Adding Java Source Files

Let's see how we can add additional Java files in our project. Open
C:\MVN\consumerBanking\src\main\java\com\companyname\bank folder, create Util class
in it as Util.java.

package com.companyname.bank;

public class Util {

public static void printMessage(String message){
System.out.println(message);
}
}

Update the App class to use Util class.

package com.companyname.bank;

/**
* Hello world!
*
*/
Page 47 of 96

public class App {

public static void main( String[] args ){
Util.printMessage("Hello World!");
}
}

Now open the command console, go the C:\MVN\consumerBanking directory and

execute the following mvn command.

>mvn clean compile

After Maven build is successful, go to the C:\MVN\consumerBanking\target\classes

directory and execute the following java command.

>java -cp com.companyname.bank.App

You will see the result as follows −

Hello World!

Maven - External Dependencies

As you know, Maven does the dependency management using the concept of Repositories.
But what happens if dependency is not available in any of remote repositories and central
repository? Maven provides answer for such scenario using concept of External
Dependency.

For example, let us do the following changes to the project created in ‘Creating Java
Project’ chapter.

Add lib folder to the src folder.

Copy any jar into the lib folder. We've used ldapjdk.jar, which is a helper library
for LDAP operations.

Now our project structure should look like the following −

Page 48 of 96

Here you are having your own library, specific to the project, which is an usual case and it
contains jars, which may not be available in any repository for maven to download from. If
your code is using this library with Maven, then Maven build will fail as it cannot download
or refer to this library during compilation phase.

To handle the situation, let's add this external dependency to maven pom.xml using the
following way.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.bank</groupId>
<artifactId>consumerBanking</artifactId>
<packaging>jar</packaging>
<version>1.0-SNAPSHOT</version>
<name>consumerBanking</name>
<url>http://maven.apache.org</url>

<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>ldapjdk</groupId>
<artifactId>ldapjdk</artifactId>
<scope>system</scope>
<version>1.0</version>
<systemPath>${basedir}\src\lib\ldapjdk.jar</systemPath>
</dependency>
Page 49 of 96

</dependencies>

</project>

Look at the second dependency element under dependencies in the above example, which
clears the following key concepts about External Dependency.

External dependencies (library jar location) can be configured in pom.xml in same

way as other dependencies.

Specify groupId same as the name of the library.

Specify artifactId same as the name of the library.

Specify scope as system.

Specify system path relative to the project location.

Hope now you are clear about external dependencies and you will be able to specify
external dependencies in your Maven project.

Maven - Project Documents

This tutorial will teach you how to create documentation of the application in one go. So
let's start, go to C:/MVN directory where you had created your java consumerBanking
application using the examples given in the previous chapters. Open consumerBanking
folder and execute the following mvn command.

Update, the pom.xml in C:\MVN\consumerBanking folder as shown below.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apach
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.bank</groupId>
<artifactId>consumerBanking</artifactId>
<packaging>jar</packaging>
<version>1.0-SNAPSHOT</version>
<name>consumerBanking</name>
<url>http://maven.apache.org</url>
<properties>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>
<build>
<plugins>
<plugin>
Page 50 of 96

<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.7</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>2.9</version>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>

C:\MVN\consumerBanking>mvn site

Maven will start building the project.

[INFO] Scanning for projects...

[INFO]
[INFO] ----------------< com.companyname.bank:consumerBanking >----------------
[INFO] Building consumerBanking 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-site-plugin:3.7:site (default-site) @ consumerBanking ---
[WARNING] Input file encoding has not been set, using platform encoding Cp1252, i.e. bu
[INFO] Relativizing decoration links with respect to localized project URL: http://maven.a
[INFO] Rendering site with org.apache.maven.skins:maven-default-skin:jar:1.2 skin.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 5.850 s
[INFO] Finished at: 2021-12-13T17:49:56+05:30
[INFO] ------------------------------------------------------------------------
Page 51 of 96

Your project documentation is now ready. Maven has created a site within the target
directory.

Open C:\MVN\consumerBanking\target\site folder. Click on index.html to see the

documentation.

Maven creates the documentation using a documentation-processing engine called Doxia

which reads multiple source formats into a common document model. To write
documentation for your project, you can write your content in a following few commonly
used formats which are parsed by Doxia.
Page 52 of 96

Format
Description Reference
Name

A Maven 1.x documentation

XDoc https://jakarta.apache.org/site
format

FML Used for FAQ documents https://maven.apache.org

Maven - Project Templates

Maven provides users, a very large list of different types of project templates (614 in
numbers) using the concept of Archetype. Maven helps users to quickly start a new java
project using the following command.

mvn archetype:generate

What is Archetype?
Archetype is a Maven plugin whose task is to create a project structure as per its template.
We are going to use quickstart archetype plugin to create a simple java application here.

Using Project Template

Let's open the command console, go to the C:\ > MVN directory and execute the
following mvn command.

C:\MVN>mvn archetype:generate

Maven will start processing and will ask to choose the required archetype.

C:\MVN>mvn archetype:generate
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< org.apache.maven:standalone-pom >-------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] >>> maven-archetype-plugin:3.2.0:generate (default-cli) > generate-sources @
[INFO]
[INFO] <<< maven-archetype-plugin:3.2.0:generate (default-cli) < generate-sources @
Page 53 of 96

[INFO]
[INFO]
[INFO] --- maven-archetype-plugin:3.2.0:generate (default-cli) @ standalone-pom ---
[INFO] Generating project in Interactive mode
[INFO] No archetype defined. Using maven-archetype-quickstart (org.apache.maven.arch
Choose archetype:
1: remote -> am.ik.archetype:elm-spring-boot-blank-archetype (Blank multi project for S
2: remote -> am.ik.archetype:graalvm-blank-archetype (Blank project for GraalVM)
...
3021: remote -> za.co.absa.hyperdrive:component-archetype_2.12 (-)
Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): 1

Press Enter to choose to default option (1843: maven-archetype-quickstart)

Maven will ask for particular version of archetype.

Choose org.apache.maven.archetypes:maven-archetype-quickstart version:

1: 1.0-alpha-1
2: 1.0-alpha-2
3: 1.0-alpha-3
4: 1.0-alpha-4
5: 1.0
6: 1.1
7: 1.3
8: 1.4
Choose a number: 8:

Press Enter to choose to default option (8: maven-archetype-quickstart:1.4)

Maven will ask for the project detail. Enter project detail as asked. Press Enter if the
default value is provided. You can override them by entering your own value.

Define value for property 'groupId': : com.companyname.insurance

Define value for property 'artifactId': : health
Define value for property 'version': 1.0-SNAPSHOT:
Define value for property 'package': com.companyname.insurance:

Maven will ask for the project detail confirmation. Press enter or press Y.

Confirm properties configuration:

groupId: com.companyname.insurance
artifactId: health
Page 54 of 96

version: 1.0-SNAPSHOT
package: com.companyname.insurance
Y:

Now Maven will start creating the project structure and will display the following −

[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Archetype: maven-archetype
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: groupId, Value: com.companyname.insurance
[INFO] Parameter: artifactId, Value: health
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: com.companyname.insurance
[INFO] Parameter: packageInPathFormat, Value: com/companyname/insurance
[INFO] Parameter: package, Value: com.companyname.insurance
[INFO] Parameter: groupId, Value: com.companyname.insurance
[INFO] Parameter: artifactId, Value: health
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Project created from Archetype in dir: C:\MVN\health
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 04:44 min
[INFO] Finished at: 2021-12-13T18:52:59+05:30
[INFO] ------------------------------------------------------------------------

Created Project
Now go to C:\ > MVN directory. You'll see a java application project created, named
health, which was given as artifactId at the time of project creation. Maven will create a
standard directory layout for the project as shown below −
Page 55 of 96

Created POM.xml
Maven generates a POM.xml file for the project as listed below −

<project xmlns = "http://maven.apache.org/POM/4.0.0"

Created App.java
Page 56 of 96

Maven generates sample java source file, App.java for the project as listed below −

Location: C:\ > MVN > health > src > main > java > com > companyname >
insurance > App.java.

package com.companyname.insurance;

/**
* Hello world!
*
*/
public class App {
public static void main( String[] args ) {
System.out.println( "Hello World!" );
}
}

Created AppTest.java
Maven generates sample java source test file, AppTest.java for the project as listed below
−

Location: C:\ > MVN > health > src > test > java > com > companyname >
insurance > AppTest.java.

package com.companyname.insurance;

import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;

/**
* Unit test for simple App.
*/
public class AppTest extends TestCase {
/**
* Create the test case
*
* @param testName name of the test case
*/
public AppTest( String testName ) {
super( testName );
}
/**
Page 57 of 96

* @return the suite of tests being tested

*/
public static Test suite() {
return new TestSuite( AppTest.class );
}
/**
* Rigourous Test :-)
*/
public void testApp() {
assertTrue( true );
}
}

Now you can see the power of Maven. You can create any kind of project using single
command in maven and can kick-start your development.

Different Archetypes

Sr.No. Archetype ArtifactIds & Description

maven-archetype-archetype
1
An archetype, which contains a sample archetype.

maven-archetype-j2ee-simple
2
An archetype, which contains a simplified sample J2EE application.

maven-archetype-mojo
3
An archetype, which contains a sample a sample Maven plugin.

maven-archetype-plugin
4
An archetype, which contains a sample Maven plugin.

maven-archetype-plugin-site
5
An archetype, which contains a sample Maven plugin site.

maven-archetype-portlet
6
An archetype, which contains a sample JSR-268 Portlet.

maven-archetype-quickstart
7
An archetype, which contains a sample Maven project.

maven-archetype-simple
8
An archetype, which contains a simple Maven project.

9 maven-archetype-site
An archetype, which contains a sample Maven site to demonstrates some of
the supported document types like APT, XDoc, and FML and demonstrates how
Page 58 of 96

to i18n your site.

maven-archetype-site-simple
10
An archetype, which contains a sample Maven site.

maven-archetype-webapp
11
An archetype, which contains a sample Maven Webapp project.

Maven - Snapshots
A large software application generally consists of multiple modules and it is common
scenario where multiple teams are working on different modules of same application. For
example, consider a team is working on the front end of the application as app-ui project
(app-ui.jar:1.0) and they are using data-service project (data-service.jar:1.0).

Now it may happen that team working on data-service is undergoing bug fixing or
enhancements at rapid pace and they are releasing the library to remote repository almost
every other day.

Now if data-service team uploads a new version every other day, then following problems
will arise −

data-service team should tell app-ui team every time when they have released an
updated code.

app-ui team required to update their pom.xml regularly to get the updated version.

To handle such kind of situation, SNAPSHOT concept comes into play.

What is SNAPSHOT?
SNAPSHOT is a special version that indicates a current development copy. Unlike regular
versions, Maven checks for a new SNAPSHOT version in a remote repository for every
build.

Now data-service team will release SNAPSHOT of its updated code every time to
repository, say data-service: 1.0-SNAPSHOT, replacing an older SNAPSHOT jar.

Snapshot vs Version
In case of Version, if Maven once downloaded the mentioned version, say data-
service:1.0, it will never try to download a newer 1.0 available in repository. To download
the updated code, data-service version is be upgraded to 1.1.

In case of SNAPSHOT, Maven will automatically fetch the latest SNAPSHOT (data-
service:1.0-SNAPSHOT) every time app-ui team build their project.
Page 59 of 96

app-ui pom.xml
app-ui project is using 1.0-SNAPSHOT of data-service.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

data-service pom.xml
data-service project is releasing 1.0-SNAPSHOT for every minor change.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

Although, in case of SNAPSHOT, Maven automatically fetches the latest SNAPSHOT on

daily basis, you can force maven to download latest snapshot build using -U switch to any
maven command.

mvn clean package -U

Let's open the command console, go to the C:\ > MVN > app-ui directory and execute
the following mvn command.

C:\MVN\app-ui>mvn clean package -U

Maven will start building the project after downloading the latest SNAPSHOT of data-
service.

[INFO] Scanning for projects...

[INFO]--------------------------------------------
[INFO] Building consumerBanking
[INFO] task-segment: [clean, package]
[INFO]--------------------------------------------
[INFO] Downloading data-service:1.0-SNAPSHOT
[INFO] 290K downloaded.
[INFO] [clean:clean {execution: default-clean}]
[INFO] Deleting directory C:\MVN\app-ui\target
[INFO] [resources:resources {execution: default-resources}]

[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources,

i.e. build is platform dependent!

[INFO] skip non existing resourceDirectory C:\MVN\app-ui\src\main\resources

[INFO] [compiler:compile {execution:default-compile}]
[INFO] Compiling 1 source file to C:\MVN\app-ui\target\classes
[INFO] [resources:testResources {execution: default-testResources}]

[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources,

i.e. build is platform dependent!
Page 61 of 96

[INFO] skip non existing resourceDirectory C:\MVN\app-ui\src\test\resources

[INFO] [compiler:testCompile {execution: default-testCompile}]
[INFO] Compiling 1 source file to C:\MVN\app-ui\target\test-classes
[INFO] [surefire:test {execution: default-test}]
[INFO] Surefire report directory: C:\MVN\app-ui\target\
surefire-reports

--------------------------------------------------
TESTS
--------------------------------------------------

Running com.companyname.bank.AppTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.027 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO] [jar:jar {execution: default-jar}]

[INFO] Building jar: C:\MVN\app-ui\target\
app-ui-1.0-SNAPSHOT.jar
[INFO]--------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO]--------------------------------------------------------
[INFO] Total time: 2 seconds
[INFO] Finished at: 2015-09-27T12:30:02+05:30
[INFO] Final Memory: 16M/89M
[INFO]------------------------------------------------------------------------

Maven - Build Automation

Build Automation defines the scenario where dependent project(s) build process gets
started once the project build is successfully completed, in order to ensure that dependent
project(s) is/are stable.

Example

Consider a team is developing a project bus-core-api on which two other projects app-
web-ui and app-desktop-ui are dependent.

app-web-ui project is using 1.0-SNAPSHOT of bus-core-api project.

Page 62 of 96

<project xmlns = "http://maven.apache.org/POM/4.0.0"

app-desktop-ui project is using 1.0-SNAPSHOT of bus-core-api project.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

<version>1.0-SNAPSHOT</version>
<scope>system</scope>
<systemPath>C:\MVN\bus_core_api\target\bus_core_api-1.0-SNAPSHOT.j
</dependency>
</dependencies>
</project>

bus-core-api project −

<project xmlns = "http://maven.apache.org/POM/4.0.0"

Now, teams of app-web-ui and app-desktop-ui projects require that their build process
should kick off whenever bus-core-api project changes.

Using snapshot, ensures that the latest bus-core-api project should be used but to meet
the above requirement we need to do something extra.

We can proceed with the following two ways −

Add a post-build goal in bus-core-api pom to kick-off app-web-ui and app-

desktop-ui builds.

Use a Continuous Integration (CI) Server like Hudson to manage build automation
automatically.

Using Maven
Update bus-core-api project pom.xml.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

<artifactId>bus-core-api</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<build>
<plugins>
<plugin>
<artifactId>maven-invoker-plugin</artifactId>
<version>1.6</version>
<configuration>
<debug>true</debug>
<pomIncludes>
<pomInclude>app-web-ui/pom.xml</pomInclude>
<pomInclude>app-desktop-ui/pom.xml</pomInclude>
</pomIncludes>
</configuration>
<executions>
<execution>
<id>build</id>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
<build>
</project>

Let's open the command console, go to the C:\ > MVN > bus-core-api directory and
execute the following mvn command.

>mvn clean package -U

Maven will start building the project bus-core-api.

[INFO] Scanning for projects...

[INFO] ------------------------------------------------------------------
[INFO] Building bus-core-api
[INFO] task-segment: [clean, package]
[INFO] ------------------------------------------------------------------
...
[INFO] [jar:jar {execution: default-jar}]
[INFO] Building jar: C:\MVN\bus-core-ui\target\
Page 65 of 96

bus-core-ui-1.0-SNAPSHOT.jar
[INFO] ------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------

Once bus-core-api build is successful, Maven will start building the app-web-ui project.

[INFO] ------------------------------------------------------------------
[INFO] Building app-web-ui
[INFO] task-segment: [package]
[INFO] ------------------------------------------------------------------
...
[INFO] [jar:jar {execution: default-jar}]
[INFO] Building jar: C:\MVN\app-web-ui\target\
app-web-ui-1.0-SNAPSHOT.jar
[INFO] ------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------

Once app-web-ui build is successful, Maven will start building the app-desktop-ui
project.

[INFO] ------------------------------------------------------------------
[INFO] Building app-desktop-ui
[INFO] task-segment: [package]
[INFO] ------------------------------------------------------------------
...
[INFO] [jar:jar {execution: default-jar}]
[INFO] Building jar: C:\MVN\app-desktop-ui\target\
app-desktop-ui-1.0-SNAPSHOT.jar
[INFO] -------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] -------------------------------------------------------------------

Using Continuous Integration Service with Maven

Using a CI Server is more preferable to developers. It is not required to update the bus-
core-api project, every time a new project (for example, app-mobile-ui) is added, as
dependent project on bus-core-api project. Hudsion is a continuous integration tool
written in java, which in a servlet container, such as, Apache tomcat and glassfish
Page 66 of 96

application server. Hudson automatically manages build automation using Maven

dependency management. The following snapshot will define the role of Hudson tool.

Hudson considers each project build as job. Once a project code is checked-in to SVN (or
any Source Management Tool mapped to Hudson), Hudson starts its build job and once
this job gets completed, it start other dependent jobs (other dependent projects)
automatically.

In the above example, when bus-core-ui source code is updated in SVN, Hudson starts
its build. Once build is successful, Hudson looks for dependent projects automatically, and
starts building app-web-ui and app-desktop-ui projects.

Maven - Manage Dependencies

One of the core features of Maven is Dependency Management. Managing dependencies is
a difficult task once we've to deal with multi-module projects (consisting of hundreds of
modules/sub-projects). Maven provides a high degree of control to manage such
scenarios.

Transitive Dependencies Discovery

It is pretty often a case, when a library, say A, depends upon other library, say B. In case
another project C wants to use A, then that project requires to use library B too.

Maven helps to avoid such requirements to discover all the libraries required. Maven does
so by reading project files (pom.xml) of dependencies, figure out their dependencies and
so on.

We only need to define direct dependency in each project pom. Maven handles the rest
automatically.
Page 67 of 96

With transitive dependencies, the graph of included libraries can quickly grow to a large
extent. Cases can arise when there are duplicate libraries. Maven provides few features to
control extent of transitive dependencies.

Sr.No. Feature & Description

Dependency mediation
Determines what version of a dependency is to be used when multiple versions
1
of an artifact are encountered. If two dependency versions are at the same
depth in the dependency tree, the first declared dependency will be used.

Dependency management
Directly specify the versions of artifacts to be used when they are encountered
2 in transitive dependencies. For an example project C can include B as a
dependency in its dependency Management section and directly control which
version of B is to be used when it is ever referenced.

Dependency scope
3
Includes dependencies as per the current stage of the build.

Excluded dependencies
Any transitive dependency can be excluded using "exclusion" element. As
4
example, A depends upon B and B depends upon C, then A can mark C as
excluded.

Optional dependencies
Any transitive dependency can be marked as optional using "optional" element.
5
As example, A depends upon B and B depends upon C. Now B marked C as
optional. Then A will not use C.

Dependency Scope
Transitive Dependencies Discovery can be restricted using various Dependency Scope as
mentioned below.

Sr.No. Scope & Description

compile
1 This scope indicates that dependency is available in classpath of project. It is
default scope.

provided
2 This scope indicates that dependency is to be provided by JDK or web-
Server/Container at runtime.

3 runtime
Page 68 of 96

This scope indicates that dependency is not required for compilation, but is
required during execution.

test
4 This scope indicates that the dependency is only available for the test
compilation and execution phases.

system
5
This scope indicates that you have to provide the system path.

import
This scope is only used when dependency is of type pom. This scope indicates
6
that the specified POM should be replaced with the dependencies in that POM's
<dependencyManagement> section.

Dependency Management
Usually, we have a set of project under a common project. In such case, we can create a
common pom having all the common dependencies and then make this pom, the parent of
sub-project's poms. Following example will help you understand this concept.

Following are the detail of the above dependency graph −

App-UI-WAR depends upon App-Core-lib and App-Data-lib.

Root is parent of App-Core-lib and App-Data-lib.

Root defines Lib1, lib2, Lib3 as dependencies in its dependency section.

App-UI-WAR

<project xmlns = "http://maven.apache.org/POM/4.0.0"

<groupId>com.companyname.groupname</groupId>
<artifactId>App-UI-WAR</artifactId>
<version>1.0</version>
<packaging>war</packaging>
<dependencies>
<dependency>
<groupId>com.companyname.groupname</groupId>
<artifactId>App-Core-lib</artifactId>
<version>1.0</version>
</dependency>
</dependencies>
<dependencies>
<dependency>
<groupId>com.companyname.groupname</groupId>
<artifactId>App-Data-lib</artifactId>
<version>1.0</version>
</dependency>
</dependencies>
</project>

App-Core-lib

<project xmlns = "http://maven.apache.org/POM/4.0.0"

xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>Root</artifactId>
<groupId>com.companyname.groupname</groupId>
<version>1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.groupname</groupId>
<artifactId>App-Core-lib</artifactId>
<version>1.0</version>
<packaging>jar</packaging>
</project>

App-Data-lib

<project xmlns = "http://maven.apache.org/POM/4.0.0"

xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
Page 70 of 96

<parent>
<artifactId>Root</artifactId>
<groupId>com.companyname.groupname</groupId>
<version>1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.groupname</groupId>
<artifactId>App-Data-lib</artifactId>
<version>1.0</version>
<packaging>jar</packaging>
</project>

Root

<project xmlns = "http://maven.apache.org/POM/4.0.0"

xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.groupname</groupId>
<artifactId>Root</artifactId>
<version>1.0</version>
<packaging>pom</packaging>
<dependencies>
<dependency>
<groupId>com.companyname.groupname1</groupId>
<artifactId>Lib1</artifactId>
<version>1.0</version>
</dependency>
</dependencies>
<dependencies>
<dependency>
<groupId>com.companyname.groupname2</groupId>
<artifactId>Lib2</artifactId>
<version>2.1</version>
</dependency>
</dependencies>
<dependencies>
<dependency>
<groupId>com.companyname.groupname3</groupId>
<artifactId>Lib3</artifactId>
<version>1.1</version>
</dependency>
Page 71 of 96

</dependencies>
</project>

Now when we build App-UI-WAR project, Maven will discover all the dependencies by
traversing the dependency graph and build the application.

From above example, we can learn the following key concepts −

Common dependencies can be placed at single place using concept of parent pom.
Dependencies of App-Data-lib and App-Core-lib project are listed in Root project
(See the packaging type of Root. It is POM).

There is no need to specify Lib1, lib2, Lib3 as dependency in App-UI-WAR. Maven

use the Transitive Dependency Mechanism to manage such detail.

Maven - Deployment Automation

In project development, normally a deployment process consists of the following steps −

Check-in the code from all project in progress into the SVN (version control
system) or source code repository and tag it.

Download the complete source code from SVN.

Build the application.

Store the build output either WAR or EAR file to a common network location.

Get the file from network and deploy the file to the production site.

Updated the documentation with date and updated version number of the
application.

Problem Statement
There are normally multiple people involved in the above mentioned deployment process.
One team may handle check-in of code, other may handle build and so on. It is very likely
that any step may be missed out due to manual efforts involved and owing to multi-team
environment. For example, older build may not be replaced on network machine and
deployment team deployed the older build again.

Solution
Automate the deployment process by combining the following −

Maven, to build and release projects.

Page 72 of 96

SubVersion, source code repository, to manage source code.

Remote Repository Manager (Jfrog/Nexus) to manage project binaries.

Update Project POM.xml

We will be using Maven Release plug-in to create an automated release process.

For Example: bus-core-api project POM.xml.

<project xmlns = "http://maven.apache.org/POM/4.0.0"

xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>bus-core-api</groupId>
<artifactId>bus-core-api</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<scm>
<url>http://www.svn.com</url>
<connection>scm:svn:http://localhost:8080/svn/jrepo/trunk/
Framework</connection>
<developerConnection>scm:svn:${username}/${password}@localhost:8080:
common_core_api:1101:code</developerConnection>
</scm>
<distributionManagement>
<repository>
<id>Core-API-Java-Release</id>
<name>Release repository</name>
<url>http://localhost:8081/nexus/content/repositories/
Core-Api-Release</url>
</repository>
</distributionManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>2.0-beta-9</version>
<configuration>
<useReleaseProfile>false</useReleaseProfile>
<goals>deploy</goals>
<scmCommentPrefix>[bus-core-api-release-checkin]-<
/scmCommentPrefix>
Page 73 of 96

</configuration>
</plugin>
</plugins>
</build>
</project>

In Pom.xml, following are the important elements we have used −

Sr.No. Element & Description

SCM
1
Configures the SVN location from where Maven will check out the source code.

Repositories
2 Location where built WAR/EAR/JAR or any other artifact will be stored after
code build is successful.

Plugin
3
maven-release-plugin is configured to automate the deployment process.

Maven Release Plug-in

The Maven does the following useful tasks using maven-release-plugin.

mvn release:clean

It cleans the workspace in case the last release process was not successful.

mvn release:rollback

Rollback the changes done to workspace code and configuration in case the last release
process was not successful.

mvn release:prepare

Performs multiple number of operations, such as −

Checks whether there are any uncommitted local changes or not.

Ensures that there are no SNAPSHOT dependencies.

Changes the version of the application and removes SNAPSHOT from the version to
make release.
Page 74 of 96

Update pom files to SVN.

Run test cases.

Commit the modified POM files.

Tag the code in subversion

Increment the version number and append SNAPSHOT for future release.

Commit the modified POM files to SVN.

mvn release:perform

Checks out the code using the previously defined tag and run the Maven deploy goal, to
deploy the war or built artifact to repository.

Let's open the command console, go to the C:\ > MVN >bus-core-api directory and
execute the following mvn command.

>mvn release:prepare

Maven will start building the project. Once build is successful run the following mvn
command.

>mvn release:perform

Once build is successful you can verify the uploaded JAR file in your repository.

Maven - Web Application

This chapter teaches you how to manage a web based project using Maven. Here you will
learn how to create/build/deploy and run a web application.

Create Web Application

To create a simple java web application, we will use maven-archetype-webapp plugin.
So, let's open the command console, go to the C:\MVN directory and execute the
following mvn command.

C:\MVN>mvn archetype:generate
-DgroupId = com.companyname.automobile
-DartifactId = trucks
Page 75 of 96

-DarchetypeArtifactId = maven-archetype-webapp
-DinteractiveMode = false

Maven will start processing and will create the complete web based java application project
structure as follows −

C:\MVN>mvn archetype:generate -DgroupId=com.companyname.automobile -DartifactId

[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< org.apache.maven:standalone-pom >-------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] --------------------------------[ pom ]---------------------------------
...
[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Old (1.x) Archetype: maven-
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: basedir, Value: C:\MVN
[INFO] Parameter: package, Value: com.companyname.automobile
[INFO] Parameter: groupId, Value: com.companyname.automobile
[INFO] Parameter: artifactId, Value: trucks
[INFO] Parameter: packageName, Value: com.companyname.automobile
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] project created from Old (1.x) Archetype in dir: C:\MVN\trucks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 10.381 s
[INFO] Finished at: 2021-12-13T19:00:13+05:30
[INFO] ------------------------------------------------------------------------
C:\MVN>

Now go to C:/MVN directory. You'll see a java application project created, named trucks
(as specified in artifactId) as specified in the following snapshot. The following directory
structure is generally used for web applications −
Page 76 of 96

Maven uses a standard directory layout. Using the above example, we can understand the
following key concepts −

Sr.No. Folder Structure & Description

trucks
1
contains src folder and pom.xml.

src/main/webapp
2
contains index.jsp and WEB-INF folder.

src/main/webapp/WEB-INF
3
contains web.xml

src/main/resources
4
it contains images/properties files.

POM.xml

<project xmlns = "http://maven.apache.org/POM/4.0.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.automobile</groupId>
<artifactId>trucks</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<name>trucks Maven Webapp</name>
<url>http://maven.apache.org</url>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
Page 77 of 96

<version>3.8.1</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<finalName>trucks</finalName>
</build>
</project>

If you observe, you will find that Maven also created a sample JSP Source file.

Open C:\ > MVN > trucks > src > main > webapp > folder to see index.jsp with the
following code −

<html>
<body>
<h2>Hello World!</h2>
</body>
</html>

Build Web Application

Let's open the command console, go to the C:\MVN\trucks directory and execute the
following mvn command.

C:\MVN\trucks>mvn clean package

Maven will start building the project.

C:\MVN\trucks>mvn clean package

[INFO] Scanning for projects...
[INFO]
[INFO] -----------------< com.companyname.automobile:trucks >------------------
[INFO] Building trucks Maven Webapp 1.0-SNAPSHOT
[INFO] --------------------------------[ war ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ trucks ---
[INFO] Deleting C:\MVN\trucks\target
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ trucks ---
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. bu
Page 78 of 96

[INFO] Copying 0 resource

[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ trucks ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ trucks -
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. bu
[INFO] skip non existing resourceDirectory C:\MVN\trucks\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ trucks ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ trucks ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-war-plugin:2.2:war (default-war) @ trucks ---
WARNING: An illegal reflective access operation has occurred
WARNING: Illegal reflective access by com.thoughtworks.xstream.core.util.Fields (file:/C:
WARNING: Please consider reporting this to the maintainers of com.thoughtworks.xstream
WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective acces
WARNING: All illegal access operations will be denied in a future release
[INFO] Packaging webapp
[INFO] Assembling webapp [trucks] in [C:\MVN\trucks\target\trucks]
[INFO] Processing war project
[INFO] Copying webapp resources [C:\MVN\trucks\src\main\webapp]
[INFO] Webapp assembled in [50 msecs]
[INFO] Building war: C:\MVN\trucks\target\trucks.war
[INFO] WEB-INF\web.xml already added, skipping
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.494 s
[INFO] Finished at: 2021-12-13T19:02:15+05:30
[INFO] ------------------------------------------------------------------------
C:\MVN\trucks>

Deploy Web Application

Now copy the trucks.war created in C:\ > MVN > trucks > target > folder to your
webserver webapp directory and restart the webserver.

Test Web Application

Page 79 of 96

Run the web-application using URL: http://<server-name>:<port-

number>/trucks/index.jsp.

Verify the output.

Maven - Eclipse IDE

Eclipse provides an excellent plugin m2eclipse which seamlessly integrates Maven and
Eclipse together.

Some of features of m2eclipse are listed below −

You can run Maven goals from Eclipse.

You can view the output of Maven commands inside the Eclipse, using its own
console.

You can update maven dependencies with IDE.

You can Launch Maven builds from within Eclipse.

It does the dependency management for Eclipse build path based on Maven's
pom.xml.

It resolves Maven dependencies from the Eclipse workspace without installing to

local Maven repository (requires dependency project be in same workspace).

It automatic downloads the required dependencies and sources from the remote
Maven repositories.

It provides wizards for creating new Maven projects, pom.xml and to enable Maven
support on existing projects

It provides quick search for dependencies in remote Maven repositories.

Installing m2eclipse plugin

Use one of the following links to install m2eclipse −
Page 80 of 96

Eclipse URL

Eclipse 3.5 (Gallileo) Installing m2eclipse in Eclipse 3.5 (Gallileo)

Eclipse 3.6 (Helios) Installing m2eclipse in Eclipse 3.6 (Helios)

Following example will help you to leverage benefits of integrating Eclipse and maven.

Import a maven project in Eclipse

Open Eclipse.

Select File > Import > option.

Select Maven Projects Option. Click on Next Button.

Select Project location, where a project was created using Maven. We've created a
Java Project consumer Banking in the previous chapters. Go to ‘Creating Java
Project’ chapter, to see how to create a project using Maven.

Click Finish Button.

Page 81 of 96

Now, you can see the maven project in eclipse.

Now, have a look at consumer Banking project properties. You can see that Eclipse has
added Maven dependencies to java build path.
Page 82 of 96

Now, it is time to build this project using maven capability of eclipse.

Right Click on consumerBanking project to open context menu.

Select Run as option.

Then maven package option.

Maven will start building the project. You can see the output in Eclipse Console as follows
−

[INFO] Scanning for projects...

[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. bu
[INFO] skip non existing resourceDirectory C:\MVN\consumerBanking\src\main\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ consumerBanking ---
[INFO] Changes detected - recompiling the module!
[WARNING] File encoding has not been set, using platform encoding Cp1252, i.e. build is
[INFO] Compiling 1 source file to C:\MVN\consumerBanking\target\classes
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ consum
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. bu
[INFO] skip non existing resourceDirectory C:\MVN\consumerBanking\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ consumerBan
[INFO] Changes detected - recompiling the module!
[WARNING] File encoding has not been set, using platform encoding Cp1252, i.e. build is
[INFO] Compiling 1 source file to C:\MVN\consumerBanking\target\test-classes
[INFO]
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ consumerBanking ---
[INFO] Surefire report directory: C:\MVN\consumerBanking\target\surefire-reports

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

Now, right click on App.java. Select Run As option. Then select Java Application.
Page 84 of 96

You will see the result as follows −

Hello World!

Maven - NetBeans
NetBeans 6.7 and newer has in-built support for Maven. In case of previous version,
Maven plugin is available in plugin Manager. We are using NetBeans 6.9 in this example.

Some of features of NetBeans are listed below −

You can run Maven goals from NetBeans.

You can view the output of Maven commands inside the NetBeans using its own
console.

You can update maven dependencies with IDE.

You can Launch Maven builds from within NetBeans.

Page 85 of 96

NetBeans does the dependency management automatically based on Maven's

pom.xml.

NetBeans resolves Maven dependencies from its workspace without installing to

local Maven repository (requires dependency project be in same workspace).

NetBeans automatic downloads required dependencies and sources from the

remote Maven repositories.

NetBeans provides wizards for creating new Maven projects, pom.xml.

NetBeans provides a Maven Repository browser that enables you to view your local
repository and registered external Maven repositories.

Following example will help you to leverage benefits of integrating NetBeans and Maven.

Open a maven project in NetBeans

Open NetBeans.

Select File Menu > Open Project option.

Select Project location, where a project was created using Maven. We've created a
Java Project consumerBanking. Go to ‘Creating Java Project’ chapter, to see how to
create a project using Maven.

Now, you can see the maven project in NetBeans. Have a look at consumerBanking project
Libraries and Test Libraries. You can see that NetBeans has added Maven dependencies to
its build path.
Page 86 of 96

Build a maven project in NetBeans

Now, Its time to build this project using maven capability of NetBeans.

Right Click on consumerBanking project to open context menu.

Select Clean and Build as option.

Page 87 of 96

Maven will start building the project. You can see the output in NetBeans Console as
follows −

NetBeans: Executing 'mvn.bat -Dnetbeans.execution = true clean install'

NetBeans: JAVA_HOME = C:\Program Files\Java\jdk1.6.0_21
Scanning for projects...
------------------------------------------------------------------------
Building consumerBanking
task-segment: [clean, install]
Page 88 of 96

------------------------------------------------------------------------
[clean:clean]
[resources:resources]
[WARNING] Using platform encoding (Cp1252 actually)
to copy filtered resources, i.e. build is platform dependent!
skip non existing resourceDirectory C:\MVN\consumerBanking\src\main\resourc
[compiler:compile]
Compiling 2 source files to C:\MVN\consumerBanking\target\classes
[resources:testResources]
[WARNING] Using platform encoding (Cp1252 actually)
to copy filtered resources, i.e. build is platform dependent!
skip non existing resourceDirectory C:\MVN\consumerBanking\src\test\resourc
[compiler:testCompile]
Compiling 1 source file to C:\MVN\consumerBanking\target\test-classes
[surefire:test]
Surefire report directory: C:\MVN\consumerBanking\target\surefire-reports

-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running com.companyname.bank.AppTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.023 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[jar:jar]
Building jar: C:\MVN\consumerBanking\target\consumerBanking-1.0-SNAPSHOT.ja
[install:install]
Installing C:\MVN\consumerBanking\target\consumerBanking-1.0-SNAPSHOT.jar
to C:\Users\GB3824\.m2\repository\com\companyname\bank\consumerBanking\
1.0-SNAPSHOT\consumerBanking-1.0-SNAPSHOT.jar
------------------------------------------------------------------------
BUILD SUCCESSFUL
------------------------------------------------------------------------
Total time: 9 seconds
Finished at: Thu Jul 19 12:57:28 IST 2012
Final Memory: 16M/85M
------------------------------------------------------------------------

Run Application in NetBeans

Page 89 of 96

Now, right click on App.java. Select Run File as option. You will see the result in the
NetBeans Console.

NetBeans: Executing 'mvn.bat -Dexec.classpathScope = runtime

-Dexec.args = -classpath %classpath com.companyname.bank.App
-Dexec.executable = C:\Program Files\Java\jdk1.6.0_21\bin\java.exe
-Dnetbeans.execution = true process-classes
org.codehaus.mojo:exec-maven-plugin:1.1.1:exec'
NetBeans: JAVA_HOME = C:\Program Files\Java\jdk1.6.0_21
Scanning for projects...
------------------------------------------------------------------------
Building consumerBanking
task-segment: [process-classes,
org.codehaus.mojo:exec-maven-plugin:1.1.1:exec]
------------------------------------------------------------------------
[resources:resources]
[WARNING] Using platform encoding (Cp1252 actually)
to copy filtered resources, i.e. build is platform dependent!
skip non existing resourceDirectory C:\MVN\consumerBanking\src\main\resources
[compiler:compile]
Nothing to compile - all classes are up to date
[exec:exec]
Hello World!
------------------------------------------------------------------------
BUILD SUCCESSFUL
------------------------------------------------------------------------
Total time: 1 second
Finished at: Thu Jul 19 14:18:13 IST 2012
Final Memory: 7M/64M
------------------------------------------------------------------------

Maven - IntelliJ IDEA IDE Integration

IntelliJ IDEA has in-built support for Maven. We are using IntelliJ IDEA Community Edition
11.1 in this example.

Some of the features of IntelliJ IDEA are listed below −

You can run Maven goals from IntelliJ IDEA.

You can view the output of Maven commands inside the IntelliJ IDEA using its own
console.
Page 90 of 96

You can update maven dependencies within IDE.

You can Launch Maven builds from within IntelliJ IDEA.

IntelliJ IDEA does the dependency management automatically based on Maven's

pom.xml.

IntelliJ IDEA resolves Maven dependencies from its workspace without installing to
local Maven repository (requires dependency project be in same workspace).
IntelliJ IDEA automatically downloads the required dependencies and sources from
the remote Maven repositories.

IntelliJ IDEA provides wizards for creating new Maven projects, pom.xml.

Following example will help you to leverage benefits of integrating IntelliJ IDEA and Maven.

Create a new project in IntelliJ IDEA

We will import Maven project using New Project Wizard.

Open IntelliJ IDEA.

Select File Menu > New Project Option.

Select import project from existing model.

Select Maven option

Page 91 of 96

Select Project location, where a project was created using Maven. We have created
a Java Project consumerBanking. Go to ‘Creating Java Project' chapter, to see how
to create a project using Maven.
Page 92 of 96

Select Maven project to import.

Page 93 of 96

Enter name of the project and click finish.

Now, you can see the maven project in IntelliJ IDEA. Have a look at
consumerBanking project external libraries. You can see that IntelliJ IDEA has
added Maven dependencies to its build path under Maven section.
Page 94 of 96

Build a maven project in IntelliJ IDEA

Now, it is time to build this project using capability of IntelliJ IDEA.

Select consumerBanking project.

Select Buid menu > Rebuild Project Option

You can see the output in IntelliJ IDEA Console

4:01:56 PM Compilation completed successfully

Run Application in IntelliJ IDEA

Select consumerBanking project.

Right click on App.java to open context menu.

Page 95 of 96

select Run App.main()

You will see the result in IntelliJ IDEA Console.

"C:\Program Files\Java\jdk1.6.0_21\bin\java"
-Didea.launcher.port=7533
"-Didea.launcher.bin.path=
Page 96 of 96

C:\Program Files\JetBrains\IntelliJ IDEA Community Edition 11.1.2\bin"

-Dfile.encoding=UTF-8
-classpath "C:\Program Files\Java\jdk1.6.0_21\jre\lib\charsets.jar;

C:\Program Files\Java\jdk1.6.0_21\jre\lib\deploy.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\javaws.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\jce.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\jsse.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\management-agent.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\plugin.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\resources.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\rt.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\ext\dnsns.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\ext\localedata.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\ext\sunjce_provider.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\ext\sunmscapi.jar;
C:\Program Files\Java\jdk1.6.0_21\jre\lib\ext\sunpkcs11.jar

C:\MVN\consumerBanking\target\classes;
C:\Program Files\JetBrains\
IntelliJ IDEA Community Edition 11.1.2\lib\idea_rt.jar"
com.intellij.rt.execution.application.AppMain com.companyname.bank.App
Hello World!

Process finished with exit code 0

Beginners Resource Books
100% (3)
Beginners Resource Books
155 pages
Getting started with Spring Framework: A Hands-on Guide to Begin Developing Applications Using Spring Framework
From Everand
Getting started with Spring Framework: A Hands-on Guide to Begin Developing Applications Using Spring Framework
Ashish Sarin
4.5/5 (2)
Maven Quick Guide
No ratings yet
Maven Quick Guide
63 pages
Maven
No ratings yet
Maven
19 pages
Maven Notes
No ratings yet
Maven Notes
45 pages
Maven
No ratings yet
Maven
15 pages
unit - ii (1)
No ratings yet
unit - ii (1)
16 pages
BRM Lab
No ratings yet
BRM Lab
108 pages
Maven Essentials - Sample Chapter
No ratings yet
Maven Essentials - Sample Chapter
19 pages
MAVEN
No ratings yet
MAVEN
30 pages
Maven
No ratings yet
Maven
41 pages
Maven Tutorial: Understanding The Problem Without Maven
No ratings yet
Maven Tutorial: Understanding The Problem Without Maven
29 pages
Maven Tutorial
No ratings yet
Maven Tutorial
7 pages
Maven Tutorial
100% (1)
Maven Tutorial
91 pages
Maven Tutorial
100% (1)
Maven Tutorial
91 pages
Unit 2 - DO
No ratings yet
Unit 2 - DO
29 pages
Maven-Documentation
No ratings yet
Maven-Documentation
20 pages
Unit 6 Devops
No ratings yet
Unit 6 Devops
50 pages
Maven Tutorial PDF
100% (3)
Maven Tutorial PDF
122 pages
Maven Tutorial
50% (2)
Maven Tutorial
28 pages
Maven by Polarapu Prasad
No ratings yet
Maven by Polarapu Prasad
7 pages
Installation Instructions
No ratings yet
Installation Instructions
8 pages
Unit+5 +Build+Tool+-+Maven
No ratings yet
Unit+5 +Build+Tool+-+Maven
16 pages
Maven
No ratings yet
Maven
11 pages
Maven Tour
No ratings yet
Maven Tour
44 pages
Devops_Lab_Manual_BCS_657D (1)
No ratings yet
Devops_Lab_Manual_BCS_657D (1)
29 pages
Apache Maven Getting Started Guide
No ratings yet
Apache Maven Getting Started Guide
24 pages
Maven
No ratings yet
Maven
3 pages
Maven In 5 Minutes
No ratings yet
Maven In 5 Minutes
4 pages
Maven - Maven in 5 Minutes
No ratings yet
Maven - Maven in 5 Minutes
5 pages
Maven Introduction
No ratings yet
Maven Introduction
2 pages
Maven 1699961692
No ratings yet
Maven 1699961692
7 pages
UNIT 6 Updated
No ratings yet
UNIT 6 Updated
24 pages
Maven: Mr. Ashok
100% (1)
Maven: Mr. Ashok
20 pages
Maven in 5 Minutes
No ratings yet
Maven in 5 Minutes
4 pages
Maven Tutorial
No ratings yet
Maven Tutorial
14 pages
Software_Development_Context
No ratings yet
Software_Development_Context
41 pages
Maven
No ratings yet
Maven
19 pages
Maven: Shalini Mittal Corporate Trainer, Developer & Consultant
No ratings yet
Maven: Shalini Mittal Corporate Trainer, Developer & Consultant
25 pages
Maven Tutorial - Jenkov
No ratings yet
Maven Tutorial - Jenkov
20 pages
Apache Maven Guide
No ratings yet
Apache Maven Guide
109 pages
Unit II Compile and Build Using Maven & Gradle
No ratings yet
Unit II Compile and Build Using Maven & Gradle
37 pages
Maven DP
No ratings yet
Maven DP
17 pages
DPA Exp1.3
No ratings yet
DPA Exp1.3
4 pages
Maven: Local Repository Then Central Repository Then Remote Repository
No ratings yet
Maven: Local Repository Then Central Repository Then Remote Repository
10 pages
Nataraj Sir (Maven)
No ratings yet
Nataraj Sir (Maven)
42 pages
Apache Maven
No ratings yet
Apache Maven
7 pages
Maven Introduction Dependencies ORM Introduction Entity Class Java Persistence 620055
No ratings yet
Maven Introduction Dependencies ORM Introduction Entity Class Java Persistence 620055
14 pages
Lab01 Maven
No ratings yet
Lab01 Maven
17 pages
Maven Tutorial 01
No ratings yet
Maven Tutorial 01
33 pages
Devops Lab Manual
No ratings yet
Devops Lab Manual
34 pages
22 maven
No ratings yet
22 maven
7 pages
Apache Maven in 5 Minutes
No ratings yet
Apache Maven in 5 Minutes
5 pages
rc055 010d Apachemaven 1 PDF
No ratings yet
rc055 010d Apachemaven 1 PDF
6 pages
ApachemMaven 1
No ratings yet
ApachemMaven 1
6 pages
MAVE____N
No ratings yet
MAVE____N
4 pages
Welcome To Apache Maven: Download Install Run Configure Use Maven Plugins
No ratings yet
Welcome To Apache Maven: Download Install Run Configure Use Maven Plugins
1 page
The Apache Maven Handbook: Practical Solutions for Build and Deployment
From Everand
The Apache Maven Handbook: Practical Solutions for Build and Deployment
Robert Johnson
No ratings yet
JAVASCRIPT FRONT END PROGRAMMING: Crafting Dynamic and Interactive User Interfaces with JavaScript (2024 Guide for Beginners)
From Everand
JAVASCRIPT FRONT END PROGRAMMING: Crafting Dynamic and Interactive User Interfaces with JavaScript (2024 Guide for Beginners)
DAISY JOHNSTON
No ratings yet
Visual SourceSafe 2005 Software Configuration Management in Practice
From Everand
Visual SourceSafe 2005 Software Configuration Management in Practice
Aleksandar Seovic
No ratings yet
Configuration of Apache Server To Support ASP
From Everand
Configuration of Apache Server To Support ASP
Dr. Hedaya Mahmood Alasooly
No ratings yet
English Lesson Plan Year 3 Pak 2121
No ratings yet
English Lesson Plan Year 3 Pak 2121
1 page
Speaking Thanh Loan
No ratings yet
Speaking Thanh Loan
208 pages
Wedding Traditions
No ratings yet
Wedding Traditions
1 page
Teacher As Researcher
No ratings yet
Teacher As Researcher
16 pages
(Maa 3.1-3.3) 3D Geometry - Triangles
No ratings yet
(Maa 3.1-3.3) 3D Geometry - Triangles
9 pages
Teaching English Through Translation
No ratings yet
Teaching English Through Translation
5 pages
Iot Based Led Scrolling Display: International Journal of Scientific Research & Management Studies July 2020
No ratings yet
Iot Based Led Scrolling Display: International Journal of Scientific Research & Management Studies July 2020
6 pages
The Deficiencies of The Skopos Theory
100% (1)
The Deficiencies of The Skopos Theory
3 pages
Class 12 English
No ratings yet
Class 12 English
90 pages
Ulangan Harian 2023
No ratings yet
Ulangan Harian 2023
2 pages
Primary 5 Scheme - 2nd Term
No ratings yet
Primary 5 Scheme - 2nd Term
31 pages
# 'ZZZZZZZH28 06 2023GMT0139sunsavingtime
No ratings yet
# 'ZZZZZZZH28 06 2023GMT0139sunsavingtime
59 pages
A Reading of T.S.Eliot's Ash-Wednesday1
100% (1)
A Reading of T.S.Eliot's Ash-Wednesday1
22 pages
Culture Health and Society MIDs
100% (1)
Culture Health and Society MIDs
7 pages
JDI-Manual CN 1.3 Programmer
No ratings yet
JDI-Manual CN 1.3 Programmer
46 pages
Slav Date Line 1
No ratings yet
Slav Date Line 1
21 pages
Unit Test in Music of East Asia
100% (1)
Unit Test in Music of East Asia
2 pages
Predator and Prey
No ratings yet
Predator and Prey
4 pages
Latin As The Language of Science and Learning
No ratings yet
Latin As The Language of Science and Learning
660 pages
[Ebooks PDF] download Wireshark for Network Forensics: An Essential Guide for IT and Cloud Professionals 1st Edition Nagendra Kumar Nainar full chapters
100% (6)
[Ebooks PDF] download Wireshark for Network Forensics: An Essential Guide for IT and Cloud Professionals 1st Edition Nagendra Kumar Nainar full chapters
66 pages
SM - RaagDarbari
No ratings yet
SM - RaagDarbari
20 pages
Expansion Activities Chapter 1: Overview of Verb Tenses: Understanding and Using English Grammar, 3rd Edition
No ratings yet
Expansion Activities Chapter 1: Overview of Verb Tenses: Understanding and Using English Grammar, 3rd Edition
1 page
LEC 4013 EUROPEAN DRAMA
No ratings yet
LEC 4013 EUROPEAN DRAMA
11 pages
Baudhyanasrautas 01 Bauduoft
No ratings yet
Baudhyanasrautas 01 Bauduoft
774 pages
8986 101 Contradictions in The Bible
No ratings yet
8986 101 Contradictions in The Bible
36 pages
Handout 5
No ratings yet
Handout 5
9 pages
Excel Formula Bar
No ratings yet
Excel Formula Bar
5 pages
CJR 1 2020 Law Paper I 025ebb4c9516a
No ratings yet
CJR 1 2020 Law Paper I 025ebb4c9516a
7 pages
Great Writing 5e Foundations Unit 2 Exam View Test
0% (1)
Great Writing 5e Foundations Unit 2 Exam View Test
7 pages