Package org.apache.ivy.core.retrieve

Class RetrieveEngine

java.lang.Object

org.apache.ivy.core.retrieve.RetrieveEngine

public class RetrieveEngine
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private EventManager	eventManager
private static final int	KILO
private RetrieveEngineSettings	settings

Constructor Summary

Constructors

Constructor	Description
RetrieveEngine(RetrieveEngineSettings settings, EventManager eventManager)

Method Summary

Modifier and Type	Method	Description
Map<ArtifactDownloadReport,Set<String>>	determineArtifactsToCopy(ModuleRevisionId mrid, String destFilePattern, RetrieveOptions options)
private ResolutionCacheManager	getCache()
private Comparator<ArtifactDownloadReport>	getConflictResolvingPolicy()	The returned comparator should consider greater the artifact which gains the conflict battle.
private String[]	getConfs(ModuleRevisionId mrid, RetrieveOptions options)
int	retrieve(ModuleRevisionId mrid, String destFilePattern, RetrieveOptions options)	Deprecated. Use retrieve(org.apache.ivy.core.module.id.ModuleRevisionId, RetrieveOptions) instead
RetrieveReport	retrieve(ModuleRevisionId mrid, RetrieveOptions options)
private void	sync(Collection<File> target, Collection<File> existing)
private boolean	upToDate(File source, File target, RetrieveOptions options)

Methods inherited from class java.lang.Object

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

Field Details

KILO

private static final int KILO

See Also:

• Constant Field Values

settings

private RetrieveEngineSettings settings

eventManager

private EventManager eventManager

Constructor Details

RetrieveEngine

public RetrieveEngine(RetrieveEngineSettings settings,
 EventManager eventManager)

Method Details

retrieve

@Deprecated
public int retrieve(ModuleRevisionId mrid,
 String destFilePattern,
 RetrieveOptions options)
             throws IOException

Deprecated.

Use retrieve(org.apache.ivy.core.module.id.ModuleRevisionId, RetrieveOptions) instead

example of destFilePattern : - lib/[organisation]/[module]/[artifact]-[revision].[type] - lib/[artifact].[type] : flatten with no revision moduleId is used with confs and localCacheDirectory to determine an ivy report file, used as input for the copy If such a file does not exist for any conf (resolve has not been called before ?) then an IllegalStateException is thrown and nothing is copied.

Parameters:

mrid - ModuleRevisionId

destFilePattern - String

options - RetrieveOptions

Returns:

int

Throws:

IOException - if something goes wrong

retrieve

public RetrieveReport retrieve(ModuleRevisionId mrid,
 RetrieveOptions options)
                        throws IOException

Throws:

IOException

getConfs

private String[] getConfs(ModuleRevisionId mrid,
 RetrieveOptions options)
                   throws IOException

Throws:

IOException

getCache

private ResolutionCacheManager getCache()

sync

private void sync(Collection<File> target,
 Collection<File> existing)

determineArtifactsToCopy

public Map<ArtifactDownloadReport,Set<String>> determineArtifactsToCopy(ModuleRevisionId mrid,
 String destFilePattern,
 RetrieveOptions options)
                                                                 throws ParseException,
IOException

Throws:

ParseException

IOException

upToDate

private boolean upToDate(File source,
 File target,
 RetrieveOptions options)

getConflictResolvingPolicy

private Comparator<ArtifactDownloadReport> getConflictResolvingPolicy()

The returned comparator should consider greater the artifact which gains the conflict battle. This is used only during retrieve... prefer resolve conflict manager to resolve conflicts.

Returns:

Comparator<ArtifactDownloadReport>