package org.apache.maven.plugin.dependency;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.dependency.utils.DependencyStatusSets;
import org.apache.maven.plugin.dependency.utils.DependencyUtil;
import org.apache.maven.plugin.dependency.utils.resolvers.ArtifactsResolver;
import org.apache.maven.plugin.dependency.utils.resolvers.DefaultArtifactsResolver;
import org.apache.maven.plugin.dependency.utils.translators.ArtifactTranslator;
import org.apache.maven.plugin.dependency.utils.translators.ClassifierTypeTranslator;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException;
import org.apache.maven.shared.artifact.filter.collection.ArtifactIdFilter;
import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
import org.apache.maven.shared.artifact.filter.collection.ClassifierFilter;
import org.apache.maven.shared.artifact.filter.collection.FilterArtifacts;
import org.apache.maven.shared.artifact.filter.collection.GroupIdFilter;
import org.apache.maven.shared.artifact.filter.collection.ProjectTransitivityFilter;
import org.apache.maven.shared.artifact.filter.collection.ScopeFilter;
import org.apache.maven.shared.artifact.filter.collection.TypeFilter;
import org.codehaus.plexus.util.StringUtils;
import java.io.File;
import java.util.HashSet;
import java.util.Set;
/**
* Class that encapsulates the plugin parameters, and contains methods that
* handle dependency filtering
*
* @author <a href="mailto:brianf@apache.org">Brian Fox</a>
* @version $Id: AbstractDependencyFilterMojo.java 1400737 2012-10-21 22:53:48Z hboutemy $
* @see org.apache.maven.plugin.dependency.AbstractDependencyMojo
*/
public abstract class AbstractDependencyFilterMojo
extends AbstractDependencyMojo
{
/**
* If we should exclude transitive dependencies
*
* @since 2.0
*/
@Parameter( property = "excludeTransitive", defaultValue = "false" )
protected boolean excludeTransitive;
/**
* Comma Separated list of Types to include. Empty String indicates include
* everything (default).
*
* @since 2.0
*/
@Parameter( property = "includeTypes", defaultValue = "" )
protected String includeTypes;
/**
* Comma Separated list of Types to exclude. Empty String indicates don't
* exclude anything (default).
*
* @since 2.0
*/
@Parameter( property = "excludeTypes", defaultValue = "" )
protected String excludeTypes;
/**
* Scope to include. An Empty string indicates all scopes (default).
*
* @since 2.0
*/
@Parameter( property = "includeScope", defaultValue = "" )
protected String includeScope;
/**
* Scope to exclude. An Empty string indicates no scopes (default).
*
* @since 2.0
*/
@Parameter( property = "excludeScope", defaultValue = "" )
protected String excludeScope;
/**
* Comma Separated list of Classifiers to include. Empty String indicates
* include everything (default).
*
* @since 2.0
*/
@Parameter( property = "includeClassifiers", defaultValue = "" )
protected String includeClassifiers;
/**
* Comma Separated list of Classifiers to exclude. Empty String indicates
* don't exclude anything (default).
*
* @since 2.0
*/
@Parameter( property = "excludeClassifiers", defaultValue = "" )
protected String excludeClassifiers;
/**
* Specify classifier to look for. Example: sources
*
* @since 2.0
*/
@Parameter( property = "classifier", defaultValue = "" )
protected String classifier;
/**
* Specify type to look for when constructing artifact based on classifier.
* Example: java-source,jar,war
*
* @since 2.0
*/
@Parameter( property = "type", defaultValue = "" )
protected String type;
/**
* Comma separated list of Artifact names to exclude.
*
* @since 2.0
*/
@Parameter( property = "excludeArtifactIds", defaultValue = "" )
protected String excludeArtifactIds;
/**
* Comma separated list of Artifact names to include.
*
* @since 2.0
*/
@Parameter( property = "includeArtifactIds", defaultValue = "" )
protected String includeArtifactIds;
/**
* Comma separated list of GroupId Names to exclude.
*
* @since 2.0
*/
@Parameter( property = "excludeGroupIds", defaultValue = "" )
protected String excludeGroupIds;
/**
* Comma separated list of GroupIds to include.
*
* @since 2.0
*/
@Parameter( property = "includeGroupIds", defaultValue = "" )
protected String includeGroupIds;
/**
* Directory to store flag files
*
* @since 2.0
*/
@Parameter( property = "markersDirectory",
defaultValue = "${project.build.directory}/dependency-maven-plugin-markers" )
protected File markersDirectory;
/**
* Overwrite release artifacts
*
* @since 1.0
*/
@Parameter( property = "overWriteReleases", defaultValue = "false" )
protected boolean overWriteReleases;
/**
* Overwrite snapshot artifacts
*
* @since 1.0
*/
@Parameter( property = "overWriteSnapshots", defaultValue = "false" )
protected boolean overWriteSnapshots;
/**
* Overwrite artifacts that don't exist or are older than the source.
*
* @since 2.0
*/
@Parameter( property = "overWriteIfNewer", defaultValue = "true" )
protected boolean overWriteIfNewer;
/**
* Prepend the groupId during copy.
*
* @since 2.2
*/
@Parameter( property = "mdep.prependGroupId", defaultValue = "false" )
protected boolean prependGroupId = false;
/**
* Return an {@link ArtifactsFilter} indicating which artifacts must be filtered out.
*
* @return an {@link ArtifactsFilter} indicating which artifacts must be filtered out.
*/
protected abstract ArtifactsFilter getMarkedArtifactFilter();
/**
* Retrieves dependencies, either direct only or all including transitive.
*
* @return A HashSet of artifacts
* @throws MojoExecutionException
*/
protected Set<Artifact> getResolvedDependencies( boolean stopOnFailure )
throws MojoExecutionException
{
DependencyStatusSets status = getDependencySets( stopOnFailure );
return status.getResolvedDependencies();
}
/**
* 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
*
* @param stopOnFailure
* @return DependencyStatusSets - Bean of TreeSets that contains information
* on the projects dependencies
* @throws MojoExecutionException
*/
protected DependencyStatusSets getDependencySets( boolean stopOnFailure )
throws MojoExecutionException
{
// add filters in well known order, least specific to most specific
FilterArtifacts filter = new FilterArtifacts();
filter.addFilter( new ProjectTransitivityFilter( project.getDependencyArtifacts(), this.excludeTransitive ) );
filter.addFilter( new ScopeFilter( DependencyUtil.cleanToBeTokenizedString( this.includeScope ),
DependencyUtil.cleanToBeTokenizedString( this.excludeScope ) ) );
filter.addFilter( new TypeFilter( DependencyUtil.cleanToBeTokenizedString( this.includeTypes ),
DependencyUtil.cleanToBeTokenizedString( this.excludeTypes ) ) );
filter.addFilter( new ClassifierFilter( DependencyUtil.cleanToBeTokenizedString( this.includeClassifiers ),
DependencyUtil.cleanToBeTokenizedString( this.excludeClassifiers ) ) );
filter.addFilter( new GroupIdFilter( DependencyUtil.cleanToBeTokenizedString( this.includeGroupIds ),
DependencyUtil.cleanToBeTokenizedString( this.excludeGroupIds ) ) );
filter.addFilter( new ArtifactIdFilter( DependencyUtil.cleanToBeTokenizedString( this.includeArtifactIds ),
DependencyUtil.cleanToBeTokenizedString( this.excludeArtifactIds ) ) );
// start with all artifacts.
@SuppressWarnings( "unchecked" ) Set<Artifact> artifacts = project.getArtifacts();
// perform filtering
try
{
artifacts = filter.filter( artifacts );
}
catch ( ArtifactFilterException e )
{
throw new MojoExecutionException( e.getMessage(), e );
}
// transform artifacts if classifier is set
DependencyStatusSets status = null;
if ( StringUtils.isNotEmpty( classifier ) )
{
status = getClassifierTranslatedDependencies( artifacts, stopOnFailure );
}
else
{
status = filterMarkedDependencies( artifacts );
}
return status;
}
/**
* Transform artifacts
*
* @param artifacts
* @param stopOnFailure
* @return DependencyStatusSets - Bean of TreeSets that contains information
* on the projects dependencies
* @throws MojoExecutionException
*/
protected DependencyStatusSets getClassifierTranslatedDependencies( Set<Artifact> artifacts, boolean stopOnFailure )
throws MojoExecutionException
{
Set<Artifact> unResolvedArtifacts = new HashSet<Artifact>();
Set<Artifact> resolvedArtifacts = artifacts;
DependencyStatusSets status = new DependencyStatusSets();
// possibly translate artifacts into a new set of artifacts based on the
// classifier and type
// if this did something, we need to resolve the new artifacts
if ( StringUtils.isNotEmpty( classifier ) )
{
ArtifactTranslator translator = new ClassifierTypeTranslator( this.classifier, this.type, this.factory );
artifacts = translator.translate( artifacts, getLog() );
status = filterMarkedDependencies( artifacts );
// the unskipped artifacts are in the resolved set.
artifacts = status.getResolvedDependencies();
// resolve the rest of the artifacts
ArtifactsResolver artifactsResolver =
new DefaultArtifactsResolver( this.resolver, this.getLocal(), this.remoteRepos, stopOnFailure );
resolvedArtifacts = artifactsResolver.resolve( artifacts, getLog() );
// calculate the artifacts not resolved.
unResolvedArtifacts.addAll( artifacts );
unResolvedArtifacts.removeAll( resolvedArtifacts );
}
// return a bean of all 3 sets.
status.setResolvedDependencies( resolvedArtifacts );
status.setUnResolvedDependencies( unResolvedArtifacts );
return status;
}
/**
* Filter the marked dependencies
*
* @param artifacts
* @return
* @throws MojoExecutionException
*/
protected DependencyStatusSets filterMarkedDependencies( Set<Artifact> artifacts )
throws MojoExecutionException
{
// remove files that have markers already
FilterArtifacts filter = new FilterArtifacts();
filter.clearFilters();
filter.addFilter( getMarkedArtifactFilter() );
Set<Artifact> unMarkedArtifacts;
try
{
unMarkedArtifacts = filter.filter( artifacts );
}
catch ( ArtifactFilterException e )
{
throw new MojoExecutionException( e.getMessage(), e );
}
// calculate the skipped artifacts
Set<Artifact> skippedArtifacts = new HashSet<Artifact>();
skippedArtifacts.addAll( artifacts );
skippedArtifacts.removeAll( unMarkedArtifacts );
return new DependencyStatusSets( unMarkedArtifacts, null, skippedArtifacts );
}
/**
* @return Returns the markersDirectory.
*/
public File getMarkersDirectory()
{
return this.markersDirectory;
}
/**
* @param theMarkersDirectory The markersDirectory to set.
*/
public void setMarkersDirectory( File theMarkersDirectory )
{
this.markersDirectory = theMarkersDirectory;
}
// TODO: Set marker files.
/**
* @return true, if the groupId should be prepended to the filename.
*/
public boolean isPrependGroupId()
{
return prependGroupId;
}
/**
* @param prependGroupId -
* true if the groupId must be prepended during the copy.
*/
public void setPrependGroupId( boolean prependGroupId )
{
this.prependGroupId = prependGroupId;
}
}