Class AbstractDependencyFilterMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.dependency.AbstractDependencyMojo
org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
AbstractFromDependenciesMojo
,AbstractResolveMojo
,BuildClasspathMojo
Class that encapsulates the plugin parameters, and contains methods that handle dependency filtering
- Author:
- Brian Fox
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
Specify classifier to look for.protected String
Comma separated list of Artifact names to exclude.protected String
Comma Separated list of Classifiers to exclude.protected String
Comma separated list of GroupId Names to exclude.protected String
Scope threshold to exclude, if no value is defined for include.protected boolean
If we should exclude transitive dependenciesprotected String
Comma Separated list of Types to exclude.protected String
Comma separated list of Artifact names to include.protected String
Comma Separated list of Classifiers to include.protected String
Comma separated list of GroupIds to include.protected String
Scope threshold to include.protected String
Comma Separated list of Types to include.protected File
Directory to store flag filesprotected boolean
Overwrite artifacts that don't exist or are older than the source.protected boolean
Overwrite release artifactsprotected boolean
Overwrite snapshot artifactsprotected boolean
Prepend the groupId during copy.protected String
Specify type to look for when constructing artifact based on classifier.Fields inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo
reactorProjects, session
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected DependencyStatusSets
filterMarkedDependencies
(Set<org.apache.maven.artifact.Artifact> artifacts) Filter the marked dependenciesprotected final org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver
protected DependencyStatusSets
getDependencySets
(boolean stopOnFailure) protected DependencyStatusSets
getDependencySets
(boolean stopOnFailure, boolean includeParents) Method creates filters and filters the projects dependencies.protected abstract org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter
Return anArtifactsFilter
indicating which artifacts must be filtered out.protected final org.apache.maven.shared.transfer.repository.RepositoryManager
protected Set
<org.apache.maven.artifact.Artifact> getResolvedDependencies
(boolean stopOnFailure) Retrieves dependencies, either direct only or all including transitive.protected final ResolverUtil
boolean
void
setMarkersDirectory
(File theMarkersDirectory) void
setPrependGroupId
(boolean prependGroupId) Methods inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo
doExecute, execute, getProject, isSilent, isSkip, newResolveArtifactProjectBuildingRequest, newResolvePluginProjectBuildingRequest, setSilent, setSkip
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
overWriteReleases
@Parameter(property="overWriteReleases", defaultValue="false") protected boolean overWriteReleasesOverwrite release artifacts- Since:
- 1.0
-
overWriteSnapshots
@Parameter(property="overWriteSnapshots", defaultValue="false") protected boolean overWriteSnapshotsOverwrite snapshot artifacts- Since:
- 1.0
-
overWriteIfNewer
@Parameter(property="overWriteIfNewer", defaultValue="true") protected boolean overWriteIfNewerOverwrite artifacts that don't exist or are older than the source.- Since:
- 2.0
-
excludeTransitive
@Parameter(property="excludeTransitive", defaultValue="false") protected boolean excludeTransitiveIf we should exclude transitive dependencies- Since:
- 2.0
-
includeTypes
Comma Separated list of Types to include. Empty String indicates include everything (default).- Since:
- 2.0
-
excludeTypes
Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).- Since:
- 2.0
-
includeScope
Scope threshold to include. An empty string indicates include all dependencies (default).
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:runtime
include scope gives runtime and compile dependencies,compile
include scope gives compile, provided, and system dependencies,test
include scope gives all dependencies (equivalent to default),provided
include scope just gives provided dependencies,system
include scope just gives system dependencies.
- Since:
- 2.0
-
excludeScope
Scope threshold to exclude, if no value is defined for include. An empty string indicates no dependencies (default).
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:runtime
exclude scope excludes runtime and compile dependencies,compile
exclude scope excludes compile, provided, and system dependencies,test
exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compileprovided
exclude scope just excludes provided dependencies,system
exclude scope just excludes system dependencies.
- Since:
- 2.0
-
includeClassifiers
Comma Separated list of Classifiers to include. Empty String indicates include everything (default).- Since:
- 2.0
-
excludeClassifiers
Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).- Since:
- 2.0
-
classifier
Specify classifier to look for. Example: sources- Since:
- 2.0
-
type
Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war- Since:
- 2.0
-
excludeArtifactIds
Comma separated list of Artifact names to exclude.- Since:
- 2.0
-
includeArtifactIds
Comma separated list of Artifact names to include. Empty String indicates include everything (default).- Since:
- 2.0
-
excludeGroupIds
Comma separated list of GroupId Names to exclude.- Since:
- 2.0
-
includeGroupIds
Comma separated list of GroupIds to include. Empty String indicates include everything (default).- Since:
- 2.0
-
markersDirectory
@Parameter(property="markersDirectory", defaultValue="${project.build.directory}/dependency-maven-plugin-markers") protected File markersDirectoryDirectory to store flag files- Since:
- 2.0
-
prependGroupId
@Parameter(property="mdep.prependGroupId", defaultValue="false") protected boolean prependGroupIdPrepend the groupId during copy.- Since:
- 2.2
-
-
Constructor Details
-
AbstractDependencyFilterMojo
public AbstractDependencyFilterMojo()
-
-
Method Details
-
getMarkedArtifactFilter
protected abstract org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter getMarkedArtifactFilter()Return anArtifactsFilter
indicating which artifacts must be filtered out.- Returns:
- an
ArtifactsFilter
indicating which artifacts must be filtered out.
-
getResolvedDependencies
protected Set<org.apache.maven.artifact.Artifact> getResolvedDependencies(boolean stopOnFailure) throws org.apache.maven.plugin.MojoExecutionException Retrieves dependencies, either direct only or all including transitive.- Parameters:
stopOnFailure
- true to fail if resolution does not work or false not to fail.- Returns:
- A set of artifacts
- Throws:
org.apache.maven.plugin.MojoExecutionException
- in case of errors.
-
getDependencySets
protected DependencyStatusSets getDependencySets(boolean stopOnFailure) throws org.apache.maven.plugin.MojoExecutionException - Parameters:
stopOnFailure
- true/false.- Returns:
DependencyStatusSets
- Throws:
org.apache.maven.plugin.MojoExecutionException
- in case of an error.
-
getDependencySets
protected DependencyStatusSets getDependencySets(boolean stopOnFailure, boolean includeParents) throws org.apache.maven.plugin.MojoExecutionException Method creates filters and filters the projects dependencies. This method also transforms the dependencies if classifier is set. The dependencies are filtered in least specific to most specific order- Parameters:
stopOnFailure
- true to fail if artifacts can't be resolved false otherwise.includeParents
-true
if parents should be included or notfalse
.- Returns:
- DependencyStatusSets - Bean of TreeSets that contains information on the projects dependencies
- Throws:
org.apache.maven.plugin.MojoExecutionException
- in case of errors.
-
filterMarkedDependencies
protected DependencyStatusSets filterMarkedDependencies(Set<org.apache.maven.artifact.Artifact> artifacts) throws org.apache.maven.plugin.MojoExecutionException Filter the marked dependencies- Parameters:
artifacts
- The artifacts setArtifact
.- Returns:
- status set
DependencyStatusSets
. - Throws:
org.apache.maven.plugin.MojoExecutionException
- in case of an error.
-
getMarkersDirectory
- Returns:
- Returns the markersDirectory.
-
setMarkersDirectory
- Parameters:
theMarkersDirectory
- The markersDirectory to set.
-
isPrependGroupId
public boolean isPrependGroupId()- Returns:
- true, if the groupId should be prepended to the filename.
-
setPrependGroupId
public void setPrependGroupId(boolean prependGroupId) - Parameters:
prependGroupId
- - true if the groupId must be prepended during the copy.
-
getResolverUtil
- Returns:
resolverUtil
-
getDependencyResolver
protected final org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver getDependencyResolver()- Returns:
dependencyResolver
-
getRepositoryManager
protected final org.apache.maven.shared.transfer.repository.RepositoryManager getRepositoryManager()- Returns:
repositoryManager
-