org.apache.ivy.plugins.resolver
public interface DependencyResolver
Method Summary | |
---|---|
void | abortPublishTransaction() |
void | beginPublishTransaction(ModuleRevisionId module, boolean overwrite) |
void | commitPublishTransaction() |
DownloadReport | download(Artifact[] artifacts, DownloadOptions options)
Download artifacts with specified DownloadOptions.
|
ArtifactDownloadReport | download(ArtifactOrigin artifact, DownloadOptions options)
Download an artifact according to the given 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.
|
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. a revision uniquely identifying the revision of a module in the current
environment - If this revision is not able to identify uniquelely the revision of the module
outside of the current environment, then the resolved revision must begin by ##)
|
String | getName() |
Namespace | getNamespace()
Returns the namespace associated with this resolver. |
RepositoryCacheManager | getRepositoryCacheManager()
Returns the RepositoryCacheManager used to manage the repository cache associated
with this dependency resolver.
|
ModuleEntry[] | listModules(OrganisationEntry org) |
OrganisationEntry[] | listOrganisations() |
RevisionEntry[] | listRevisions(ModuleEntry module) |
String[] | listTokenValues(String token, Map otherTokenValues)
List all the values the given token can take if other tokens are set as described in the
otherTokenValues map. |
Map[] | listTokenValues(String[] tokens, Map criteria)
Same as DependencyResolver but more generic.
|
ArtifactOrigin | locate(Artifact artifact)
Locates the given artifact and returns its location if it can be located by this resolver and
if it actually exists, or null in other cases.
|
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 | setName(String name)
Should only be used by configurator
|
void | setSettings(ResolverSettings settings) |
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.
This methods is an alternative to (Artifact[], DownloadOptions)
, which
locates and downloads a set of artifacts. This method uses an ArtifactOrigin, and as
such is only used to materialize an already located Artifact.
Parameters: artifact
the location of the artifact to download. Must not be null
. options
options to apply for this download. Must not be null
.
Returns: a report detailing how the download has gone, is never null
.
true
if the given artifact can be located by this resolver and
actually exist.
Parameters: artifact the artifact which should be tested.
Returns: true
if the given artifact can be located by this resolver and
actually exist.
Parameters: dd the dependency descriptor data the resolve data
Returns: the module descriptor, or null
Throws: ParseException
Returns: the namespace associated with this resolver.
Returns: the RepositoryCacheManager used to manage the repository cache associated with this dependency resolver.
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 getNamespace.
Parameters: tokens the tokens of the query criteria the token which have values
Returns: the list of token values (Mapnull
null
in other cases.
Parameters: artifact the artifact which should be located
Returns: the artifact location, or null
if it can't be located by this resolver
or doesn't exist.
Parameters: art
Parameters: name the new name of the resolver