mavenizer:analyze

Full name:

lu.softec.maven:maven-mavenizer-plugin:1.0:analyze

Description:

Analyse dependencies between binaries of the project.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
binariesBaseDir File - Base directory where the binaries of the project to be mavenized are stored. If archiveFile and/or archiveURL parameter is provided, these binaries are extracted from the specified archive file during the generate-source phase. If no archive file is provided or this directory is not located in the project build directory, the binaries should be provided locally.

Optional Parameters

Name Type Since Description
archiveBaseDir File - Base directory where the archive of the project to be mavenized should be stored. This directory is only used to compute a name for the archive file when no archiveFile parameter has been provided. It should be located in the build directory, or the archive will be considered to be provided locally.
archiveFile File - File of the archive of the project to be mavenized. If URL is also provided, this file could be updated. If no archiveFile argument has been provided, the archiveFile is initialized based on the archive base directory and the archive url. If the archive file is not located in the build directory, it should be provided locally and will not be downloaded.
archiveURL URL - URL of the archive of the project to be mavenized. If ommitted, the file is directly expanded from the archiveFile parameter. If the archive file or the archive base directory is not located in the build directory, this URL will be only used for POM documentation.
artifacts FileMavenInfo[] - Identification information for any provided library file.
depsExcludes String[] - Excludes patterns selector for addionnal library files that should be considered for dependency analysis.
depsIncludes String[] - Includes patterns selector for addionnal library files that should be considered for dependency analysis.
jvmProvidedClasses String[] - Selectors of provided classes, could be used to avoid reporting missing dependency.
libsExcludes String[] - Excludes patterns selector for library file to mavenized.
libsIncludes String[] - Includes patterns selector for library file to mavenized.
mavenizerConfigFile File - Mavenizer configuration file, results of the analysis and configuration for deployment. If this file is not located in the project build directory, it should be provided locally and it will never be overwritten.
providedClasses String[] - Selectors of provided classes, could be used to avoid reporting missing dependency.

Parameter Details

archiveBaseDir:

Base directory where the archive of the project to be mavenized should be stored. This directory is only used to compute a name for the archive file when no archiveFile parameter has been provided. It should be located in the build directory, or the archive will be considered to be provided locally.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/archive

archiveFile:

File of the archive of the project to be mavenized. If URL is also provided, this file could be updated. If no archiveFile argument has been provided, the archiveFile is initialized based on the archive base directory and the archive url. If the archive file is not located in the build directory, it should be provided locally and will not be downloaded.
  • Type: java.io.File
  • Required: No

archiveURL:

URL of the archive of the project to be mavenized. If ommitted, the file is directly expanded from the archiveFile parameter. If the archive file or the archive base directory is not located in the build directory, this URL will be only used for POM documentation.
  • Type: java.net.URL
  • Required: No

artifacts:

Identification information for any provided library file.
  • Type: lu.softec.maven.mavenizer.mavenfile.FileMavenInfo[]
  • Required: No

binariesBaseDir:

Base directory where the binaries of the project to be mavenized are stored. If archiveFile and/or archiveURL parameter is provided, these binaries are extracted from the specified archive file during the generate-source phase. If no archive file is provided or this directory is not located in the project build directory, the binaries should be provided locally.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/bin

depsExcludes:

Excludes patterns selector for addionnal library files that should be considered for dependency analysis.
  • Type: java.lang.String[]
  • Required: No

depsIncludes:

Includes patterns selector for addionnal library files that should be considered for dependency analysis.
  • Type: java.lang.String[]
  • Required: No

jvmProvidedClasses:

Selectors of provided classes, could be used to avoid reporting missing dependency.
  • Type: java.lang.String[]
  • Required: No

libsExcludes:

Excludes patterns selector for library file to mavenized.
  • Type: java.lang.String[]
  • Required: No

libsIncludes:

Includes patterns selector for library file to mavenized.
  • Type: java.lang.String[]
  • Required: No

mavenizerConfigFile:

Mavenizer configuration file, results of the analysis and configuration for deployment. If this file is not located in the project build directory, it should be provided locally and it will never be overwritten.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/mavenizer.xml

providedClasses:

Selectors of provided classes, could be used to avoid reporting missing dependency.
  • Type: java.lang.String[]
  • Required: No