org.apache.ivy.Ivy14

public class Ivy14 extends Object

This class can be used for easy migration from Ivy 1.4 API.

Indeed, Ivy 2.0 API has changed substantially, so it can take time to migrate existing code using Ivy 1.4 API to the new API. Using this class it's really easy: replace your instance of Ivy by an instance of this class.

For instance, where you were doing:

 Ivy ivy = new Ivy();

do instead:

 Ivy14 ivy = new Ivy14();

And that should be enough in most cases!

Constructor Summary

Constructors

Constructor

Description

Ivy14()

Ivy14(Ivy ivy)
Method Summary

Modifier and Type

Method

Description

boolean

check(URL ivyFile, String resolvername)

void

configure(File settingsFile)

void

configure(URL settingsURL)

void

configureDefault()

void

deliver(ModuleRevisionId mrid, String revision, File cache, String destIvyPattern, String status, Date pubdate, PublishingDependencyRevisionResolver pdrResolver, boolean validate)

void

deliver(ModuleRevisionId mrid, String revision, File cache, String destIvyPattern, String status, Date pubdate, PublishingDependencyRevisionResolver pdrResolver, boolean validate, boolean resolveDynamicRevisions)

Map<ArtifactDownloadReport,Set<String>>

determineArtifactsToCopy(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern)

Map<ArtifactDownloadReport,Set<String>>

determineArtifactsToCopy(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern, Filter<Artifact> artifactFilter)

ArtifactDownloadReport

download(Artifact artifact, File cache, boolean useOrigin)

ResolvedModuleRevision

findModule(ModuleRevisionId id)

IvyNode[]

getDependencies(URL ivySource, String[] confs, File cache, Date date, boolean validate)

IvyNode[]

getDependencies(ModuleDescriptor md, String[] confs, File cache, Date date, ResolveReport report, boolean validate)

IvyNode[]

getDependencies(ModuleDescriptor md, String[] confs, File cache, Date date, ResolveReport report, boolean validate, boolean transitive)

String

getVariable(String name)

ResolveReport

install(ModuleRevisionId mrid, String from, String to, boolean transitive, boolean validate, boolean overwrite, Filter<Artifact> artifactFilter, File cache, String matcherName)

void

interrupt()

void

interrupt(Thread operatingThread)

boolean

isInterrupted()

ModuleEntry[]

listModuleEntries(OrganisationEntry org)

String[]

listModules(String org)

ModuleId[]

listModules(ModuleId criteria, PatternMatcher matcher)

ModuleRevisionId[]

listModules(ModuleRevisionId criteria, PatternMatcher matcher)

OrganisationEntry[]

listOrganisationEntries()

String[]

listOrganisations()

RevisionEntry[]

listRevisionEntries(ModuleEntry module)

String[]

listRevisions(String org, String module)

String[]

listTokenValues(String token, Map<String,Object> otherTokenValues)

Collection<Artifact>

publish(ModuleDescriptor md, DependencyResolver resolver, Collection<String> srcArtifactPattern, String srcIvyPattern, Artifact[] extraArtifacts, boolean overwrite, String conf)

Collection<Artifact>

publish(ModuleRevisionId mrid, String pubrevision, File cache, String srcArtifactPattern, String resolverName, String srcIvyPattern, boolean validate)

Collection<Artifact>

publish(ModuleRevisionId mrid, String pubrevision, File cache, String srcArtifactPattern, String resolverName, String srcIvyPattern, boolean validate, boolean overwrite)

Collection<Artifact>

publish(ModuleRevisionId mrid, String pubrevision, File cache, String srcArtifactPattern, String resolverName, String srcIvyPattern, String status, Date pubdate, Artifact[] extraArtifacts, boolean validate, boolean overwrite, boolean update, String conf)

Collection<Artifact>

publish(ModuleRevisionId mrid, String pubrevision, File cache, Collection<String> srcArtifactPattern, String resolverName, String srcIvyPattern, String status, Date pubdate, Artifact[] extraArtifacts, boolean validate, boolean overwrite, boolean update, String conf)

ResolveReport

resolve(File ivySource)

ResolveReport

resolve(URL ivySource)

ResolveReport

resolve(URL ivySource, String revision, String[] confs, File cache, Date date, boolean validate)

ResolveReport

resolve(URL ivySource, String revision, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly)

ResolveReport

resolve(URL ivySource, String revision, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, boolean transitive, boolean useOrigin, Filter<Artifact> artifactFilter)

ResolveReport

resolve(URL ivySource, String revision, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, boolean transitive, Filter<Artifact> artifactFilter)

ResolveReport

resolve(URL ivySource, String revision, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, Filter<Artifact> artifactFilter)

ResolveReport

resolve(ModuleDescriptor md, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, boolean transitive, boolean useOrigin, boolean download, boolean outputReport, Filter<Artifact> artifactFilter)

