Class ArtifactResolutionRequest
- java.lang.Object
-
- org.apache.maven.artifact.resolver.ArtifactResolutionRequest
-
- All Implemented Interfaces:
RepositoryRequest
public class ArtifactResolutionRequest extends java.lang.Object implements RepositoryRequest
A resolution request allows you to either use an existing MavenProject, or a coordinate (gid:aid:version) to process a POMs dependencies.- Author:
- Jason van Zyl
-
-
Constructor Summary
Constructors Constructor Description ArtifactResolutionRequest()ArtifactResolutionRequest(RepositoryRequest request)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ArtifactResolutionRequestaddListener(ResolutionListener listener)org.apache.maven.artifact.ArtifactgetArtifact()java.util.Set<org.apache.maven.artifact.Artifact>getArtifactDependencies()org.apache.maven.artifact.resolver.filter.ArtifactFiltergetCollectionFilter()Gets the artifact filter that controls traversal of the dependency graph.java.util.List<ResolutionListener>getListeners()org.apache.maven.artifact.repository.ArtifactRepositorygetLocalRepository()Gets the local repository to use.java.util.Map<java.lang.String,org.apache.maven.artifact.Artifact>getManagedVersionMap()java.util.List<org.apache.maven.settings.Mirror>getMirrors()java.util.List<org.apache.maven.settings.Proxy>getProxies()java.util.List<org.apache.maven.artifact.repository.ArtifactRepository>getRemoteRepositories()Gets the remote repositories to use.org.apache.maven.artifact.resolver.filter.ArtifactFiltergetResolutionFilter()Gets the artifact filter that controls downloading of artifact files.java.util.List<org.apache.maven.settings.Server>getServers()booleanisForceUpdate()Indicates whether remote repositories should be re-checked for updated artifacts/metadata regardless of their configured update policy.booleanisOffline()Indicates whether network access to remote repositories has been disabled.booleanisResolveRoot()booleanisResolveTransitively()ArtifactResolutionRequestsetArtifact(org.apache.maven.artifact.Artifact artifact)ArtifactResolutionRequestsetArtifactDependencies(java.util.Set<org.apache.maven.artifact.Artifact> artifactDependencies)ArtifactResolutionRequestsetCache(RepositoryCache cache)ArtifactResolutionRequestsetCollectionFilter(org.apache.maven.artifact.resolver.filter.ArtifactFilter filter)ArtifactResolutionRequestsetForceUpdate(boolean forceUpdate)Enables/disabled forced checks for updated artifacts/metadata on remote repositories.ArtifactResolutionRequestsetListeners(java.util.List<ResolutionListener> listeners)ArtifactResolutionRequestsetLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)Sets the local repository to use.ArtifactResolutionRequestsetManagedVersionMap(java.util.Map<java.lang.String,org.apache.maven.artifact.Artifact> managedVersionMap)ArtifactResolutionRequestsetMirrors(java.util.List<org.apache.maven.settings.Mirror> mirrors)ArtifactResolutionRequestsetOffline(boolean offline)Enables/disables network access to remote repositories.ArtifactResolutionRequestsetProxies(java.util.List<org.apache.maven.settings.Proxy> proxies)ArtifactResolutionRequestsetRemoteRepositories(java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories)Sets the remote repositories to use.ArtifactResolutionRequestsetResolutionFilter(org.apache.maven.artifact.resolver.filter.ArtifactFilter filter)ArtifactResolutionRequestsetResolveRoot(boolean resolveRoot)ArtifactResolutionRequestsetResolveTransitively(boolean resolveDependencies)ArtifactResolutionRequestsetServers(java.util.List<org.apache.maven.settings.Server> servers)java.lang.StringtoString()
-
-
-
Constructor Detail
-
ArtifactResolutionRequest
public ArtifactResolutionRequest()
-
ArtifactResolutionRequest
public ArtifactResolutionRequest(RepositoryRequest request)
-
-
Method Detail
-
getArtifact
public org.apache.maven.artifact.Artifact getArtifact()
-
setArtifact
public ArtifactResolutionRequest setArtifact(org.apache.maven.artifact.Artifact artifact)
-
setArtifactDependencies
public ArtifactResolutionRequest setArtifactDependencies(java.util.Set<org.apache.maven.artifact.Artifact> artifactDependencies)
-
getArtifactDependencies
public java.util.Set<org.apache.maven.artifact.Artifact> getArtifactDependencies()
-
getLocalRepository
public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()
Description copied from interface:RepositoryRequestGets the local repository to use.- Specified by:
getLocalRepositoryin interfaceRepositoryRequest- Returns:
- The local repository to use or
nullif not set.
-
setLocalRepository
public ArtifactResolutionRequest setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)
Description copied from interface:RepositoryRequestSets the local repository to use.- Specified by:
setLocalRepositoryin interfaceRepositoryRequest- Parameters:
localRepository- The local repository to use.- Returns:
- This request, never
null.
-
getRemoteRepositories
public java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> getRemoteRepositories()
Description copied from interface:RepositoryRequestGets the remote repositories to use.- Specified by:
getRemoteRepositoriesin interfaceRepositoryRequest- Returns:
- The remote repositories to use, never
null.
-
setRemoteRepositories
public ArtifactResolutionRequest setRemoteRepositories(java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories)
Description copied from interface:RepositoryRequestSets the remote repositories to use.- Specified by:
setRemoteRepositoriesin interfaceRepositoryRequest- Parameters:
remoteRepositories- The remote repositories to use.- Returns:
- This request, never
null.
-
getCollectionFilter
public org.apache.maven.artifact.resolver.filter.ArtifactFilter getCollectionFilter()
Gets the artifact filter that controls traversal of the dependency graph.- Returns:
- The filter used to determine which of the artifacts in the dependency graph should be traversed or
nullto collect all transitive dependencies.
-
setCollectionFilter
public ArtifactResolutionRequest setCollectionFilter(org.apache.maven.artifact.resolver.filter.ArtifactFilter filter)
-
getResolutionFilter
public org.apache.maven.artifact.resolver.filter.ArtifactFilter getResolutionFilter()
Gets the artifact filter that controls downloading of artifact files. This filter operates on those artifacts that have been included by thegetCollectionFilter().- Returns:
- The filter used to determine which of the artifacts should have their files resolved or
nullto resolve the files for all collected artifacts.
-
setResolutionFilter
public ArtifactResolutionRequest setResolutionFilter(org.apache.maven.artifact.resolver.filter.ArtifactFilter filter)
-
getListeners
public java.util.List<ResolutionListener> getListeners()
-
setListeners
public ArtifactResolutionRequest setListeners(java.util.List<ResolutionListener> listeners)
-
addListener
public ArtifactResolutionRequest addListener(ResolutionListener listener)
-
getManagedVersionMap
public java.util.Map<java.lang.String,org.apache.maven.artifact.Artifact> getManagedVersionMap()
-
setManagedVersionMap
public ArtifactResolutionRequest setManagedVersionMap(java.util.Map<java.lang.String,org.apache.maven.artifact.Artifact> managedVersionMap)
-
setResolveRoot
public ArtifactResolutionRequest setResolveRoot(boolean resolveRoot)
-
isResolveRoot
public boolean isResolveRoot()
-
setResolveTransitively
public ArtifactResolutionRequest setResolveTransitively(boolean resolveDependencies)
-
isResolveTransitively
public boolean isResolveTransitively()
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
isOffline
public boolean isOffline()
Description copied from interface:RepositoryRequestIndicates whether network access to remote repositories has been disabled.- Specified by:
isOfflinein interfaceRepositoryRequest- Returns:
trueif remote access has been disabled,falseotherwise.
-
setOffline
public ArtifactResolutionRequest setOffline(boolean offline)
Description copied from interface:RepositoryRequestEnables/disables network access to remote repositories.- Specified by:
setOfflinein interfaceRepositoryRequest- Parameters:
offline-trueto disable remote access,falseto allow network access.- Returns:
- This request, never
null.
-
isForceUpdate
public boolean isForceUpdate()
Description copied from interface:RepositoryRequestIndicates whether remote repositories should be re-checked for updated artifacts/metadata regardless of their configured update policy.- Specified by:
isForceUpdatein interfaceRepositoryRequest- Returns:
trueif remote repositories should be re-checked for updated artifacts/metadata,falseotherwise.
-
setForceUpdate
public ArtifactResolutionRequest setForceUpdate(boolean forceUpdate)
Description copied from interface:RepositoryRequestEnables/disabled forced checks for updated artifacts/metadata on remote repositories.- Specified by:
setForceUpdatein interfaceRepositoryRequest- Parameters:
forceUpdate-trueto forcibly check the remote repositories for updated artifacts/metadata,falseto use the update policy configured on each repository.- Returns:
- This request, never
null.
-
setServers
public ArtifactResolutionRequest setServers(java.util.List<org.apache.maven.settings.Server> servers)
-
getServers
public java.util.List<org.apache.maven.settings.Server> getServers()
-
setMirrors
public ArtifactResolutionRequest setMirrors(java.util.List<org.apache.maven.settings.Mirror> mirrors)
-
getMirrors
public java.util.List<org.apache.maven.settings.Mirror> getMirrors()
-
setProxies
public ArtifactResolutionRequest setProxies(java.util.List<org.apache.maven.settings.Proxy> proxies)
-
getProxies
public java.util.List<org.apache.maven.settings.Proxy> getProxies()
-
setCache
public ArtifactResolutionRequest setCache(RepositoryCache cache)
-
-