Class BasicResolver

Method Details

• getWorkspaceName

  public String getWorkspaceName()

• setWorkspaceName

  public void setWorkspaceName(String workspaceName)

• isEnvDependent

  public boolean isEnvDependent()

• setEnvDependent

  public void setEnvDependent(boolean envDependent)

• 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

• shouldReturnResolvedModule

  protected boolean shouldReturnResolvedModule(DependencyDescriptor dd, ResolvedModuleRevision mr)

• checkModuleDescriptorRevision

  protected void checkModuleDescriptorRevision(ModuleDescriptor systemMd, ModuleRevisionId systemMrid)

• parse

  public ResolvedModuleRevision parse(ResolvedResource mdRef, DependencyDescriptor dd, ResolveData data) throws ParseException

  Throws:

  ParseException

• getRMDParser

  protected ResourceMDParser getRMDParser(DependencyDescriptor dd, ResolveData data)

• getDefaultRMDParser

  protected ResourceMDParser getDefaultRMDParser(ModuleId mid)

• findResource

  public ResolvedResource findResource(ResolvedResource[] rress, ResourceMDParser rmdparser, ModuleRevisionId mrid, Date date)

  When the resolver has many choices, this function helps choosing one

  Parameters:

  rress - the list of resolved resource which the resolver found to fit the requirement

  rmdparser - the parser of module descriptor

  mrid - the module being resolved

  date - the current date

  Returns:

  the selected resource

• filterNames

  protected Collection<String> filterNames(Collection<String> names)

  Filters names before returning them in the findXXXNames or findTokenValues method.

  Remember to call the super implementation when overriding this method.

  Parameters:

  names - the list to filter.

  Returns:

  the filtered list

• clearIvyAttempts

  protected void clearIvyAttempts()

• logIvyAttempt

  protected void logIvyAttempt(String attempt)

• logArtifactAttempt

  protected void logArtifactAttempt(Artifact art, String attempt)

• logAttempt

  protected void logAttempt(String attempt)

• 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

• acceptLatest

  protected boolean acceptLatest()

• 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.

• clearArtifactAttempts

  protected void clearArtifactAttempts()

• download

  public ArtifactDownloadReport download(ArtifactOrigin origin, 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:

  origin - ArtifactOrigin

  options - DownloadOptions

  Returns:

  ArtifactDownloadReport

• getResource

  protected abstract Resource getResource(String source) throws IOException

  Throws:

  IOException

• 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

• getPublicationDate

  protected long getPublicationDate(ModuleDescriptor md, DependencyDescriptor dd, ResolveData data)

• toString

  public String toString()

  Overrides:

  toString in class AbstractResolver

• listTokenValues

  public String[] listTokenValues(String token, Map<String,String> otherTokenValues)

  Description copied from interface: DependencyResolver

  List all the values the given token can take if other tokens are set as described in the otherTokenValues map. For instance, if token = "revision" and the map contains "organisation"->"foo" "module"->"bar" The results will be the list of revisions of the module bar from the org foo.

  Note that listing does not take into account namespaces, and return raw information without any namespace transformation. The caller is responsible for calling namespace transformation with the Namespace returned by DependencyResolver.getNamespace().

  Specified by:

  listTokenValues in interface DependencyResolver

  Overrides:

  listTokenValues in class AbstractResolver

  Parameters:

  token - String

  otherTokenValues - Map

  Returns:

  String[]

• listOrganisations

  public OrganisationEntry[] listOrganisations()

  Specified by:

  listOrganisations in interface DependencyResolver

  Overrides:

  listOrganisations in class AbstractResolver

• listModules

  public ModuleEntry[] listModules(OrganisationEntry org)

  Specified by:

  listModules in interface DependencyResolver

  Overrides:

  listModules in class AbstractResolver

• listRevisions

  public RevisionEntry[] listRevisions(ModuleEntry mod)

  Specified by:

  listRevisions in interface DependencyResolver

  Overrides:

  listRevisions in class AbstractResolver

• findNames

  protected abstract Collection<String> findNames(Map<String,String> tokenValues, String token)

• findFirstArtifactRef

  protected ResolvedResource findFirstArtifactRef(ModuleDescriptor md, DependencyDescriptor dd, ResolveData data)

• getAndCheck

  protected long getAndCheck(Resource resource, File dest) throws IOException

  Throws:

  IOException

• getArtifactRef

  protected ResolvedResource getArtifactRef(Artifact artifact, Date date)

• doFindArtifactRef

  public ResolvedResource doFindArtifactRef(Artifact artifact, Date date)

• findArtifactRef

  protected abstract ResolvedResource findArtifactRef(Artifact artifact, Date date)

• get

  protected abstract long get(Resource resource, File dest) throws IOException

  Throws:

  IOException

• isCheckconsistency

  public boolean isCheckconsistency()

• setCheckconsistency

  public void setCheckconsistency(boolean checkConsistency)

• setForce

  public void setForce(boolean force)

• isForce

  public boolean isForce()

• isAllownomd

  public boolean isAllownomd()

• setAllownomd

  public void setAllownomd(boolean b)

• 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.

• getChecksumAlgorithms

  public String[] getChecksumAlgorithms()

• setChecksums

  public void setChecksums(String checksums)