Plugin Documentation

Goals available for this plugin:

Goal Description
contentcheck:check Checks the archive content according to an authoritative source. This authoritative source defines set of allowed files in the archive.
contentcheck:generate Scans content listing of archive specified by sourceFile and writes it to file specified into contentListing. Only entities matching criteria defined by checkFilesPattern and ignoreVendorArchives are generated.
contentcheck:init Convenient way to start using contentcheck plugin, with all its capabilities enabled. Use it to make all following at once:
  • generate the approved-content.txt file to match current war content
  • count war overlaps
  • TODO: show resolution hints
  • generate POM fragment with complete configuration (under target/contentcheck-maven-plugin/)
  • operate on each module of multi-module project
  • TODO: optionally, adjust POM configuration: `-DeditPom=true`
contentcheck:show-licenses Shows license information for selected source entries. By default, the information is parsed from dependency's POM, but the project may define additional mapping between files in output archive and licenses.
contentcheck:warcc Looks for conflicts within the libraries in given sourceFile.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 2.0
JDK 1.5
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>net.kozelka.maven</groupId>
          <artifactId>contentcheck-maven-plugin</artifactId>
          <version>1.0-SNAPSHOT</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>net.kozelka.maven</groupId>
        <artifactId>contentcheck-maven-plugin</artifactId>
        <version>1.0-SNAPSHOT</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"