ResolveReport

resolve(ModuleDescriptor md, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, boolean transitive, boolean download, boolean outputReport, Filter<Artifact> artifactFilter)

ResolveReport

resolve(ModuleDescriptor md, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, boolean transitive, Filter<Artifact> artifactFilter)

ResolveReport

resolve(ModuleDescriptor md, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, Filter<Artifact> artifactFilter)

ResolveReport

resolve(ModuleRevisionId mrid, String[] confs)

ResolveReport

resolve(ModuleRevisionId mrid, String[] confs, boolean transitive, boolean changing, File cache, Date date, boolean validate, boolean useCacheOnly, boolean useOrigin, Filter<Artifact> artifactFilter)

ResolveReport

resolve(ModuleRevisionId mrid, String[] confs, boolean transitive, boolean changing, File cache, Date date, boolean validate, boolean useCacheOnly, Filter<Artifact> artifactFilter)

int

retrieve(ModuleId moduleId, String[] confs, File cache, String destFilePattern)

int

retrieve(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern)

int

retrieve(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern, Filter<Artifact> artifactFilter)

int

retrieve(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern, Filter<Artifact> artifactFilter, boolean sync, boolean useOrigin)

int

retrieve(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern, Filter<Artifact> artifactFilter, boolean sync, boolean useOrigin, boolean makeSymlinks)

void

setVariable(String varName, String value)

List<ModuleDescriptor>

sortModuleDescriptors(Collection<ModuleDescriptor> moduleDescriptors)

List<IvyNode>

sortNodes(Collection<IvyNode> nodes)

String

substitute(String str)

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

Constructor Details
- Ivy14
  
  public Ivy14()
- Ivy14
  
  public Ivy14(Ivy ivy)
Method Details
- check
  
  public boolean check(URL ivyFile, String resolvername)
- configure
  
  public void configure(File settingsFile) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- configure
  
  public void configure(URL settingsURL) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- configureDefault
  
  public void configureDefault() throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- deliver
  
  public void deliver(ModuleRevisionId mrid, String revision, File cache, String destIvyPattern, String status, Date pubdate, PublishingDependencyRevisionResolver pdrResolver, boolean validate, boolean resolveDynamicRevisions) throws IOException, ParseException
  
  Throws:
  
  IOException
  
  ParseException
- deliver
  
  public void deliver(ModuleRevisionId mrid, String revision, File cache, String destIvyPattern, String status, Date pubdate, PublishingDependencyRevisionResolver pdrResolver, boolean validate) throws IOException, ParseException
  
  Throws:
  
  IOException
  
  ParseException
