Griffon 1.2.0

org.codehaus.griffon.resolve
[Groovy] Class IvyDependencyManager

java.lang.Object
  org.codehaus.griffon.resolve.AbstractIvyDependencyManager
      org.codehaus.griffon.resolve.IvyDependencyManager
All Implemented Interfaces:
DependencyDefinitionParser, DependencyResolver

class IvyDependencyManager
extends AbstractIvyDependencyManager

Implementation that uses Apache Ivy under the hood.

Authors:
Graeme Rocher (Grails 1.2)


Field Summary
 
Fields inherited from class AbstractIvyDependencyManager
ALL_CONFIGURATIONS, BUILD_CONFIGURATION, COMPILE_CONFIGURATION, DOCS_CONFIGURATION, RUNTIME_CONFIGURATION, SNAPSHOT_CHANGING_PATTERN, TEST_CONFIGURATION, applicationName, applicationVersion, buildSettings, chainResolver, configurationMappings, configurationNames, dependencies, dependencyDescriptors, hasApplicationDependencies, includeJavadoc, includeSource, ivySettings, metadata, metadataRegisteredPluginNames, moduleDescriptor, modules, orgToDepMap, pluginDependencyDescriptors, pluginNameToDescriptorMap, readPom, usedConfigurations
 
Property Summary
boolean defaultDependenciesProvided

boolean inheritRepositories

boolean inheritsAll

MessageLogger logger

Collection moduleExcludes

boolean pluginsOnly

Collection repositoryData

ResolveEngine resolveEngine

boolean resolveErrors

