AnalyzeDepMgt (Apache Maven Dependency Plugin 2.9 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugin.dependency.analyze.AnalyzeDepMgt

All Implemented Interfaces:

ContextEnabled, Mojo
```
@Mojo(name="analyze-dep-mgt",
      requiresDependencyResolution=TEST,
      threadSafe=true)
public class AnalyzeDepMgt
extends AbstractMojo
```
This mojo looks at the dependencies after final resolution and looks for mismatches in your dependencyManagement section. In versions of maven prior to 2.0.6, it was possible to inherit versions that didn't match your dependencyManagement. See MNG-1577 for more info. This mojo is also useful for just detecting projects that override the dependencyManagement directly. Set ignoreDirect to false to detect these otherwise normal conditions.

Since:

2.0-alpha-3

Version:

$Id: AnalyzeDepMgt.html 922735 2014-09-18 19:32:48Z khmarbaise $

Author:

Brian Fox

Field Summary
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Constructor Summary

Constructors
Constructor and Description

AnalyzeDepMgt()

Constructors
Constructor and Description
`AnalyzeDepMgt()`

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,Exclusion>`	`addExclusions(List<Exclusion> exclusionList)` Returns a map of the exclusions using the Dependency ManagementKey as the keyset.
`void`	`execute()`
`String`	`getArtifactManagementKey(Artifact artifact)` This function returns a string comparable with Dependency.GetManagementKey.
`List<Artifact>`	`getExclusionErrors(Map<String,Exclusion> exclusions, Set<Artifact> allDependencyArtifacts)` Returns a List of the artifacts that should have been excluded, but were found in the dependency tree.
`String`	`getExclusionKey(Artifact artifact)`
`String`	`getExclusionKey(Exclusion ex)`
`Map<Artifact,Dependency>`	`getMismatch(Map<String,Dependency> depMgtMap, Set<Artifact> allDependencyArtifacts)` Calculate the mismatches between the DependencyManagement and resolved artifacts
`MavenProject`	`getProject()`
`boolean`	`isFailBuild()`
`boolean`	`isIgnoreDirect()`
`boolean`	`isSkip()`
`void`	`logMismatch(Artifact dependencyArtifact, Dependency dependencyFromDepMgt)` This function displays the log to the screen showing the versions and information about the artifacts that don't match.
`void`	`setFailBuild(boolean theFailBuild)`
`void`	`setIgnoreDirect(boolean theIgnoreDirect)`
`void`	`setProject(MavenProject theProject)`
`void`	`setSkip(boolean skip)`

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AnalyzeDepMgt
```
public AnalyzeDepMgt()
```
- Method Detail
  - execute
```
public void execute()
             throws MojoExecutionException,
                    MojoFailureException
```
    Throws:
    
    MojoExecutionException
    
    MojoFailureException
  - addExclusions
```
public Map<String,Exclusion> addExclusions(List<Exclusion> exclusionList)
```
    Returns a map of the exclusions using the Dependency ManagementKey as the keyset.
    
    Parameters:
    exclusionList - to be added to the map.
    
    Returns:
    a map of the exclusions using the Dependency ManagementKey as the keyset.
  - getExclusionErrors
```
public List<Artifact> getExclusionErrors(Map<String,Exclusion> exclusions,
                                Set<Artifact> allDependencyArtifacts)
```
    Returns a List of the artifacts that should have been excluded, but were found in the dependency tree.
    
    Parameters:
    exclusions - a map of the DependencyManagement exclusions, with the ManagementKey as the key and Dependency as the value.
    allDependencyArtifacts - resolved artifacts to be compared.
    
    Returns:
    list of artifacts that should have been excluded.
  - getExclusionKey
```
public String getExclusionKey(Artifact artifact)
```
  - getExclusionKey
```
public String getExclusionKey(Exclusion ex)
```
  - getMismatch
```
public Map<Artifact,Dependency> getMismatch(Map<String,Dependency> depMgtMap,
                                   Set<Artifact> allDependencyArtifacts)
```
    Calculate the mismatches between the DependencyManagement and resolved artifacts
    
    Parameters:
    depMgtMap - contains the Dependency.GetManagementKey as the keyset for quick lookup.
    allDependencyArtifacts - contains the set of all artifacts to compare.
    
    Returns:
    a map containing the resolved artifact as the key and the listed dependency as the value.
  - logMismatch
```
public void logMismatch(Artifact dependencyArtifact,
               Dependency dependencyFromDepMgt)
                 throws MojoExecutionException
```
    This function displays the log to the screen showing the versions and information about the artifacts that don't match.
    
    Parameters:
    dependencyArtifact - the artifact that was resolved.
    dependencyFromDepMgt - the dependency listed in the DependencyManagement section.
    
    Throws:
    
    MojoExecutionException
  - getArtifactManagementKey
```
public String getArtifactManagementKey(Artifact artifact)
```
    This function returns a string comparable with Dependency.GetManagementKey.
    
    Parameters:
    artifact - to gen the key for
    
    Returns:
    a string in the form: groupId:ArtifactId:Type[:Classifier]
  - isFailBuild
```
public boolean isFailBuild()
```
    Returns:
    the failBuild
  - setFailBuild
```
public void setFailBuild(boolean theFailBuild)
```
    Parameters:
    theFailBuild - the failBuild to set
  - getProject
```
public MavenProject getProject()
```
    Returns:
    the project
  - setProject
```
public void setProject(MavenProject theProject)
```
    Parameters:
    theProject - the project to set
  - isIgnoreDirect
```
public boolean isIgnoreDirect()
```
    Returns:
    the ignoreDirect
  - setIgnoreDirect
```
public void setIgnoreDirect(boolean theIgnoreDirect)
```
    Parameters:
    theIgnoreDirect - the ignoreDirect to set
  - isSkip
```
public boolean isSkip()
```
  - setSkip
```
public void setSkip(boolean skip)
```

Class AnalyzeDepMgt

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Constructor Detail

AnalyzeDepMgt

Method Detail

execute

addExclusions

getExclusionErrors

getExclusionKey

getExclusionKey

getMismatch

logMismatch

getArtifactManagementKey

isFailBuild

setFailBuild

getProject

setProject

isIgnoreDirect

setIgnoreDirect

isSkip

setSkip