org.codehaus.mojo.license.api

Interface DependenciesTool

All Known Implementing Classes:

DefaultDependenciesTool

public interface DependenciesTool

A tool to deal with dependencies of a project.

Since:

1.0

Author:

tchemit dev@tchemit.fr

Method Summary

Modifier and Type	Method and Description
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 file, String listedDependenciesFilePath, Set<Dependency> listedDependencies)

Method Detail

loadProjectDependencies

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

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

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.

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

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

Throws:

IOException