com.tobedevoured.naether.api

Interface Naether

All Known Implementing Classes:

NaetherImpl

public interface Naether

Method Summary

Modifier and Type	Method and Description
void	addBuildArtifact(String notation, String path) Add a local Build Artifact manually by String notation and path to the artifact.
void	addBuildArtifact(String notation, String path, String pom) Add a local Build Artifact manually by String notation, path to the artifact, and path to the POM.
void	addDependencies(Project project) Add dependencies from a Maven POM
void	addDependencies(Project project, List<String> scopes) Add dependencies from a Maven POM, limited to a List of scopes.
void	addDependencies(String pomPath) Add dependences from a Maven POM
void	addDependencies(String pomPath, List<String> scopes) Add dependencies from a Maven POM, limited to a List of scopes.
void	addDependency(org.sonatype.aether.graph.Dependency dependency) Add Dependency
void	addDependency(org.apache.maven.model.Dependency projectDependency) Add Dependency
void	addDependency(String notation) Add dependency by String notation with default compile scope groupId:artifactId:type:version
void	addDependency(String notation, String scope) Add dependency by String notation and Maven scope groupId:artifactId:type:version
void	addRemoteRepository(org.sonatype.aether.repository.RemoteRepository remoteRepository) Add RemoteRepository
void	addRemoteRepository(String id, String type, String url) Add a RemoteRepository
void	addRemoteRepositoryByUrl(String url) Add a RemoteRepository by String url
void	addRemoteRepositoryByUrl(String url, String username, String password) Add a RemoteRepository by String url with String username and password for authentication.
void	clearBuildArtifacts() Clear local BuildArtifacts
void	clearDependencies() Clear dependencies
void	clearRemoteRepositories() Remove all RemoteRepository
Collection<org.sonatype.aether.graph.Dependency>	currentDependencies() Get the current dependencies.
void	deployArtifact(DeployArtifact deployArtifact) Deploy an Artifact
List<File>	downloadArtifacts(List artifactsOrNotations) Download to the local repository a List of Artifact or String notations.
List<org.sonatype.aether.artifact.Artifact>	getBuildArtifacts() Get List of local artifacts that are used in dependency resolution.
Set<org.sonatype.aether.graph.Dependency>	getDependencies() List of Dependency
Map<String,Map>	getDependenciesGraph() Graph of Dependencies with their transitive Dependencies as children.
Set<String>	getDependenciesNotation() List of Dependency converted to String notation
Map<String,String>	getDependenciesPath() Map of String notation and the corresponding String file path
String	getLocalRepoPath() Get local repository path.
Set<org.sonatype.aether.repository.RemoteRepository>	getRemoteRepositories() Get Set of RemoteRepository
List<String>	getRemoteRepositoryUrls() Get List of String urls
String	getResolvedClassPath() Classpath from resolved artifacts
void	install(String notation, String pomPath, String filePath) Install Artifact to local repo.
void	resolveDependencies() Resolve dependencies and download artifacts
void	resolveDependencies(boolean downloadArtifacts) Resolve Dependencies
void	resolveDependencies(boolean downloadArtifacts, Map<String,String> properties) Resolve Dependencies
void	setBuildArtifacts(List<org.sonatype.aether.artifact.Artifact> buildArtifacts) Set List for local artifacts that are used in dependency resolution.
void	setDependencies(Set<org.sonatype.aether.graph.Dependency> dependencies) Set the List of Dependency
void	setLocalRepoPath(String repoPath) Set local repository path.
void	setRemoteRepositories(Set<org.sonatype.aether.repository.RemoteRepository> remoteRepositories) Set List of RemoteRepository

Method Detail

clearDependencies

void clearDependencies()

Clear dependencies

clearBuildArtifacts

void clearBuildArtifacts()

Clear local BuildArtifacts

addBuildArtifact

void addBuildArtifact(String notation,
                      String path,
                      String pom)

Add a local Build Artifact manually by String notation, path to the artifact, and path to the POM. The Build Artifact will override matchingdependencies found when resolving dependencies.

Parameters:

notation - String

path - String

pom - String

addBuildArtifact

void addBuildArtifact(String notation,
                      String path)
               throws NaetherException

Add a local Build Artifact manually by String notation and path to the artifact. The POM for the artifact is created automatically based on the String notation. The Build Artifact will override matchingdependencies found when resolving dependencies.

Parameters:

notation - String

path - String

Throws:

NaetherException - if failed to create a POM

addDependency

void addDependency(String notation)

Add dependency by String notation with default compile scope groupId:artifactId:type:version

Parameters:

notation - String

addDependency

void addDependency(String notation,
                   String scope)

Add dependency by String notation and Maven scope groupId:artifactId:type:version

Parameters:

notation - String

scope - String

addDependency

void addDependency(org.sonatype.aether.graph.Dependency dependency)

Add Dependency

Parameters:

dependency - Dependency

addDependency

void addDependency(org.apache.maven.model.Dependency projectDependency)

Add Dependency

Parameters:

projectDependency - Dependency

addDependencies

void addDependencies(String pomPath)
              throws ProjectException

Add dependences from a Maven POM

Parameters:

pomPath - String path to POM

Throws:

ProjectException - exception

addDependencies

void addDependencies(String pomPath,
                     List<String> scopes)
              throws ProjectException

