org.kuali.rice.kew.plugin
Class BasePluginLoader

java.lang.Object
  org.kuali.rice.kew.plugin.BasePluginLoader

All Implemented Interfaces:

Modifiable, PluginLoader

Direct Known Subclasses:

ZipFilePluginLoader

public abstract class BasePluginLoader
extends java.lang.Object
implements PluginLoader

Abstract base PluginLoader implementation. Delegates to template methods to obtain plugin ClassLoader and plugin config file URL, then load the config under the plugin ClassLoader, and constructs a Plugin object.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

protected java.lang.String	logPrefix
protected java.lang.ClassLoader	parentClassLoader
protected org.kuali.rice.core.config.Config	parentConfig
protected java.lang.String	pluginConfigPath
protected java.io.File	sharedPluginDirectory
protected java.lang.String	simplePluginName

Constructor Summary

BasePluginLoader(java.lang.String simplePluginName, java.io.File sharedPluginDirectory, java.lang.ClassLoader parentClassLoader, org.kuali.rice.core.config.Config parentConfig)

Method Summary

protected void	configureExtraClasspath(PluginClassLoader classLoader, PluginConfig config)
protected abstract PluginClassLoader	createPluginClassLoader() Template method that subclasses should implement to supply an appropriate plugin ClassLoader
protected java.lang.String	getLogPrefix()
protected abstract java.net.URL	getPluginConfigURL() Template method that subclasses should implement to supply an appropriate URL to the plugin's configuration
java.lang.String	getPluginName()
protected javax.xml.namespace.QName	getPluginName(PluginConfig pluginConfig)
protected java.lang.String	getSimplePluginName()
protected void	installPluginListeners(Plugin plugin)
protected void	installResourceLoader(Plugin plugin)
boolean	isRemoved() Returns true if the Plugin loaded by this loader has been removed (for example, it was deleted from the file system which should result in the plugin being undeployed).
Plugin	load() Loads and creates the Plugin.
protected PluginConfig	loadPluginConfig(java.net.URL url)
protected Plugin	loadWithinContextClassLoader(PluginClassLoader classLoader) Executes loading of the plugin within the current context classloader set to the Plugin's classloader.
void	setPluginConfigPath(java.lang.String pluginConfigPath)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.kew.plugin.Modifiable

isModified

Field Detail

simplePluginName

protected final java.lang.String simplePluginName

logPrefix

protected java.lang.String logPrefix

parentClassLoader

protected final java.lang.ClassLoader parentClassLoader

parentConfig

protected final org.kuali.rice.core.config.Config parentConfig

sharedPluginDirectory

protected final java.io.File sharedPluginDirectory

pluginConfigPath

protected java.lang.String pluginConfigPath

Constructor Detail

BasePluginLoader

public BasePluginLoader(java.lang.String simplePluginName,
                        java.io.File sharedPluginDirectory,
                        java.lang.ClassLoader parentClassLoader,
                        org.kuali.rice.core.config.Config parentConfig)

Method Detail

getLogPrefix

protected java.lang.String getLogPrefix()

getPluginName

public java.lang.String getPluginName()

Specified by:

getPluginName in interface PluginLoader

setPluginConfigPath

public void setPluginConfigPath(java.lang.String pluginConfigPath)

Specified by:

setPluginConfigPath in interface PluginLoader

getSimplePluginName

protected java.lang.String getSimplePluginName()

createPluginClassLoader

protected abstract PluginClassLoader createPluginClassLoader()
                                                      throws java.io.IOException

Template method that subclasses should implement to supply an appropriate plugin ClassLoader

Returns:

an appropriate PluginClassLoader

Throws:

java.io.IOException - if anything goes awry

getPluginConfigURL

protected abstract java.net.URL getPluginConfigURL()
                                            throws PluginException,
                                                   java.io.IOException

Template method that subclasses should implement to supply an appropriate URL to the plugin's configuration

Returns:

an appropriate URL to the plugin's configuration

Throws:

java.io.IOException - if anything goes awry

PluginException

load

public Plugin load()
            throws java.lang.Exception

Loads and creates the Plugin.

Specified by:

load in interface PluginLoader

Throws:

java.lang.Exception

isRemoved

public boolean isRemoved()

Description copied from interface: PluginLoader

Returns true if the Plugin loaded by this loader has been removed (for example, it was deleted from the file system which should result in the plugin being undeployed).

Specified by:

isRemoved in interface PluginLoader

loadWithinContextClassLoader

protected Plugin loadWithinContextClassLoader(PluginClassLoader classLoader)
                                       throws PluginException,
                                              java.io.IOException

Executes loading of the plugin within the current context classloader set to the Plugin's classloader.

Throws:

PluginException

java.io.IOException

installResourceLoader

protected void installResourceLoader(Plugin plugin)

installPluginListeners

protected void installPluginListeners(Plugin plugin)

configureExtraClasspath

protected void configureExtraClasspath(PluginClassLoader classLoader,
                                       PluginConfig config)
                                throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

getPluginName

protected javax.xml.namespace.QName getPluginName(PluginConfig pluginConfig)

loadPluginConfig

protected PluginConfig loadPluginConfig(java.net.URL url)