TransferListener transferListener

 
Constructor Summary
IvyDependencyManager(String applicationName, String applicationVersion, BuildSettings settings = null, Metadata metadata = null, IvySettings ivySettings = new IvySettings()

Creates a new IvyDependencyManager instance

 
Method Summary
IvyDependencyManager createCopy(BuildSettings buildSettings)

Set getApplicationDependencyDescriptors(String scope = null)

Returns all of the dependency descriptors for dependencies of the application and not those inherited from frameworks or plugins

Set getApplicationPluginDependencyDescriptors(String scope = null)

Returns all of the dependency descriptors for dependencies of the application and not those inherited from frameworks or plugins

Set getEffectivePluginDependencyDescriptors()

The plugin dependencies excluding non-exported transitive deps and collapsed to the highest version of each dependency.

Set getExportedDependencyDescriptors(String scope = null)

Returns all the dependency descriptors for dependencies of a plugin that have been exported for use in the application

MessageLogger getLogger()

Set getModuleRevisionIds(String org)

boolean isExcluded(String name)

boolean isPluginConfiguredByApplication(String name)

IvyNode[] listDependencies(String conf = null)

Lists all known dependencies for the given configuration name (defaults to all dependencies)

ResolveReport loadDependencies(String conf = '')

Similar to resolveDependencies, but will load the resolved dependencies into the application RootLoader if it exists

void resetGriffonPluginsResolver()

Resets the Griffon plugin resolver if it is used

ResolveReport resolveAllDependencies()

Resolves all dependencies for all known configurations

List resolveApplicationDependencies(String conf = '')

Resolves only application dependencies and returns a list of the resolves JAR files

ResolveReport resolveDependencies(Configuration conf)

ResolveReport resolveDependencies(String conf)

Performs a resolve of all dependencies for the given configuration, potentially going out to the internet to download jars if they are not found locally

ResolveReport resolveDependencies(String conf, Map args)

Performs a resolve of all dependencies for the given configuration, potentially going out to the internet to download jars if they are not found locally

ResolveReport resolveDependencies()

Performs a resolve of all dependencies, potentially going out to the internet to download jars if they are not found locally

List resolveExportedDependencies(String conf = '')

Resolves only plugin dependencies that should be exported to the application

ResolveReport resolvePluginDependencies(String conf = '', Map args = [:])

Performs a resolve of declared plugin dependencies (zip files containing plugin distributions)

void serialize(def builder, boolean createRoot = true)

Serializes the parsed dependencies using the given builder.

private def serializeDependencies(def builder)

private def serializeResolvers(def builder)

void setChainResolver(ChainResolver resolver)

Allows settings an alternative chain resolver to be used

void setLogger(MessageLogger logger)

Sets the default message logger used by Ivy

 
Methods inherited from class AbstractIvyDependencyManager
addDefaultModuleConfigurations, addMetadataPluginDependencies, createExcludeArtifactId, createExcludeArtifactId, createModuleDescriptor, doParseDependencies, getApplicationName, getApplicationVersion, getBuildSettings, getChainResolver, getConfigurationMappings, getConfigurationNames, getDeclaredPluginDependencyDescriptors, getDependencies, getDependencyDescriptors, getIvySettings, getMetadata, getMetadataRegisteredPluginNames, getModuleDescriptor, getPluginDependencyDescriptor, getPluginDependencyDescriptors, getPluginDependencyNames, getPluginExcludes, getReadPom, getUsedConfigurations, hasApplicationDependencies, hasDependency, hasDependency, isCompileOrRuntimeScope, isExcludedFromPlugin, isExcludedFromPlugin, isExposedByThisPlugin, isOffline, isPluginTransitive, isPluginTransitivelyIncluded, parseDependencies, parseDependencies, readDependenciesFromPOM, registerDependency, registerDependencyCommon, registerPluginDependency, registerPomDependencies, registerPomDependency, registerUsedConfigurationIfNecessary, setApplicationName, setApplicationVersion, setChainResolver, setIncludeJavadoc, setIncludeSource, setMetadataRegisteredPluginNames, setModuleDescriptor, setReadPom, setUsedConfigurations, shouldIncludeDependency, updateChangingPattern
 

Property Detail

defaultDependenciesProvided

boolean defaultDependenciesProvided


inheritRepositories

boolean inheritRepositories


inheritsAll

boolean inheritsAll


logger

MessageLogger logger


moduleExcludes

Collection moduleExcludes


pluginsOnly

boolean pluginsOnly


repositoryData

Collection repositoryData


resolveEngine

ResolveEngine resolveEngine


resolveErrors

boolean resolveErrors


transferListener

TransferListener transferListener


 
Constructor Detail

IvyDependencyManager

IvyDependencyManager(String applicationName, String applicationVersion, BuildSettings settings = null, Metadata metadata = null, IvySettings ivySettings = new IvySettings()
Creates a new IvyDependencyManager instance


 
Method Detail

createCopy

IvyDependencyManager createCopy(BuildSettings buildSettings)


getApplicationDependencyDescriptors

Set getApplicationDependencyDescriptors(String scope = null)
Returns all of the dependency descriptors for dependencies of the application and not those inherited from frameworks or plugins


getApplicationPluginDependencyDescriptors

Set getApplicationPluginDependencyDescriptors(String scope = null)
Returns all of the dependency descriptors for dependencies of the application and not those inherited from frameworks or plugins


getEffectivePluginDependencyDescriptors

Set getEffectivePluginDependencyDescriptors()
The plugin dependencies excluding non-exported transitive deps and collapsed to the highest version of each dependency.


getExportedDependencyDescriptors

Set getExportedDependencyDescriptors(String scope = null)
Returns all the dependency descriptors for dependencies of a plugin that have been exported for use in the application


getLogger

MessageLogger getLogger()


getModuleRevisionIds

Set getModuleRevisionIds(String org)


isExcluded

boolean isExcluded(String name)


isPluginConfiguredByApplication

boolean isPluginConfiguredByApplication(String name)


listDependencies

IvyNode[] listDependencies(String conf = null)
Lists all known dependencies for the given configuration name (defaults to all dependencies)


loadDependencies

ResolveReport loadDependencies(String conf = '')
Similar to resolveDependencies, but will load the resolved dependencies into the application RootLoader if it exists
throws:
IllegalStateException If no RootLoader exists
Returns:
The ResolveReport


resetGriffonPluginsResolver

void resetGriffonPluginsResolver()
Resets the Griffon plugin resolver if it is used


resolveAllDependencies

ResolveReport resolveAllDependencies()
Resolves all dependencies for all known configurations
Returns:
A ResolveReport containing all of the configurations


resolveApplicationDependencies

List resolveApplicationDependencies(String conf = '')
Resolves only application dependencies and returns a list of the resolves JAR files


resolveDependencies

ResolveReport resolveDependencies(Configuration conf)


resolveDependencies

ResolveReport resolveDependencies(String conf)
Performs a resolve of all dependencies for the given configuration, potentially going out to the internet to download jars if they are not found locally


resolveDependencies

ResolveReport resolveDependencies(String conf, Map args)
Performs a resolve of all dependencies for the given configuration, potentially going out to the internet to download jars if they are not found locally


resolveDependencies

ResolveReport resolveDependencies()
Performs a resolve of all dependencies, potentially going out to the internet to download jars if they are not found locally


resolveExportedDependencies

List resolveExportedDependencies(String conf = '')
Resolves only plugin dependencies that should be exported to the application


resolvePluginDependencies

ResolveReport resolvePluginDependencies(String conf = '', Map args = [:])
Performs a resolve of declared plugin dependencies (zip files containing plugin distributions)


serialize

void serialize(def builder, boolean createRoot = true)
Serializes the parsed dependencies using the given builder.
deprecated:
Will be removed in a future release
Parameters:
builder - A builder such as groovy.xml.MarkupBuilder


serializeDependencies

private def serializeDependencies(def builder)


serializeResolvers

private def serializeResolvers(def builder)


setChainResolver

void setChainResolver(ChainResolver resolver)
Allows settings an alternative chain resolver to be used
Parameters:
resolver - The resolver to be used


setLogger

void setLogger(MessageLogger logger)
Sets the default message logger used by Ivy
Parameters:
logger


 

Groovy Documentation