Add dependencies from a Maven POM, limited to a List of scopes.

Parameters:

pomPath - String path to POM

scopes - List of scopes

Throws:

ProjectException - exception

addDependencies

void addDependencies(Project project)
              throws ProjectException

Add dependencies from a Maven POM

Parameters:

project - Project

Throws:

ProjectException - exception

addDependencies

void addDependencies(Project project,
                     List<String> scopes)
              throws ProjectException

Add dependencies from a Maven POM, limited to a List of scopes. Adds all Repositories from the Maven Pom.

Parameters:

project - Project

scopes - List of dependency scopes

Throws:

ProjectException - exception

clearRemoteRepositories

void clearRemoteRepositories()

Remove all RemoteRepository

addRemoteRepositoryByUrl

void addRemoteRepositoryByUrl(String url)
                       throws NaetherException

Add a RemoteRepository by String url

Parameters:

url - String

Throws:

NaetherException - exception

addRemoteRepositoryByUrl

void addRemoteRepositoryByUrl(String url,
                              String username,
                              String password)
                       throws URLException

Add a RemoteRepository by String url with String username and password for authentication.

Parameters:

url - String

username - String

password - String

Throws:

URLException - exception

addRemoteRepository

void addRemoteRepository(String id,
                         String type,
                         String url)

Add a RemoteRepository

Parameters:

id - String

type - String

url - String

addRemoteRepository

void addRemoteRepository(org.sonatype.aether.repository.RemoteRepository remoteRepository)

Add RemoteRepository

Parameters:

remoteRepository - RemoteRepository

setRemoteRepositories

void setRemoteRepositories(Set<org.sonatype.aether.repository.RemoteRepository> remoteRepositories)

Set List of RemoteRepository

Parameters:

remoteRepositories - List

getRemoteRepositories

Set<org.sonatype.aether.repository.RemoteRepository> getRemoteRepositories()

Get Set of RemoteRepository

Returns:

Set

getRemoteRepositoryUrls

List<String> getRemoteRepositoryUrls()

Get List of String urls

Returns:

List

resolveDependencies

void resolveDependencies()
                  throws URLException,
                         DependencyException

Resolve dependencies and download artifacts

Throws:

URLException - exception

DependencyException - exception

resolveDependencies

void resolveDependencies(boolean downloadArtifacts)
                  throws URLException,
                         DependencyException

Resolve Dependencies

Parameters:

downloadArtifacts - boolean if artifacts are to be downloaded

Throws:

URLException - exception

DependencyException - exception

resolveDependencies

void resolveDependencies(boolean downloadArtifacts,
                         Map<String,String> properties)
                  throws URLException,
                         DependencyException

Resolve Dependencies

Parameters:

downloadArtifacts - if artifacts are to be downloaded

properties - Map of properties

Throws:

URLException - exception

DependencyException - exception

deployArtifact

void deployArtifact(DeployArtifact deployArtifact)
             throws DeployException

Deploy an Artifact

Parameters:

deployArtifact - DeployArtifact

Throws:

DeployException - exception

install

void install(String notation,
             String pomPath,
             String filePath)
      throws InstallException

Install Artifact to local repo. If installing a POM, filePath can be null. If install a Jar without a POM, pomPath can be null.

Parameters:

notation - String

pomPath - String

filePath - String

Throws:

InstallException - exception

currentDependencies

Collection<org.sonatype.aether.graph.Dependency> currentDependencies()

Get the current dependencies. Returns Collection of resolved Dependencies if resolveDependencies() has been called, other returns getDependencies()

Returns:

Collection

getResolvedClassPath

String getResolvedClassPath()

Classpath from resolved artifacts

Returns:

String

getDependenciesNotation

Set<String> getDependenciesNotation()

List of Dependency converted to String notation

Returns:

List

getDependenciesPath

Map<String,String> getDependenciesPath()

Map of String notation and the corresponding String file path

Returns:

Map

getDependenciesGraph

Map<String,Map> getDependenciesGraph()

Graph of Dependencies with their transitive Dependencies as children.

Returns:

Map

setLocalRepoPath

void setLocalRepoPath(String repoPath)

Set local repository path. This is the destination for downloaded metadata and artifacts.

Parameters:

repoPath - String

getLocalRepoPath

String getLocalRepoPath()

Get local repository path. This is the destination for downloaded metadata and artifacts.

Returns:

String

setDependencies

void setDependencies(Set<org.sonatype.aether.graph.Dependency> dependencies)

Set the List of Dependency

Parameters:

dependencies - List

getDependencies

Set<org.sonatype.aether.graph.Dependency> getDependencies()

List of Dependency

Returns:

List

getBuildArtifacts

List<org.sonatype.aether.artifact.Artifact> getBuildArtifacts()

Get List of local artifacts that are used in dependency resolution.

Returns:

List

setBuildArtifacts

void setBuildArtifacts(List<org.sonatype.aether.artifact.Artifact> buildArtifacts)

Set List for local artifacts that are used in dependency resolution.

Parameters:

buildArtifacts - List

downloadArtifacts

List<File> downloadArtifacts(List artifactsOrNotations)
                      throws NaetherException

Download to the local repository a List of Artifact or String notations.

Parameters:

artifactsOrNotations - List of Artifact or String notation

Returns:

List

Throws:

NaetherException - exception