org.apache.ivy.core.resolve
public class ResolveEngine extends Object
See Also: ResolveOptions
Constructor Summary | |
---|---|
ResolveEngine(ResolveEngineSettings settings, EventManager eventManager, SortEngine sortEngine)
Constructs a ResolveEngine.
|
Method Summary | |
---|---|
ArtifactDownloadReport | download(Artifact artifact, DownloadOptions options)
Download an artifact to the cache. |
ArtifactDownloadReport | download(ArtifactOrigin origin, DownloadOptions options)
Materialize an artifact already located.
|
void | downloadArtifacts(ResolveReport report, Filter artifactFilter, DownloadOptions options) |
ResolvedModuleRevision | findModule(ModuleRevisionId id, ResolveOptions options) |
IvyNode[] | getDependencies(URL ivySource, ResolveOptions options)
Resolve the dependencies of a module without downloading corresponding artifacts. |
IvyNode[] | getDependencies(ModuleDescriptor md, ResolveOptions options, ResolveReport report)
Resolve the dependencies of a module without downloading corresponding artifacts. |
DependencyResolver | getDictatorResolver()
Returns the currently configured dictator resolver, which when non null is used in place of
any specified resolver in the IvySettings
|
EventManager | getEventManager() |
ResolveEngineSettings | getSettings() |
SortEngine | getSortEngine() |
ArtifactOrigin | locate(Artifact artifact)
Locates an artifact in dependency resolvers, and return its location if it can be located and
actually exists, or an unknown ArtifactOrigin in other cases.
|
DependencyDescriptor | mediate(DependencyDescriptor dd, ResolveOptions options)
Mediates the given dependency descriptor according to given options.
|
void | outputReport(ResolveReport report, ResolutionCacheManager cacheMgr, ResolveOptions options) |
ResolveReport | resolve(File ivySource) |
ResolveReport | resolve(URL ivySource) |
ResolveReport | resolve(ModuleRevisionId mrid, ResolveOptions options, boolean changing)
Resolves the module identified by the given mrid with its dependencies if transitive is set
to true. |
ResolveReport | resolve(URL ivySource, ResolveOptions options)
Resolve dependencies of a module described by an ivy file. |
ResolveReport | resolve(ModuleDescriptor md, ResolveOptions options)
Resolve dependencies of a module described by a module descriptor. |
void | setDictatorResolver(DependencyResolver dictatorResolver)
Sets a dictator resolver, which is used in place of regular dependency resolver for
subsequent dependency resolution by this engine.
|
Parameters: settings the settings to use to configure the engine. Must not be null. eventManager the event manager to use to send events about the resolution process. Must not be null. sortEngine the sort engine to use to sort modules before producing the dependency resolution report. Must not be null.
Downloaded artifact file can be accessed using getLocalFile.
It is possible to track the progression of the download using classical ivy progress monitoring feature (see addTransferListener).
Parameters: artifact the artifact to download
Returns: a report concerning the download
See Also: ResolveEngine
Not used internally, useful especially for IDE plugins needing to download artifact one by one (for source or javadoc artifact, for instance).
Materialized artifact file can be accessed using getLocalFile.
It is possible to track the progression of the download using classical ivy progress monitoring feature (see addTransferListener).
Parameters: origin the artifact origin to materialize
Returns: a report concerning the download
See Also: ResolveEngine locate
Parameters: ivySource url of the ivy file to use for dependency resolving confs an array of configuration names to resolve - must not be null nor empty getCache the cache to use - default cache is used if null date the date to which resolution must be done - may be null
Returns: an array of the resolved dependencies
Throws: ParseException if a parsing problem occured in the ivy file IOException if an IO problem was raised during ivy file parsing
Parameters: md the descriptor of the module for which we want to get dependencies - must not be null options the resolve options to use to resolve the dependencies report a resolve report to fill during resolution - may be null
Returns: an array of the resolved Dependencies
Returns: the currently configured dictator resolver, may be null.
Parameters: artifact the artifact to locate.
Returns: the artifact location, should be tested with isUnknown to check if the artifact has actually been located.
The mediated dependency descriptor must return the actually requested module revision id when the method getDependencyRevisionId is called.
Parameters: dd the dependency descriptor for which the requested module revision id should be returned options the resolve options to use
Returns: the mediated DependencyDescriptor.
Parameters: dictatorResolver the dictator resolver to use in this engine, null if regular settings should used