Apache Maven Cookbook

Book Image

Apache Maven Cookbook

Book Image

Apache Maven Cookbook

Overview of this book

Apache Maven Cookbook

Apache Maven Cookbook

Credits

About the Author

About the Author

About the Reviewers

About the Reviewers

www.PacktPub.com

www.PacktPub.com

Preface

Free Chapter

Getting Started

Getting Started

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

IDE Integration with Maven

IDE Integration with Maven

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

Maven Lifecycle

Maven Lifecycle

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

Essential Maven Plugins

Essential Maven Plugins

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

Dependency Management

Dependency Management

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

Code Quality Plugins

Code Quality Plugins

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

Reporting and Documentation

Reporting and Documentation

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

Handling Typical Build Requirements

Handling Typical Build Requirements

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

Multi-module Projects

Multi-module Projects

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

Java Development with Maven

Java Development with Maven

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

Advanced Maven Usage

Advanced Maven Usage

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

Index

Customer Reviews

5 star

0

4 star

0

3 star

0

2 star

0

1 star

0

Using the Maven Help plugin

Maven provides a –h command-line flag to display various command-line parameters that it supports. However, there is a Help plugin that helps you get other information.

How to do it...

Open the simple Maven project.
Run the following command:
```
  mvn help:effective-pom 
```
Observe the output:
Run the following command on a project with a profile (for instance, project-with-profile):
```
mvn help:all-profiles
```

Observe the output:

[INFO] --- maven-help-plugin:2.2:all-profiles (default-cli) @ project-with-profile ---
[INFO] Listing Profiles for Project: com.packt.cookbook:project-with-profile:jar
:1.0-SNAPSHOT
  Profile Id: dev (Active: false , Source: pom)

Run the following command:
```
mvn –help:active-profiles
```

Observe the output:

Active Profiles for Project 'com.packt.cookbook:project-with-profile:jar:1.0-SNAPSHOT':

The following profiles are active:

Now run the following command:
```
mvn –Pdev help:active-profiles
```

Observe the output:

Active Profiles for Project 'com.packt.cookbook:project...