org.codehaus.mojo.license.api

Class DefaultDependenciesTool

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.mojo.license.api.DefaultDependenciesTool

All Implemented Interfaces:

DependenciesTool, org.codehaus.plexus.logging.LogEnabled

@Component(role=DependenciesTool.class,
           hint="default")
public class DefaultDependenciesTool
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements DependenciesTool

Default implementation of the DependenciesTool.

Since:

1.0

Version:

$Id$

Author:

tchemit dev@tchemit.fr

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_PATTERN_MESSAGE Message used when an invalid expression pattern is found.
protected static com.fasterxml.jackson.databind.ObjectMapper	MAPPER

Constructor Summary

Constructors

Constructor and Description
DefaultDependenciesTool()

Method Summary

Modifier and Type	Method and Description
protected boolean	isExcludable(org.apache.maven.artifact.Artifact project, Pattern excludedGroupPattern, Pattern excludedArtifactPattern) Tests if the given project is excludable against a groupdId pattern and a artifact pattern.
protected boolean	isIncludable(org.apache.maven.artifact.Artifact project, Pattern includedGroupPattern, Pattern includedArtifactPattern) Tests if the given project is includeable against a groupdId pattern and a artifact pattern.
void	loadProjectArtifacts(org.apache.maven.artifact.repository.ArtifactRepository localRepository, List remoteRepositories, org.apache.maven.project.MavenProject project, Map<String,List<org.apache.maven.model.Dependency>> reactorProjectDependencies) Load project artifacts.
SortedMap<String,org.apache.maven.project.MavenProject>	loadProjectDependencies(org.apache.maven.project.MavenProject project, MavenProjectDependenciesConfigurator configuration, org.apache.maven.artifact.repository.ArtifactRepository localRepository, List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories, SortedMap<String,org.apache.maven.project.MavenProject> cache) For a given project, obtain the universe of its dependencies after applying transitivity and filtering rules given in the configuration object.
void	writeThirdPartyDependenciesFile(File outputDirectory, String listedDependenciesFilePath, Set<Dependency> listedDependencies)

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INVALID_PATTERN_MESSAGE

public static final String INVALID_PATTERN_MESSAGE

Message used when an invalid expression pattern is found.

See Also:

Constant Field Values

MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

Constructor Detail

DefaultDependenciesTool

public DefaultDependenciesTool()

Method Detail

loadProjectDependencies

public SortedMap<String,org.apache.maven.project.MavenProject> loadProjectDependencies(org.apache.maven.project.MavenProject project,
                                                                                       MavenProjectDependenciesConfigurator configuration,
                                                                                       org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                                                                       List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories,
                                                                                       SortedMap<String,org.apache.maven.project.MavenProject> cache)

For a given project, obtain the universe of its dependencies after applying transitivity and filtering rules given in the configuration object. Result is given in a map where keys are unique artifact id

Specified by:

loadProjectDependencies in interface DependenciesTool

Parameters:

project - the project to scann

configuration - the configuration

localRepository - local repository used to resolv dependencies

remoteRepositories - remote repositories used to resolv dependencies

cache - a optional cache where to keep resolved dependencies

Returns:

the map of resolved dependencies indexed by their unique id.

See Also:

MavenProjectDependenciesConfigurator

loadProjectArtifacts

public void loadProjectArtifacts(org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                 List remoteRepositories,
                                 org.apache.maven.project.MavenProject project,
                                 Map<String,List<org.apache.maven.model.Dependency>> reactorProjectDependencies)
                          throws DependenciesToolException

Load project artifacts.

Specified by:

loadProjectArtifacts in interface DependenciesTool

Parameters:

localRepository - local repository used to resolv dependencies

remoteRepositories - remote repositories used to resolv dependencies

project - the project to scann

reactorProjectDependencies - optional reactor projects dependencies indexed by their gav to resolve artifacts without fork mode (means artifacts may not exist)

Throws:

DependenciesToolException - if could not load project dependencies

writeThirdPartyDependenciesFile

public void writeThirdPartyDependenciesFile(File outputDirectory,
                                            String listedDependenciesFilePath,
                                            Set<Dependency> listedDependencies)
                                     throws IOException

Specified by:

writeThirdPartyDependenciesFile in interface DependenciesTool

Throws:

IOException

isIncludable

protected boolean isIncludable(org.apache.maven.artifact.Artifact project,
                               Pattern includedGroupPattern,
                               Pattern includedArtifactPattern)

Tests if the given project is includeable against a groupdId pattern and a artifact pattern.

Parameters:

project - the project to test

includedGroupPattern - the include group pattern

includedArtifactPattern - the include artifact pattenr

Returns:

true if the project is includavble, false otherwise

isExcludable

protected boolean isExcludable(org.apache.maven.artifact.Artifact project,
                               Pattern excludedGroupPattern,
                               Pattern excludedArtifactPattern)

Tests if the given project is excludable against a groupdId pattern and a artifact pattern.

Parameters:

project - the project to test

excludedGroupPattern - the exlcude group pattern

excludedArtifactPattern - the exclude artifact pattenr

Returns:

true if the project is excludable, false otherwise