Browse Library
Sign In Start Free Trial
Close icon Search icon
Account
Browse Library Advanced Search Sign In Start Free Trial

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Apache Maven Cookbook
  • Toc
  • feedback
Apache Maven Cookbook

Apache Maven Cookbook

By : Raghuram Bharathan
4.2 (5)
close
Apache Maven Cookbook

Apache Maven Cookbook

4.2 (5)
By: Raghuram Bharathan

Overview of this book

If you are a Java developer or a manager who has experience with Apache Maven and want to extend your knowledge, then this is the ideal book for you. Apache Maven Cookbook is for those who want to learn how Apache Maven can be used for build automation. It is also meant for those familiar with Apache Maven, but want to understand the finer nuances of Maven and solve specific problems.
Table of Contents (13 chapters)
close
close
Preface
Preface
What this book covers
What you need for this book
Who this book is for
Sections
Conventions
Reader feedback
Customer support
Free Chapter
1
1. Getting Started
chevron up
1. Getting Started
Introduction
Installing Maven on Microsoft Windows
Installing Maven on Mac OS X
Installing Maven on Linux
Changing the JDK used by Maven
Creating a simple project with Maven
Building a simple project with Maven
Changing the location of the Maven repository
Running Maven behind an HTTP proxy server
Understanding the standard directory layout
2
2. IDE Integration with Maven
2. IDE Integration with Maven
Introduction
Creating a new Maven project in Eclipse
Importing an existing Maven project in Eclipse
Creating a new Maven project in NetBeans
Importing an existing Maven project in NetBeans
Creating a new Maven project in IntelliJ IDEA
Importing an existing Maven project in IntelliJ IDEA
3
3. Maven Lifecycle
3. Maven Lifecycle
Introduction
Understanding the Maven lifecycle, phases, and goals
Understanding the pom file
Understanding Maven settings
Understanding command-line options in Maven
Understanding Maven profiles
Adding a new Maven profile
Activating/deactivating a Maven profile
Using properties in Maven
Specifying source encoding for platform-independent builds
4
4. Essential Maven Plugins
4. Essential Maven Plugins
Introduction
Using the Maven Clean plugin
Using the Maven Compiler plugin
Changing the compiler used by the Maven Compiler plugin
Specifying the Java version for the Compiler plugin
Using the Maven Surefire plugin to run unit tests
Using the Maven Failsafe plugin to run integration tests
Using the Maven Resources plugin
Filtering using resources
Using Eclipse to run Maven goals
Using NetBeans to run Maven goals
Using IntelliJ IDEA to run Maven goals
5
5. Dependency Management
5. Dependency Management
Introduction
Choosing the scope of dependency
Getting a report of dependencies
Getting into dependency and avoiding dependency hell
Downloading dependencies into a folder
Understanding SNAPSHOT dependencies
Handling dependency download errors
Detecting unused/undeclared dependencies
Manually installing dependencies that are not available in a repository
Dependency management using Eclipse
Dependency management using NetBeans
Dependency management using IntelliJ IDEA
6
6. Code Quality Plugins
6. Code Quality Plugins
Introduction
Analyzing code coverage with the Maven JaCoCo plugin
Analyzing code coverage with the Maven Cobertura plugin
Analyzing code with the Maven PMD plugin
Analyzing code with the Maven Checkstyle plugin
Analyzing code with the Maven FindBugs plugin
Generating source references with the Maven JXR plugin
Analyzing code with the Maven SonarQube plugin
7
7. Reporting and Documentation
7. Reporting and Documentation
Introduction
Documenting with the Maven Site plugin
Generating Javadocs for a site
Generating source cross-reference for a site
Generating unit test reports for a site
Generating code coverage reports for a site
Generating code quality reports for a site
Generating selective reports
Deploying a site
8
8. Handling Typical Build Requirements
8. Handling Typical Build Requirements
Introduction
Including and excluding additional resources
Including and excluding source files and folders
Configuring Maven to search for plugins
Working in offline mode
Controlling the verbosity of the Maven output
Using the Maven Help plugin
Using the Maven SCM plugin
Generating changelogs for a site
9
9. Multi-module Projects
9. Multi-module Projects
Introduction
Understanding project inheritance
Understanding project aggregation
Combining inheritance and aggregation
Performing multi-module dependency management
Performing multi-module plugin management
Selectively building modules
Reporting for multi-module projects
10
10. Java Development with Maven
10. Java Development with Maven
Introduction
Building a JAR project
Generating an executable JAR
Generating a JAR of the source code
Generating a JAR of the test classes
Building a WAR project
Building an EAR project
Building a pom project
Running a web project with Jetty
Running a web project with Tomcat
11
11. Advanced Maven Usage
11. Advanced Maven Usage
Introduction
Creating an assembly
Running a custom executable
Running an ANT task
Determining updates to Maven plugin AntRun
Determining updates to Maven dependencies
Controlling the constraints
Generating unique builds
Releasing a Maven project
12
Index
Index

