Package org.apache.ivy.plugins.resolver
Class IBiblioResolver
- java.lang.Object
-
- All Implemented Interfaces:
Validatable
,DependencyResolver
,HasLatestStrategy
- Direct Known Subclasses:
BintrayResolver
public class IBiblioResolver extends URLResolver
IBiblioResolver is a resolver which can be used to resolve dependencies found in the ibiblio maven repository, or similar repositories.For more flexibility with url and patterns, see
URLResolver
.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_M2_ROOT
static java.lang.String
DEFAULT_PATTERN
Deprecated.static java.lang.String
DEFAULT_ROOT
Deprecated.-
Fields inherited from class org.apache.ivy.plugins.resolver.BasicResolver
DATE_FORMAT, DESCRIPTOR_OPTIONAL, DESCRIPTOR_REQUIRED
-
-
Constructor Summary
Constructors Constructor Description IBiblioResolver()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DownloadReport
download(Artifact[] artifacts, DownloadOptions options)
Download artifacts with specified DownloadOptions.void
dumpSettings()
void
ensureConfigured(ResolverSettings settings)
boolean
exists(Artifact artifact)
Returnstrue
if the given artifact can be located by this resolver and actually exist.ResolvedResource
findArtifactRef(Artifact artifact, java.util.Date date)
ResolvedResource
findIvyFileRef(DependencyDescriptor dd, ResolveData data)
Finds the module descriptor for the specified DependencyDescriptor.protected void
findTokenValues(java.util.Collection<java.lang.String> names, java.util.List<java.lang.String> patterns, java.util.Map<java.lang.String,java.lang.String> tokenValues, java.lang.String token)
java.util.List<java.lang.String>
getArtifactPatterns()
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.protected java.lang.String
getModuleDescriptorExtension()
java.lang.String
getPattern()
java.lang.String
getRoot()
java.lang.String
getTypeName()
boolean
isUseMavenMetadata()
boolean
isUsepoms()
ModuleEntry[]
listModules(OrganisationEntry org)
OrganisationEntry[]
listOrganisations()
protected ResolvedResource[]
listResources(Repository repository, ModuleRevisionId mrid, java.lang.String pattern, Artifact artifact)
List all revisions as resolved resources for the given artifact in the given repository using the given pattern, and using the given mrid except its revision.RevisionEntry[]
listRevisions(ModuleEntry mod)
protected java.lang.String[]
listTokenValues(java.lang.String pattern, java.lang.String token)
java.lang.String[]
listTokenValues(java.lang.String token, java.util.Map<java.lang.String,java.lang.String> otherTokenValues)
List all the values the given token can take if other tokens are set as described in the otherTokenValues map.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)
void
setM2compatible(boolean m2compatible)
void
setPattern(java.lang.String pattern)
void
setRoot(java.lang.String root)
Sets the root of the maven like repository.void
setUseMavenMetadata(boolean useMavenMetadata)
void
setUsepoms(boolean usepoms)
-
Methods inherited from class org.apache.ivy.plugins.resolver.RepositoryResolver
exist, findResourceUsingPattern, get, getDestination, getRepository, getResource, isAlwaysCheckExactRevision, publish, put, putChecksum, putSignature, setAlwaysCheckExactRevision, setName, setRepository, setSettings, setSigner
-
Methods inherited from class org.apache.ivy.plugins.resolver.AbstractPatternsBasedResolver
addArtifactPattern, addConfiguredArtifact, addConfiguredIvy, addIvyPattern, convertM2CriteriaForResourceSearch, convertM2IdForResourceSearch, convertM2OrganizationForResourceSearch, convertM2ResourceSearchIdToNormal, convertM2TokenValuesForResourceSearch, findArtifactNames, findIvyNames, findNames, findResource, findResourceUsingPatterns, getIvyPatterns, isM2compatible, listTokenValues, setArtifactPatterns, setIvyPatterns
-
Methods inherited from class org.apache.ivy.plugins.resolver.BasicResolver
acceptLatest, checkModuleDescriptorRevision, clearArtifactAttempts, clearIvyAttempts, doFindArtifactRef, download, filterNames, findFirstArtifactRef, getAndCheck, getArtifactRef, getChecksumAlgorithms, getDefaultRMDParser, getPublicationDate, getRMDParser, getWorkspaceName, isAllownomd, isCheckconsistency, isEnvDependent, isForce, logArtifactAttempt, logAttempt, logIvyAttempt, parse, reportFailure, reportFailure, setAllownomd, setCheckconsistency, setChecksums, setDescriptor, setEnvDependent, setForce, setWorkspaceName, shouldReturnResolvedModule, toString
-
Methods inherited from class org.apache.ivy.plugins.resolver.AbstractResolver
abortPublishTransaction, beginPublishTransaction, checkInterrupted, checkLatest, commitPublishTransaction, doValidate, findModuleInCache, findModuleInCache, fromSystem, fromSystem, getCacheDownloadOptions, getCacheOptions, getChangingMatcherName, getChangingPattern, getDownloadOptions, getEventManager, getLatest, getLatestStrategy, getName, getNamespace, getParserSettings, getRepositoryCacheManager, getSettings, getSystemNode, getTimeoutConstraint, hidePassword, isAfter, isValidate, saveModuleRevisionIfNeeded, setCache, setChangingMatcher, setChangingPattern, setCheckmodified, setEventManager, setLatest, setLatestStrategy, setNamespace, setRepositoryCacheManager, setTimeoutConstraint, setValidate, toSystem, toSystem, toSystem, toSystem, toSystem, toSystem, validate
-
-
-
-
Field Detail
-
DEFAULT_PATTERN
@Deprecated public static final java.lang.String DEFAULT_PATTERN
Deprecated.- See Also:
- Constant Field Values
-
DEFAULT_ROOT
@Deprecated public static final java.lang.String DEFAULT_ROOT
Deprecated.- See Also:
- Constant Field Values
-
DEFAULT_M2_ROOT
public static final java.lang.String DEFAULT_M2_ROOT
- See Also:
- Constant Field Values
-
-
Method Detail
-
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.- Specified by:
findIvyFileRef
in interfaceDependencyResolver
- Overrides:
findIvyFileRef
in classAbstractPatternsBasedResolver
- Parameters:
dd
- the dependency descriptordata
- the resolve data- Returns:
- the module descriptor, or null
-
findArtifactRef
public ResolvedResource findArtifactRef(Artifact artifact, java.util.Date date)
- Overrides:
findArtifactRef
in classAbstractPatternsBasedResolver
-
setM2compatible
public void setM2compatible(boolean m2compatible)
- Overrides:
setM2compatible
in classAbstractPatternsBasedResolver
-
ensureConfigured
public void ensureConfigured(ResolverSettings settings)
-
getModuleDescriptorExtension
protected java.lang.String getModuleDescriptorExtension()
- Overrides:
getModuleDescriptorExtension
in classAbstractPatternsBasedResolver
-
getPattern
public java.lang.String getPattern()
-
setPattern
public void setPattern(java.lang.String pattern)
-
getRoot
public java.lang.String getRoot()
-
setRoot
public void setRoot(java.lang.String root)
Sets the root of the maven like repository. The maven like repository is necessarily an http repository.- Parameters:
root
- the root of the maven like repository- Throws:
java.lang.IllegalArgumentException
- if root does not start with "http://"
-
publish
public void publish(Artifact artifact, java.io.File src)
-
listTokenValues
public java.lang.String[] listTokenValues(java.lang.String token, java.util.Map<java.lang.String,java.lang.String> otherTokenValues)
Description copied from interface:DependencyResolver
List all the values the given token can take if other tokens are set as described in the otherTokenValues map. For instance, if token = "revision" and the map contains "organisation"->"foo" "module"->"bar" The results will be the list of revisions of the module bar from the org foo.Note that listing does not take into account namespaces, and return raw information without any namespace transformation. The caller is responsible for calling namespace transformation with the Namespace returned by
DependencyResolver.getNamespace()
.- Specified by:
listTokenValues
in interfaceDependencyResolver
- Overrides:
listTokenValues
in classBasicResolver
- Parameters:
token
- StringotherTokenValues
- Map- Returns:
- String[]
-
listTokenValues
protected java.lang.String[] listTokenValues(java.lang.String pattern, java.lang.String token)
- Overrides:
listTokenValues
in classRepositoryResolver
-
listOrganisations
public OrganisationEntry[] listOrganisations()
- Specified by:
listOrganisations
in interfaceDependencyResolver
- Overrides:
listOrganisations
in classBasicResolver
-
listModules
public ModuleEntry[] listModules(OrganisationEntry org)
- Specified by:
listModules
in interfaceDependencyResolver
- Overrides:
listModules
in classBasicResolver
-
listRevisions
public RevisionEntry[] listRevisions(ModuleEntry mod)
- Specified by:
listRevisions
in interfaceDependencyResolver
- Overrides:
listRevisions
in classBasicResolver
-
listResources
protected ResolvedResource[] listResources(Repository repository, ModuleRevisionId mrid, java.lang.String pattern, Artifact artifact)
Description copied from class:RepositoryResolver
List all revisions as resolved resources for the given artifact in the given repository using the given pattern, and using the given mrid except its revision.- Overrides:
listResources
in classRepositoryResolver
- Parameters:
repository
- the repository in which revisions should be locatedmrid
- the module revision id to look for (except revision)pattern
- the pattern to use to locate the revisionsartifact
- the artifact to find- Returns:
- an array of ResolvedResource, all pointing to a different revision of the given Artifact.
-
findTokenValues
protected void findTokenValues(java.util.Collection<java.lang.String> names, java.util.List<java.lang.String> patterns, java.util.Map<java.lang.String,java.lang.String> tokenValues, java.lang.String token)
- Overrides:
findTokenValues
in classRepositoryResolver
-
getTypeName
public java.lang.String getTypeName()
- Overrides:
getTypeName
in classURLResolver
-
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 ##)- Specified by:
getDependency
in interfaceDependencyResolver
- Overrides:
getDependency
in classBasicResolver
- Parameters:
dd
- DependencyDescriptordata
- ResolveData- Returns:
- ResolvedModuleRevision
- Throws:
java.text.ParseException
- if something goes wrong
-
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.- Specified by:
download
in interfaceDependencyResolver
- Overrides:
download
in classRepositoryResolver
- 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.
-
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 classBasicResolver
- 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 classBasicResolver
- Parameters:
artifact
- ArtifactOrigin- Returns:
- ArtifactOrigin
-
getArtifactPatterns
public java.util.List<java.lang.String> getArtifactPatterns()
- Overrides:
getArtifactPatterns
in classAbstractPatternsBasedResolver
-
isUsepoms
public boolean isUsepoms()
-
setUsepoms
public void setUsepoms(boolean usepoms)
-
isUseMavenMetadata
public boolean isUseMavenMetadata()
-
setUseMavenMetadata
public void setUseMavenMetadata(boolean useMavenMetadata)
-
dumpSettings
public void dumpSettings()
- Specified by:
dumpSettings
in interfaceDependencyResolver
- Overrides:
dumpSettings
in classRepositoryResolver
-
-