Package org.apache.ivy.plugins.resolver
Class ChainResolver
- java.lang.Object
-
- org.apache.ivy.plugins.resolver.AbstractResolver
-
- org.apache.ivy.plugins.resolver.ChainResolver
-
- All Implemented Interfaces:
Validatable
,DependencyResolver
,HasLatestStrategy
- Direct Known Subclasses:
WorkspaceChainResolver
public class ChainResolver extends AbstractResolver
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ChainResolver.ResolvedModuleRevisionArtifactInfo
-
Constructor Summary
Constructors Constructor Description ChainResolver()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
abortPublishTransaction()
void
add(DependencyResolver resolver)
void
beginPublishTransaction(ModuleRevisionId module, boolean overwrite)
void
commitPublishTransaction()
ArtifactDownloadReport
download(ArtifactOrigin artifact, DownloadOptions options)
Default implementation downloads the artifact without taking advantage of its locationDownloadReport
download(Artifact[] artifacts, DownloadOptions options)
Download artifacts with specified DownloadOptions.void
dumpSettings()
boolean
exists(Artifact artifact)
Returnstrue
if the given artifact can be located by this resolver and actually exist.ResolvedResource
findIvyFileRef(DependencyDescriptor dd, ResolveData data)
Finds the module descriptor for the specified DependencyDescriptor.ResolvedModuleRevision
getDependency(DependencyDescriptor dd, ResolveData data)
Resolve a module by id, getting its module descriptor and resolving the revision if it's a latest one (i.e.java.util.List<DependencyResolver>
getResolvers()
boolean
isDual()
boolean
isReturnFirst()
java.util.Map<java.lang.String,java.lang.String>[]
listTokenValues(java.lang.String[] tokens, java.util.Map<java.lang.String,java.lang.Object> criteria)
Same asDependencyResolver.listTokenValues(String, Map)
but more generic.ArtifactOrigin
locate(Artifact artifact)
Default implementation actually download the artifact Subclasses should overwrite this to avoid the downloadvoid
publish(Artifact artifact, java.io.File src, boolean overwrite)
void
reportFailure()
Reports last resolve failure as Messagesvoid
reportFailure(Artifact art)
Reports last artifact download failure as Messagesvoid
setDual(boolean b)
void
setReturnFirst(boolean returnFirst)
-
Methods inherited from class org.apache.ivy.plugins.resolver.AbstractResolver
checkInterrupted, checkLatest, doValidate, findModuleInCache, findModuleInCache, fromSystem, fromSystem, getCacheDownloadOptions, getCacheOptions, getChangingMatcherName, getChangingPattern, getDownloadOptions, getEventManager, getLatest, getLatestStrategy, getName, getNamespace, getParserSettings, getRepositoryCacheManager, getSettings, getSystemNode, getTimeoutConstraint, getTypeName, hidePassword, isAfter, isValidate, listModules, listOrganisations, listRevisions, listTokenValues, saveModuleRevisionIfNeeded, setCache, setChangingMatcher, setChangingPattern, setCheckmodified, setEventManager, setLatest, setLatestStrategy, setName, setNamespace, setRepositoryCacheManager, setSettings, setTimeoutConstraint, setValidate, toString, toSystem, toSystem, toSystem, toSystem, toSystem, toSystem, validate
-
-
-
-
Method Detail
-
add
public void add(DependencyResolver resolver)
-
getDependency
public ResolvedModuleRevision getDependency(DependencyDescriptor dd, ResolveData data) throws java.text.ParseException
Description copied from interface:DependencyResolver
Resolve a module by id, getting its module descriptor and resolving the revision if it's a latest one (i.e. a revision uniquely identifying the revision of a module in the current environment - If this revision is not able to identify uniquely the revision of the module outside of the current environment, then the resolved revision must begin by ##)- Parameters:
dd
- DependencyDescriptordata
- ResolveData- Returns:
- ResolvedModuleRevision
- Throws:
java.text.ParseException
- if something goes wrong
-
findIvyFileRef
public ResolvedResource findIvyFileRef(DependencyDescriptor dd, ResolveData data)
Description copied from interface:DependencyResolver
Finds the module descriptor for the specified DependencyDescriptor. If this resolver can't find the module descriptor, null is returned.- Parameters:
dd
- the dependency descriptordata
- the resolve data- Returns:
- the module descriptor, or null
-
listTokenValues
public java.util.Map<java.lang.String,java.lang.String>[] listTokenValues(java.lang.String[] tokens, java.util.Map<java.lang.String,java.lang.Object> criteria)
Description copied from interface:DependencyResolver
Same asDependencyResolver.listTokenValues(String, Map)
but more generic.- Specified by:
listTokenValues
in interfaceDependencyResolver
- Overrides:
listTokenValues
in classAbstractResolver
- Parameters:
tokens
- the tokens of the querycriteria
- the token which have values- Returns:
- the list of token values, must not be
null
-
reportFailure
public void reportFailure()
Description copied from interface:DependencyResolver
Reports last resolve failure as Messages- Specified by:
reportFailure
in interfaceDependencyResolver
- Overrides:
reportFailure
in classAbstractResolver
-
reportFailure
public void reportFailure(Artifact art)
Description copied from interface:DependencyResolver
Reports last artifact download failure as Messages- Specified by:
reportFailure
in interfaceDependencyResolver
- Overrides:
reportFailure
in classAbstractResolver
- Parameters:
art
- Artifact
-
download
public DownloadReport download(Artifact[] artifacts, DownloadOptions options)
Description copied from interface:DependencyResolver
Download artifacts with specified DownloadOptions.The resolver will always make a best effort, and do not stop when an artifact is not available. It rather continue to attempt to download other requested artifacts, and report what has been done in the returned DownloadReport.
The returned DownloadReport is never
null
, and always contain anArtifactDownloadReport
for each requested Artifact.- Parameters:
artifacts
- an array of artifacts to download. Must not benull
.options
- options to apply for this download. Must not benull
.- Returns:
- a DownloadReport with details about each Artifact download.
-
getResolvers
public java.util.List<DependencyResolver> getResolvers()
-
publish
public void publish(Artifact artifact, java.io.File src, boolean overwrite) throws java.io.IOException
- Throws:
java.io.IOException
-
abortPublishTransaction
public void abortPublishTransaction() throws java.io.IOException
- Specified by:
abortPublishTransaction
in interfaceDependencyResolver
- Overrides:
abortPublishTransaction
in classAbstractResolver
- Throws:
java.io.IOException
-
beginPublishTransaction
public void beginPublishTransaction(ModuleRevisionId module, boolean overwrite) throws java.io.IOException
- Specified by:
beginPublishTransaction
in interfaceDependencyResolver
- Overrides:
beginPublishTransaction
in classAbstractResolver
- Throws:
java.io.IOException
-
commitPublishTransaction
public void commitPublishTransaction() throws java.io.IOException
- Specified by:
commitPublishTransaction
in interfaceDependencyResolver
- Overrides:
commitPublishTransaction
in classAbstractResolver
- Throws:
java.io.IOException
-
isReturnFirst
public boolean isReturnFirst()
-
setReturnFirst
public void setReturnFirst(boolean returnFirst)
-
dumpSettings
public void dumpSettings()
- Specified by:
dumpSettings
in interfaceDependencyResolver
- Overrides:
dumpSettings
in classAbstractResolver
-
exists
public boolean exists(Artifact artifact)
Description copied from interface:DependencyResolver
Returnstrue
if the given artifact can be located by this resolver and actually exist.- Specified by:
exists
in interfaceDependencyResolver
- Overrides:
exists
in classAbstractResolver
- Parameters:
artifact
- the artifact which should be tested.- Returns:
true
if the given artifact can be located by this resolver and actually exist.
-
locate
public ArtifactOrigin locate(Artifact artifact)
Description copied from class:AbstractResolver
Default implementation actually download the artifact Subclasses should overwrite this to avoid the download- Specified by:
locate
in interfaceDependencyResolver
- Overrides:
locate
in classAbstractResolver
- Parameters:
artifact
- ArtifactOrigin- Returns:
- ArtifactOrigin
-
download
public ArtifactDownloadReport download(ArtifactOrigin artifact, DownloadOptions options)
Description copied from class:AbstractResolver
Default implementation downloads the artifact without taking advantage of its location- Specified by:
download
in interfaceDependencyResolver
- Overrides:
download
in classAbstractResolver
- Parameters:
artifact
- ArtifactOriginoptions
- DownloadOptions- Returns:
- ArtifactDownloadReport
-
setDual
public void setDual(boolean b)
-
isDual
public boolean isDual()
-
-