Book Image

Apache Maven Cookbook

Book Image

Apache Maven Cookbook

Overview of this book

Related Content you might be interested in

Current Title:

Small book image
Apache Maven Cookbook
Apr, 2015 | 272 pages
No titles found
Table of Contents (18 chapters)
Apache Maven Cookbook
Apache Maven Cookbook
Credits
Credits
About the Author
About the Author
About the Reviewers
About the Reviewers
www.PacktPub.com
www.PacktPub.com
Preface
Preface
Free Chapter
1
Getting Started
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
IDE Integration with Maven
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
Maven Lifecycle
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
Essential Maven Plugins
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
Dependency Management
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
Code Quality Plugins
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
Reporting and Documentation
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
Handling Typical Build Requirements
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
Multi-module Projects
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
Java Development with Maven
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
Advanced Maven Usage
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
Index
Index

Generating source references with the Maven JXR plugin

You may have observed the following warnings when running the PMD or Checkstyle plugin:

[INFO] --- maven-pmd-plugin:3.2:pmd (default-cli) @ project-with-violations ---
[WARNING] Unable to locate Source XRef to link to – DISABLED
[INFO] --- maven-checkstyle-plugin:2.13:checkstyle (default-cli) @ project-with-violations ---
[INFO]
[INFO] There are 36 checkstyle errors.
[WARNING] Unable to locate Source XRef to link to – DISABLED

The plugins attempt to link the violation to the specific lines in the cross-reference of the source. As they are unable to find this cross-reference, they display the warning.

To generate this cross-reference, we need to use the Maven JXR plugin.

How to do it...

Use the following steps to generate source references with the Maven JXR plugin:

  1. Open the project for which you want to run the cross-reference.

  2. Run the following Maven command:

    mvn jxr:jxr

  3. Observe the output:

    [INFO]
[INFO] --- maven-jxr-plugin:2.5:jxr (default...
Previous Section
End of Section 8
Next Section