Installing Maven on Microsoft Windows

At the time of writing this book, Microsoft Windows 8.1 is the latest version of Microsoft Windows. While the screenshots and output will be for Microsoft Windows 8.1, the steps are similar for earlier (and possibly later) versions as well.

Getting ready

As Maven requires a Java platform, first ensure that you have installed the Java environment on your system, Java Development Kit (JDK) specifically; Java Runtime Environment (JRE) is not sufficient.

You can verify whether Java is installed on your system by opening Add or Remove Programs. If you see something similar to the following screenshot, JDK is installed on your system:

Getting ready

You can also verify the program folder structure from Microsoft Windows Explorer:

Getting ready

How to do it...

Let's start installing Java and Maven by performing the following steps:

  1. Set the variable JAVA_HOME to point to the Java installation that you want Maven to use; for example, you can do this by setting JAVA_HOME variable in the following way:
    C:\projects\apache_maven_cookbook>set JAVA_HOME=C:\Program Files\Java\jdk1.8.0_20

    Note

    Note that this setting will not be persisted once the command prompt is closed. To persist this, set Environment Variables... using the Control Panel option, as described later for the M2_HOME variable.

  2. If JDK is not installed on your system, now is the time to download and install it from the Oracle Java SE download page at http://www.oracle.com/technetwork/java/javase/downloads/index.html.

    Once it is installed, ensure JAVA_HOME is set as described earlier.

    Now that we have set up Java, let us download and set up Maven.

  3. Go to http://maven.apache.org/ and click on the Download link.
  4. The links to the latest stable versions of Maven are displayed.
  5. The binaries are available in both, .zip and .tar.gz formats. Choose one of them.
  6. Extract the downloaded binary to a folder you want Maven to reside in. In this case I have chosen C:\software.

    Tip

    It is best to avoid folders with spaces as some features of Maven or its plugins might not work.

  7. Ensure the contents are similar to the following screenshot:
    How to do it...

The preceding screenshot displays a list of directories contained in Maven.

Now let's briefly discuss what these directories contain:

  • The bin folder contains the batch files and shell scripts to run Maven on various platforms.
  • The boot folder contains the jars required for Maven to start.
  • The conf folder contains the default settings.xml file used by Maven.
  • The lib folder contains the libraries used by Maven. It also contains an ext folder in which third-party extensions, which can extend or override the default Maven implementation, can be placed.

Now let us make sure we can run Maven from the command prompt by carrying out the following steps:

  1. Open Control Panel:
    How to do it...
  2. Choose Advanced system settings:
    How to do it...
  3. Click on Environment Variables.... Add the M2_HOME variable and set it to the folder where Maven was extracted.
    How to do it...
  4. Edit the PATH variable to include Maven's bin folder:
    How to do it...

How it works...

A Maven installation is essentially a set of JAR files, configuration files, and a Microsoft Windows batch file, mvn.bat.

The mvn command essentially runs this batch file. It first checks for JAVA_HOME. This file is present in the bin folder of the Maven installation and, hence, it needs to be in PATH.

If the batch file does not find JAVA_HOME, it looks for Java in its PATH. This can lead to unexpected results, as typically the Java in PATH is usually the JRE and not the JDK.

The batch file then looks for M2_HOME, which is the location of the Maven installation. It does this so that it can load the libraries that are present.

Additionally, it also reads values specified in MAVEN_OPTS. This variable allows you to run Maven with an additional heap size and other Java parameters.

Using the values for JAVA_HOME, M2_HOME, and Maven_OPTS, the batch file runs its main class org.codehaus.plexus.classworlds.launcher.Launcher.

There's more...

Verify your Maven installation using the following steps:

  1. Open a command prompt in Microsoft Windows and run the following command:
    C:\software\apache-maven-cookbook>mvn -version
  2. The following output should be displayed:
    Apache Maven 3.2.5 (12a6b3acb947671f09b81f49094c53f426d8cea1; 2014-12-14T22:59:23+05:30)
Maven home: C:\software\apache-maven-3.2.5
Java version: 1.7.0_67, vendor: Oracle Corporation
Java home: C:\Program Files\Java\jdk1.7.0_67\jre
Default locale: en_IN, platform encoding: Cp1252
OS name: "windows 8.1", version: "6.3", arch: "amd64", family: "windows"

See also

  • The Creating a simple project with Maven recipe in this chapter
End of Section 3
Next Section
bookmark search playlist download
font-size

Change the font size

margin-width

Change margin width

day-mode

Change background colour

Close icon Search
Country selected
Close icon Your notes and bookmarks

Delete Bookmark

Modal Close icon
Are you sure you want to delete it?
Cancel
Yes, Delete