Manages the installation and uninstallation of plugins from a Grails project.
Modifiers | Name | Description |
---|---|---|
protected java.lang.Object |
ant |
|
protected java.lang.Object |
applicationPluginsLocation |
|
protected Metadata |
metadata |
|
protected PluginBuildSettings |
pluginSettings |
|
protected PluginResolveEngine |
resolveEngine |
|
protected BuildSettings |
settings |
Type | Name and description |
---|---|
static java.util.List |
CORE_PLUGINS |
groovy.lang.Closure |
errorHandler |
groovy.lang.Closure |
eventHandler |
java.util.List |
installedPlugins plugins that were installed in the last execution of installPlugin |
boolean |
isInteractive |
java.lang.Object |
pluginDirVariableStore |
groovy.lang.Closure |
pluginScriptRunner |
groovy.lang.Closure |
postInstallEvent |
groovy.lang.Closure |
postUninstallEvent |
Constructor and description |
---|
PluginInstallEngine
(BuildSettings settings, PluginBuildSettings pbs = GrailsPluginUtils.getPluginBuildSettings(settings, Metadata md = Metadata.getCurrent(, groovy.util.AntBuilder ant = new AntBuilder() |
Type Params | Return Type | Name and description |
---|---|---|
|
protected void |
assertNoExistingInlinePlugin(java.lang.String name) |
|
protected boolean |
checkExistingPluginInstall(java.lang.String name, java.lang.Object version, java.io.File pluginZip, boolean isResolve = true) Checks an existing plugin path to install and returns true if the installation should be aborted or false if it should continue |
|
void |
checkPluginsToUninstall() |
|
void |
checkPluginsToUninstall(java.util.List<java.io.File> pluginZips) |
|
boolean |
installPlugin(java.lang.String name, java.lang.String version = null) Installs a plugin for the given name and optional version. |
|
boolean |
installPlugin(java.io.File zipFile, boolean overwrite = false) Installs a plugin from the given ZIP file |
|
boolean |
installPlugin(java.net.URL zipURL) Installs a plugin from the given URL |
|
protected boolean |
installPluginZipInternal(java.lang.String name, java.lang.String version, java.io.File pluginZip, boolean overwrite = false, boolean isResolve = false) |
|
protected boolean |
installResolvePlugins(java.util.Collection<java.io.File> pluginZips) |
|
boolean |
installResolvedPlugin(java.io.File zipFile) Installs a plugin from the given ZIP file. |
|
boolean |
installedResolvedPlugins() |
|
boolean |
isNotInlinePluginLocation(java.io.File pluginDir) Check to see if the plugin directory is in plugins home. |
|
protected java.lang.Object |
postInstall(java.lang.String pluginInstallPath) |
|
protected java.lang.Object |
postUninstall() |
|
java.util.List |
readMetadataFromZip(java.lang.String zipLocation) Reads plugin metadata from a plugin zip file and returns a list containing the plugin name, version and XML metadata. |
|
GrailsPluginInfo |
readPluginInfoFromZip(java.lang.String zipLocation) Reads plugin info from the zip file location |
|
boolean |
resolveAndInstallDepdendencies() |
|
void |
uninstallPlugin(java.lang.String name, java.lang.String version = null) Uninstalls a plugin for the given name and optional version |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
plugins that were installed in the last execution of installPlugin
Checks an existing plugin path to install and returns true if the installation should be aborted or false if it should continue If an error occurs the errorHandler is invoked.
name
- The plugin nameversion
- The plugin versionInstalls a plugin for the given name and optional version.
name
- The plugin nameversion
- The plugin version (optional)Installs a plugin from the given ZIP file
zipFile
- The plugin zip fileInstalls a plugin from the given URL
zipURL
- The zip URLInstalls a plugin from the given ZIP file. Differs from #installPlugin(zipFile) in that the plugin to be installed is assumed to already be resolved and hence not placed in the users local cache
zipFile
- The plugin zip fileCheck to see if the plugin directory is in plugins home.
Reads plugin metadata from a plugin zip file and returns a list containing the plugin name, version and XML metadata. Designed for use with Groovy's multiple assignment operator
zipLocation
- The zip locationReads plugin info from the zip file location
zipLocation
- The zip locationUninstalls a plugin for the given name and optional version
name
- The plugin nameversion
- The versionGroovy Documentation