org.apache.maven.api.services

Interface ArtifactInstaller

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultArtifactInstaller

@Experimental
public interface ArtifactInstaller
extends Service

Installs Artifacts to the local repository.

Since:

4.0

See Also:

Session.withLocalRepository(org.apache.maven.api.LocalRepository)

Method Summary

Modifier and Type	Method and Description
void	install(ArtifactInstallerRequest request)
default void	install(Session session, Artifact artifact)
default void	install(Session session, Collection<Artifact> artifacts)

Method Detail

install

void install(ArtifactInstallerRequest request)

Parameters:

request - ArtifactInstallerRequest

Throws:

ArtifactInstallerException - in case of an error.

IllegalArgumentException - in case request is null.

install

default void install(Session session,
                     Artifact artifact)

Parameters:

session - the repository session

artifact - the Artifact to install

Throws:

ArtifactInstallerException - In case of an error which can be the a given artifact cannot be found or the installation has failed.

IllegalArgumentException - in case of parameter session is null or artifact is null.

install

default void install(Session session,
                     Collection<Artifact> artifacts)

Parameters:

session - the repository session

artifacts - Collection of MavenArtifacts

Throws:

ArtifactInstallerException - In case of an error which can be the a given artifact cannot be found or the installation has failed.

IllegalArgumentException - in case of parameter request is null or parameter localRepository is null or localRepository is not a directory or parameter mavenArtifacts is null or mavenArtifacts.isEmpty() is true.