org.codehaus.groovy.grails.resolve

Interface DependencyManager

public interface DependencyManager

General interface for all dependency manager implementations to implement with common utility methods not tied to Ivy or Aether or any dependency resolution engine

Since:

2.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GRAILS_CENTRAL_PLUGIN_LIST URL to the central Grails plugin repository's global plugin list

Method Summary

Methods

Modifier and Type	Method and Description
DependencyManager	createCopy(grails.util.BuildSettings buildSettings) Creates a copy of this dependency manager with repository configuration retained but dependencies omitted.
groovy.util.slurpersupport.GPathResult	downloadPluginInfo(java.lang.String pluginName, java.lang.String pluginVersion) Downloads information about a plugin from the -plugin.xml file
groovy.util.slurpersupport.GPathResult	downloadPluginList(java.io.File localFile) Downloads the Grails central plugin list and saves it to the given file.
java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency>	getAllDependencies() All dependencies of the current application
java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency>	getAllDependencies(java.lang.String scope) All dependencies of the current application
java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency>	getApplicationDependencies() The direct dependencies of the application, not including framework or dependencies inherited from plugins
java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency>	getApplicationDependencies(java.lang.String scope) The direct dependencies of the application, not including framework or dependencies inherited from plugins
org.codehaus.groovy.grails.resolve.ExcludeResolver	getExcludeResolver()
java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency>	getPluginDependencies()
java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency>	getPluginDependencies(java.lang.String scope) The direct plugin dependencies of the application, not including framework or dependencies inherited from plugins
void	parseDependencies(groovy.lang.Closure callable) Parse the dependency definition DSL
void	produceReport() Outputs the dependency graph to System.out
void	produceReport(java.lang.String scope) Outputs the dependency graph to System.out
DependencyReport	resolve() Resolve dependencies for the default scope
DependencyReport	resolve(java.lang.String scope) Resolve dependencies for the given scope
DependencyReport	resolveAgent() Resolve the JVM agent to be used for the forked JVM
DependencyReport	resolveDependency(org.codehaus.groovy.grails.resolve.Dependency dependency) Resolves a single dependency.

Field Detail

GRAILS_CENTRAL_PLUGIN_LIST

static final java.lang.String GRAILS_CENTRAL_PLUGIN_LIST

URL to the central Grails plugin repository's global plugin list

See Also:

Constant Field Values

Method Detail

downloadPluginList

groovy.util.slurpersupport.GPathResult downloadPluginList(java.io.File localFile)

Downloads the Grails central plugin list and saves it to the given file. The file is then parsed and the resulting XML returned

Parameters:

localFile - The local file

Returns:

The parsed XML

downloadPluginInfo

groovy.util.slurpersupport.GPathResult downloadPluginInfo(java.lang.String pluginName,
                                                        java.lang.String pluginVersion)

Downloads information about a plugin from the -plugin.xml file

Parameters:

pluginName - The plugin name

pluginVersion - The plugin version

Returns:

The plugin.xml data or null if the plugin doesn't exit

produceReport

void produceReport()

Outputs the dependency graph to System.out

produceReport

void produceReport(java.lang.String scope)

Outputs the dependency graph to System.out

Parameters:

scope - The scope of the report

createCopy

DependencyManager createCopy(grails.util.BuildSettings buildSettings)

Creates a copy of this dependency manager with repository configuration retained but dependencies omitted.

Parameters:

buildSettings - The BuildSettings

Returns:

The copy

resolve

DependencyReport resolve(java.lang.String scope)

Resolve dependencies for the given scope

Parameters:

scope - The scope

Returns:

The DependencyReport instance

resolveAgent

DependencyReport resolveAgent()

Resolve the JVM agent to be used for the forked JVM

Returns:

The DependencyReport instance or null if no agent configured

resolve

DependencyReport resolve()

Resolve dependencies for the default scope

Returns:

The DependencyReport instance

resolveDependency

DependencyReport resolveDependency(org.codehaus.groovy.grails.resolve.Dependency dependency)

Resolves a single dependency.

Parameters:

dependency - A Dependency instance.

Returns:

The DependencyReport instance for the given dependency

getApplicationDependencies

java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency> getApplicationDependencies()

The direct dependencies of the application, not including framework or dependencies inherited from plugins

Returns:

Direct application dependencies

getPluginDependencies

java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency> getPluginDependencies()

Returns:

The plugin dependencies of the application

getAllDependencies

java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency> getAllDependencies()

All dependencies of the current application

Returns:

All application dependencies

getApplicationDependencies

java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency> getApplicationDependencies(java.lang.String scope)

The direct dependencies of the application, not including framework or dependencies inherited from plugins

Parameters:

scope - The scope of the dependencies

Returns:

Direct application dependencies

getPluginDependencies

java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency> getPluginDependencies(java.lang.String scope)

The direct plugin dependencies of the application, not including framework or dependencies inherited from plugins

Parameters:

scope - The scope of the dependencies

Returns:

Direct application dependencies

getAllDependencies

java.util.Collection<org.codehaus.groovy.grails.resolve.Dependency> getAllDependencies(java.lang.String scope)

All dependencies of the current application

Parameters:

scope - The scope of the dependencies

Returns:

All application dependencies

getExcludeResolver

org.codehaus.groovy.grails.resolve.ExcludeResolver getExcludeResolver()

Returns:

Returns the exclude resolver for this dependency manager

parseDependencies

void parseDependencies(groovy.lang.Closure callable)

Parse the dependency definition DSL

Parameters:

callable - The DSL definition