org.springframework.extensions.webeditor

Class WEFPluginRegistry

java.lang.Object

org.springframework.extensions.webeditor.WEFPluginRegistry

public class WEFPluginRegistry
extends Object

Registry of Web Editor Framework plugins.

Author:

Gavin Cornwell

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEAN_NAME

Constructor Summary

Constructors

Constructor and Description
WEFPluginRegistry() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPlugin(WEFPlugin plugin) Adds a plugin.
protected void	buildResourceMap(WEFResource resource, Map<String,WEFResource> resources) Recursively builds a Map of unique resources for the given resource object.
List<WEFResource>	getAllResources(WEFResource resource) Returns a list of unique resources for the given resource and all of it's dependencies.
WEFApplication	getApplication(String name) Returns the application plugin with the given name.
List<WEFApplication>	getApplications() Returns all the registered application plugins.
WEFPlugin	getPlugin(String name) Returns the plugin with the given name.
List<WEFResource>	getPluginResources() Returns a list of unique resources for all the registered plugins and their dependencies.
List<WEFPlugin>	getPlugins() Returns all the regsistered plugins.

Methods inherited from class java.lang.Object

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

Field Detail

BEAN_NAME

public static final String BEAN_NAME

See Also:

Constant Field Values

Constructor Detail

WEFPluginRegistry

public WEFPluginRegistry()

Default constructor.

Method Detail

addPlugin

public void addPlugin(WEFPlugin plugin)

Adds a plugin.

Parameters:

plugin - The plugin to add

getPlugins

public List<WEFPlugin> getPlugins()

Returns all the regsistered plugins.

Returns:

List of all registered plugins

getPlugin

public WEFPlugin getPlugin(String name)

Returns the plugin with the given name.

Parameters:

name - Name of a plugin to retrieve

Returns:

A WEFPlugin object or null if a plugin with the given name does not exist

getApplications

public List<WEFApplication> getApplications()

Returns all the registered application plugins.

Returns:

List of all registered application plugins

getApplication

public WEFApplication getApplication(String name)

Returns the application plugin with the given name.

Parameters:

name - Name of an application plugin to retrieve

Returns:

A WEFApplication object or null if an application plugin with the given name does not exist

getPluginResources

public List<WEFResource> getPluginResources()

Returns a list of unique resources for all the registered plugins and their dependencies.

Returns:

List of WEFResource objects representing all resources

getAllResources

public List<WEFResource> getAllResources(WEFResource resource)

Returns a list of unique resources for the given resource and all of it's dependencies.

Parameters:

resource - A WEFResource object

Returns:

List of WEFResource objects representing all resources

buildResourceMap

protected void buildResourceMap(WEFResource resource,
                    Map<String,WEFResource> resources)

Recursively builds a Map of unique resources for the given resource object.

Parameters:

resource - The WEFResource to get all resources for

resources - Map of unique resources found