org.kuali.rice.kew.plugin

Class Plugin

java.lang.Object

org.kuali.rice.core.api.lifecycle.BaseLifecycle

org.kuali.rice.core.api.resourceloader.ResourceLoaderContainer

org.kuali.rice.core.framework.resourceloader.BaseResourceLoader

org.kuali.rice.core.impl.resourceloader.BaseWrappingResourceLoader

org.kuali.rice.kew.plugin.Plugin

All Implemented Interfaces:

Lifecycle, ObjectLoader, ResourceLoader, ServiceLocator

public class Plugin
extends BaseWrappingResourceLoader

A KEW Plugin. A Plugin represents a distinct classloading space living below (as a child) of the core KEW classloader. It allows for loading of plugin resources from core components of the system. Essentially a Plugin is a specialized ResourceLoader with a custom classloader and attached configuration.

Author:

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

Field Summary

Fields inherited from interface org.kuali.rice.core.api.resourceloader.ResourceLoader

EMBEDDED_CLIENT_APP_RESOURCE_LOADER, EMBEDDED_PLUGIN, KSB_CONFIGURER_CONTAINER_NAME, PLUGIN_REGISTRY_LOADER_NAME, RMI_PLUGIN, ROOT_RESOURCE_LOADER_NAME, WEB_SERVICE_PLUGIN

Constructor Summary

Constructors

Constructor and Description
Plugin(QName name, Config config, ClassLoader classLoader)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPluginListener(PluginListener pluginListener)
Config	getConfig()
boolean	isStarted()
boolean	isSuppressStartupFailure()
void	removePluginListener(PluginListener pluginListener)
void	setSuppressStartupFailure(boolean suppressStartupFailure)
void	start() Starts the plugin.
protected void	startPluginListeners()
void	stop() Stops the plugin.
protected void	stopPluginListeners() If we fail to stop a plugin listener, try the next one but don't propogate any exceptions out of this method.
String	toString()

Methods inherited from class org.kuali.rice.core.impl.resourceloader.BaseWrappingResourceLoader

cacheService, getPackageNamesToFilter, getService, postProcessObject, postProcessService, shouldCacheService, shouldWrapObject, shouldWrapService

Methods inherited from class org.kuali.rice.core.framework.resourceloader.BaseResourceLoader

getClassLoader, getContents, getObject, getServiceLocator, isPostProcessContainer, setClassLoader, setPostProcessContainer

Methods inherited from class org.kuali.rice.core.api.resourceloader.ResourceLoaderContainer

addResourceLoader, addResourceLoaderFirst, containsResourceLoader, getName, getResourceLoader, getResourceLoaderNames, getResourceLoaders, removeAllResourceLoaders, removeResourceLoader, setName

Methods inherited from class org.kuali.rice.core.api.lifecycle.BaseLifecycle

setStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.core.api.resourceloader.ResourceLoader

addResourceLoader, addResourceLoaderFirst, getName, getResourceLoader, getResourceLoaderNames, getResourceLoaders, removeResourceLoader, setName

Constructor Detail

Plugin

public Plugin(QName name,
      Config config,
      ClassLoader classLoader)

Method Detail

start

public void start()

Starts the plugin.

Specified by:

start in interface Lifecycle

Overrides:

start in class BaseWrappingResourceLoader

stop

public void stop()

Stops the plugin.

Specified by:

stop in interface Lifecycle

Overrides:

stop in class BaseResourceLoader

isStarted

public boolean isStarted()

Specified by:

isStarted in interface Lifecycle

Overrides:

isStarted in class BaseLifecycle

addPluginListener

public void addPluginListener(PluginListener pluginListener)

removePluginListener

public void removePluginListener(PluginListener pluginListener)

startPluginListeners

protected void startPluginListeners()

stopPluginListeners

protected void stopPluginListeners()

If we fail to stop a plugin listener, try the next one but don't propogate any exceptions out of this method. Otherwise the plugin ends up dying and can't be reloaded from a hot deploy.

isSuppressStartupFailure

public boolean isSuppressStartupFailure()

setSuppressStartupFailure

public void setSuppressStartupFailure(boolean suppressStartupFailure)

getConfig

public Config getConfig()

toString

public String toString()

Overrides:

toString in class ResourceLoaderContainer