Class IvyRepResolver

java.lang.Object

org.apache.ivy.plugins.resolver.AbstractResolver

org.apache.ivy.plugins.resolver.BasicResolver

org.apache.ivy.plugins.resolver.AbstractPatternsBasedResolver

org.apache.ivy.plugins.resolver.RepositoryResolver

org.apache.ivy.plugins.resolver.URLResolver

org.apache.ivy.plugins.resolver.IvyRepResolver

All Implemented Interfaces:

Validatable, DependencyResolver, HasLatestStrategy

public class IvyRepResolver
extends URLResolver

IvyRepResolver is a resolver which can be used to resolve dependencies found in the ivy official repository for ivy files and ibiblio maven repository for the artifacts, or similar repositories. For more flexibility with url and patterns, see URLResolver.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_IVYPATTERN

Fields inherited from class BasicResolver

DATE_FORMAT, DESCRIPTOR_OPTIONAL, DESCRIPTOR_REQUIRED

Constructor Summary

Constructors

Constructor	Description
IvyRepResolver()

Method Summary

Modifier and Type	Method	Description
DownloadReport	download(Artifact[] artifacts, DownloadOptions options)	Download artifacts with specified DownloadOptions.
boolean	exists(Artifact artifact)	Returns true if the given artifact can be located by this resolver and actually exist.
ResolvedResource	findArtifactRef(Artifact artifact, Date date)
List<String>	getArtifactPatterns()
String	getArtpattern()
String	getArtroot()
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.
String	getIvypattern()
List<String>	getIvyPatterns()
String	getIvyroot()
String	getTypeName()
ModuleEntry[]	listModules(OrganisationEntry org)
OrganisationEntry[]	listOrganisations()
RevisionEntry[]	listRevisions(ModuleEntry mod)
ArtifactOrigin	locate(Artifact artifact)	Default implementation actually download the artifact Subclasses should overwrite this to avoid the download
void	publish(Artifact artifact, File src)
void	setArtpattern(String pattern)
void	setArtroot(String root)
void	setIvypattern(String pattern)
void	setIvyroot(String root)	Sets the root of the maven like repository.
void	setM2compatible(boolean m2compatible)

Methods inherited from class RepositoryResolver

dumpSettings, exist, findResourceUsingPattern, findTokenValues, get, getDestination, getRepository, getResource, isAlwaysCheckExactRevision, listResources, listTokenValues, publish, put, putChecksum, putSignature, setAlwaysCheckExactRevision, setName, setRepository, setSettings, setSigner

Methods inherited from class AbstractPatternsBasedResolver

addArtifactPattern, addConfiguredArtifact, addConfiguredIvy, addIvyPattern, convertM2CriteriaForResourceSearch, convertM2IdForResourceSearch, convertM2OrganizationForResourceSearch, convertM2ResourceSearchIdToNormal, convertM2TokenValuesForResourceSearch, findArtifactNames, findIvyFileRef, findIvyNames, findNames, findResource, findResourceUsingPatterns, getModuleDescriptorExtension, isM2compatible, listTokenValues, setArtifactPatterns, setIvyPatterns

Methods inherited from class BasicResolver

acceptLatest, checkModuleDescriptorRevision, clearArtifactAttempts, clearIvyAttempts, doFindArtifactRef, download, filterNames, findFirstArtifactRef, getAndCheck, getArtifactRef, getChecksumAlgorithms, getDefaultRMDParser, getPublicationDate, getRMDParser, getWorkspaceName, isAllownomd, isCheckconsistency, isEnvDependent, isForce, listTokenValues, logArtifactAttempt, logAttempt, logIvyAttempt, parse, reportFailure, reportFailure, setAllownomd, setCheckconsistency, setChecksums, setDescriptor, setEnvDependent, setForce, setWorkspaceName, shouldReturnResolvedModule, toString

Methods inherited from class 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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_IVYPATTERN

public static final String DEFAULT_IVYPATTERN

See Also:

• Constant Field Values

Constructor Details

IvyRepResolver

public IvyRepResolver()

Method Details

getIvypattern

public String getIvypattern()

setIvypattern

public void setIvypattern(String pattern)

getIvyroot

public String getIvyroot()

setIvyroot

public void setIvyroot(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:

IllegalArgumentException - if root does not start with "http://"

setM2compatible

public void setM2compatible(boolean m2compatible)

Overrides:

setM2compatible in class AbstractPatternsBasedResolver

publish

public void publish(Artifact artifact,
 File src)

getArtroot

public String getArtroot()

getArtpattern

public String getArtpattern()

setArtpattern

public void setArtpattern(String pattern)

setArtroot

public void setArtroot(String root)

listOrganisations

public OrganisationEntry[] listOrganisations()

Specified by:

listOrganisations in interface DependencyResolver

Overrides:

listOrganisations in class BasicResolver

listModules

public ModuleEntry[] listModules(OrganisationEntry org)

Specified by:

listModules in interface DependencyResolver

Overrides:

listModules in class BasicResolver

listRevisions

public RevisionEntry[] listRevisions(ModuleEntry mod)

Specified by:

listRevisions in interface DependencyResolver

Overrides:

listRevisions in class BasicResolver

getTypeName

public String getTypeName()

Overrides:

getTypeName in class URLResolver

getDependency

public ResolvedModuleRevision getDependency(DependencyDescriptor dd,
 ResolveData data)
                                     throws 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 interface DependencyResolver

Overrides:

getDependency in class BasicResolver

Parameters:

dd - DependencyDescriptor

data - ResolveData

Returns:

ResolvedModuleRevision

Throws:

ParseException - if something goes wrong

findArtifactRef

public ResolvedResource findArtifactRef(Artifact artifact,
 Date date)

Overrides:

findArtifactRef in class AbstractPatternsBasedResolver

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 an ArtifactDownloadReport for each requested Artifact.

Specified by:

download in interface DependencyResolver

Overrides:

download in class RepositoryResolver

Parameters:

artifacts - an array of artifacts to download. Must not be null.

options - options to apply for this download. Must not be null.

Returns:

a DownloadReport with details about each Artifact download.

exists

public boolean exists(Artifact artifact)

Description copied from interface: DependencyResolver

Returns true if the given artifact can be located by this resolver and actually exist.

Specified by:

exists in interface DependencyResolver

Overrides:

exists in class BasicResolver

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 interface DependencyResolver

Overrides:

locate in class BasicResolver

Parameters:

artifact - ArtifactOrigin

Returns:

ArtifactOrigin

getIvyPatterns

public List<String> getIvyPatterns()

Overrides:

getIvyPatterns in class AbstractPatternsBasedResolver

getArtifactPatterns

public List<String> getArtifactPatterns()

Overrides:

getArtifactPatterns in class AbstractPatternsBasedResolver