- determineArtifactsToCopy
  
  public Map<ArtifactDownloadReport,Set<String>> determineArtifactsToCopy(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern, Filter<Artifact> artifactFilter) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- determineArtifactsToCopy
  
  public Map<ArtifactDownloadReport,Set<String>> determineArtifactsToCopy(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- download
  
  public ArtifactDownloadReport download(Artifact artifact, File cache, boolean useOrigin)
- findModule
  
  public ResolvedModuleRevision findModule(ModuleRevisionId id)
- getDependencies
  
  public IvyNode[] getDependencies(ModuleDescriptor md, String[] confs, File cache, Date date, ResolveReport report, boolean validate, boolean transitive)
- getDependencies
  
  public IvyNode[] getDependencies(ModuleDescriptor md, String[] confs, File cache, Date date, ResolveReport report, boolean validate)
- getDependencies
  
  public IvyNode[] getDependencies(URL ivySource, String[] confs, File cache, Date date, boolean validate) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- getVariable
  
  public String getVariable(String name)
- install
  
  public ResolveReport install(ModuleRevisionId mrid, String from, String to, boolean transitive, boolean validate, boolean overwrite, Filter<Artifact> artifactFilter, File cache, String matcherName) throws IOException
  
  Throws:
  
  IOException
- interrupt
  
  public void interrupt()
- interrupt
  
  public void interrupt(Thread operatingThread)
- isInterrupted
  
  public boolean isInterrupted()
- listModuleEntries
  
  public ModuleEntry[] listModuleEntries(OrganisationEntry org)
- listModules
  
  public ModuleId[] listModules(ModuleId criteria, PatternMatcher matcher)
- listModules
  
  public ModuleRevisionId[] listModules(ModuleRevisionId criteria, PatternMatcher matcher)
- listModules
  
  public String[] listModules(String org)
- listOrganisationEntries
  
  public OrganisationEntry[] listOrganisationEntries()
- listOrganisations
  
  public String[] listOrganisations()
- listRevisionEntries
  
  public RevisionEntry[] listRevisionEntries(ModuleEntry module)
- listRevisions
  
  public String[] listRevisions(String org, String module)
- listTokenValues
  
  public String[] listTokenValues(String token, Map<String,Object> otherTokenValues)
- publish
  
  public Collection<Artifact> publish(ModuleDescriptor md, DependencyResolver resolver, Collection<String> srcArtifactPattern, String srcIvyPattern, Artifact[] extraArtifacts, boolean overwrite, String conf) throws IOException
  
  Throws:
  
  IOException
- publish
  
  public Collection<Artifact> publish(ModuleRevisionId mrid, String pubrevision, File cache, Collection<String> srcArtifactPattern, String resolverName, String srcIvyPattern, String status, Date pubdate, Artifact[] extraArtifacts, boolean validate, boolean overwrite, boolean update, String conf) throws IOException
  
  Throws:
  
  IOException
- publish
  
  public Collection<Artifact> publish(ModuleRevisionId mrid, String pubrevision, File cache, String srcArtifactPattern, String resolverName, String srcIvyPattern, boolean validate, boolean overwrite) throws IOException
  
  Throws:
  
  IOException
- publish
  
  public Collection<Artifact> publish(ModuleRevisionId mrid, String pubrevision, File cache, String srcArtifactPattern, String resolverName, String srcIvyPattern, boolean validate) throws IOException
  
  Throws:
  
  IOException
- publish
  
  public Collection<Artifact> publish(ModuleRevisionId mrid, String pubrevision, File cache, String srcArtifactPattern, String resolverName, String srcIvyPattern, String status, Date pubdate, Artifact[] extraArtifacts, boolean validate, boolean overwrite, boolean update, String conf) throws IOException
  
  Throws:
  
  IOException
- resolve
  
  public ResolveReport resolve(File ivySource) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(ModuleDescriptor md, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, boolean transitive, boolean useOrigin, boolean download, boolean outputReport, Filter<Artifact> artifactFilter) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(ModuleDescriptor md, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, boolean transitive, boolean download, boolean outputReport, Filter<Artifact> artifactFilter) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(ModuleDescriptor md, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, boolean transitive, Filter<Artifact> artifactFilter) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(ModuleDescriptor md, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, Filter<Artifact> artifactFilter) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(ModuleRevisionId mrid, String[] confs, boolean transitive, boolean changing, File cache, Date date, boolean validate, boolean useCacheOnly, boolean useOrigin, Filter<Artifact> artifactFilter) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(ModuleRevisionId mrid, String[] confs, boolean transitive, boolean changing, File cache, Date date, boolean validate, boolean useCacheOnly, Filter<Artifact> artifactFilter) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(ModuleRevisionId mrid, String[] confs) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(URL ivySource, String revision, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, boolean transitive, boolean useOrigin, Filter<Artifact> artifactFilter) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(URL ivySource, String revision, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, boolean transitive, Filter<Artifact> artifactFilter) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(URL ivySource, String revision, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly, Filter<Artifact> artifactFilter) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(URL ivySource, String revision, String[] confs, File cache, Date date, boolean validate, boolean useCacheOnly) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(URL ivySource, String revision, String[] confs, File cache, Date date, boolean validate) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- resolve
  
  public ResolveReport resolve(URL ivySource) throws ParseException, IOException
  
  Throws:
  
  ParseException
  
  IOException
- retrieve
  
  public int retrieve(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern, Filter<Artifact> artifactFilter, boolean sync, boolean useOrigin, boolean makeSymlinks)
- retrieve
  
  public int retrieve(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern, Filter<Artifact> artifactFilter, boolean sync, boolean useOrigin)
- retrieve
  
  public int retrieve(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern, Filter<Artifact> artifactFilter)
- retrieve
  
  public int retrieve(ModuleId moduleId, String[] confs, File cache, String destFilePattern, String destIvyPattern)
- retrieve
  
  public int retrieve(ModuleId moduleId, String[] confs, File cache, String destFilePattern)
- setVariable
  
  public void setVariable(String varName, String value)
- sortModuleDescriptors
  
  public List<ModuleDescriptor> sortModuleDescriptors(Collection<ModuleDescriptor> moduleDescriptors)
- sortNodes
  
  public List<IvyNode> sortNodes(Collection<IvyNode> nodes)
- substitute
  
  public String substitute(String str)

Class Ivy14

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Ivy14

Ivy14

Method Details

check

configure

configure

configureDefault

deliver

deliver

determineArtifactsToCopy

determineArtifactsToCopy

download

findModule

getDependencies

getDependencies

getDependencies

getVariable

install

interrupt

interrupt

isInterrupted

listModuleEntries

listModules

listModules

listModules

listOrganisationEntries

listOrganisations

listRevisionEntries

listRevisions

listTokenValues

publish

publish

publish

publish

publish

resolve

resolve

resolve

resolve

resolve

resolve

resolve

resolve

resolve

resolve

resolve

resolve

resolve

resolve

retrieve

retrieve

retrieve

retrieve

retrieve

setVariable

sortModuleDescriptors

sortNodes

substitute