org.apache.ivy.plugins.resolver.AbstractResolver

org.apache.ivy.plugins.resolver.DualResolver

All Implemented Interfaces:: Validatable, DependencyResolver, HasLatestStrategy

public class DualResolver extends AbstractResolver

DualResolver is used to resolve dependencies with one dependency revolver, called ivy resolver, and then download artifacts found in the resolved dependencies from a second dependency resolver, called artifact resolver. It is especially useful with resolvers using repository where there is a lot of artifact, but no ivy file, like the maven ibiblio repository. If no ivy file is found by the ivy resolver, the artifact resolver is used to check if there is artifact corresponding to the request (with default ivy file). For artifact download, however, only the artifact resolver is used. Exactly two resolvers should be added to this resolver for it to work properly. The first resolver added if the ivy resolver, the second is the artifact one.

Field Summary

Fields

Modifier and Type

Field

Description

static final String

DESCRIPTOR_OPTIONAL

static final String

DESCRIPTOR_REQUIRED
Constructor Summary

Constructors

Constructor

Description

DualResolver()
Method Summary

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 location

DownloadReport

download(Artifact[] artifacts, DownloadOptions options)

Download artifacts with specified DownloadOptions.

void

dumpSettings()

boolean

exists(Artifact artifact)

Returns true 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.

DependencyResolver

getArtifactResolver()

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.

DependencyResolver

getIvyResolver()

boolean

isAllownomd()

ArtifactOrigin

locate(Artifact artifact)

Default implementation actually download the artifact Subclasses should overwrite this to avoid the download

void

publish(Artifact artifact, File src, boolean overwrite)

void

reportFailure()

Reports last resolve failure as Messages

void

reportFailure(Artifact art)

Reports last artifact download failure as Messages

void

setAllownomd(boolean allownomd)

void

setArtifactResolver(DependencyResolver artifactResolver)

void

setDescriptor(String descriptorRule)

Sets the module descriptor presence rule.

void

setIvyResolver(DependencyResolver ivyResolver)

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, listTokenValues, saveModuleRevisionIfNeeded, setCache, setChangingMatcher, setChangingPattern, setCheckmodified, setEventManager, setLatest, setLatestStrategy, setName, setNamespace, setRepositoryCacheManager, setSettings, setTimeoutConstraint, setValidate, toString, toSystem, toSystem, toSystem, toSystem, toSystem, toSystem, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- DESCRIPTOR_OPTIONAL
  
  public static final String DESCRIPTOR_OPTIONAL
  See Also:
  
  Constant Field Values
- DESCRIPTOR_REQUIRED
  
  public static final String DESCRIPTOR_REQUIRED
  See Also:
  
  Constant Field Values
Constructor Details
- DualResolver
  
  public DualResolver()
Method Details
- add
  
  public void add(DependencyResolver resolver)
- 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 ##)
  
  Parameters:
  
  dd - DependencyDescriptor
  
  data - ResolveData
  
  Returns:
  
  ResolvedModuleRevision
  
  Throws:
  
  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 descriptor
  
  data - the resolve data
  
  Returns:
  
  the module descriptor, or null
- reportFailure
  
  public void reportFailure()
  
  Description copied from interface: DependencyResolver
  
  Reports last resolve failure as Messages
  
  Specified by:
  
  reportFailure in interface DependencyResolver
  
  Overrides:
  
  reportFailure in class AbstractResolver
- reportFailure
  
  public void reportFailure(Artifact art)
  
  Description copied from interface: DependencyResolver
  
  Reports last artifact download failure as Messages
  
  Specified by:
  
  reportFailure in interface DependencyResolver
  
  Overrides:
  
  reportFailure in class AbstractResolver
  
  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 an ArtifactDownloadReport for each requested Artifact.
  
  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.
- getArtifactResolver
  
  public DependencyResolver getArtifactResolver()
- setArtifactResolver
  
  public void setArtifactResolver(DependencyResolver artifactResolver)
- getIvyResolver
  
  public DependencyResolver getIvyResolver()
- setIvyResolver
  
  public void setIvyResolver(DependencyResolver ivyResolver)
- publish
  
  public void publish(Artifact artifact, File src, boolean overwrite) throws IOException
  
  Throws:
  
  IOException
- abortPublishTransaction
  
  public void abortPublishTransaction() throws IOException
  
  Specified by:
  
  abortPublishTransaction in interface DependencyResolver
  
  Overrides:
  
  abortPublishTransaction in class AbstractResolver
  
  Throws:
  
  IOException
- beginPublishTransaction
  
  public void beginPublishTransaction(ModuleRevisionId module, boolean overwrite) throws IOException
  
  Specified by:
  
  beginPublishTransaction in interface DependencyResolver
  
  Overrides:
  
  beginPublishTransaction in class AbstractResolver
  
  Throws:
  
  IOException
- commitPublishTransaction
  
  public void commitPublishTransaction() throws IOException
  
  Specified by:
  
  commitPublishTransaction in interface DependencyResolver
  
  Overrides:
  
  commitPublishTransaction in class AbstractResolver
  
  Throws:
  
  IOException
- dumpSettings
  
  public void dumpSettings()
  
  Specified by:
  
  dumpSettings in interface DependencyResolver
  
  Overrides:
  
  dumpSettings in class AbstractResolver
- 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 AbstractResolver
  
  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 AbstractResolver
  
  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 interface DependencyResolver
  
  Overrides:
  
  download in class AbstractResolver
  
  Parameters:
  
  artifact - ArtifactOrigin
  
  options - DownloadOptions
  
  Returns:
  
  ArtifactDownloadReport
- isAllownomd
  
  public boolean isAllownomd()
- setAllownomd
  
  public void setAllownomd(boolean allownomd)
- setDescriptor
  
  public void setDescriptor(String descriptorRule)
  
  Sets the module descriptor presence rule. Should be one of DESCRIPTOR_REQUIRED or DESCRIPTOR_OPTIONAL.
  
  Parameters:
  
  descriptorRule - the descriptor rule to use with this resolver.

Class DualResolver

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.ivy.plugins.resolver.AbstractResolver

Methods inherited from class java.lang.Object

Field Details

DESCRIPTOR_OPTIONAL

DESCRIPTOR_REQUIRED

Constructor Details

DualResolver

Method Details

add

getDependency

findIvyFileRef

reportFailure

reportFailure

download

getArtifactResolver

setArtifactResolver

getIvyResolver

setIvyResolver

publish

abortPublishTransaction

beginPublishTransaction

commitPublishTransaction

dumpSettings

exists

locate

download

isAllownomd

setAllownomd

setDescriptor