Package org.glassfish.admingui.plugin

Class ConsolePluginService

java.lang.Object

org.glassfish.admingui.plugin.ConsolePluginService

@Service
public class ConsolePluginService
extends Object

This class provides access to IntegrationPoints.

Author:

Ken Paulsen ([email protected])

Constructor Summary

Constructors

Constructor	Description
ConsolePluginService()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addIntegrationPoint(IntegrationPoint point, String id)	This method allows a new IntegrationPoint to be added to the known IntegrationPoints.
void	addIntegrationPoints(List<IntegrationPoint> points, String id)	This method allows new IntegrationPoints to be added to the known IntegrationPoints.
Index	getHelpIndex(String locale)	This method returns a merged Table Of Contents for all found help sets for the given locale.
TOC	getHelpTOC(String locale)	This method returns a merged Table Of Contents for all found help sets for the given locale.
List<IntegrationPoint>	getIntegrationPoints(String type)	This method returns the IntegrationPoints associated with the given type.
ClassLoader	getModuleClassLoader(String moduleName)	This method returns the ClassLoader associated with the requested module.
Map<String,List<URL>>	getResources(String name)	This method searches the classpath of all plugins for the requested resource and returns all instances of it (if any).
protected void	init()	Initialize the available IntegrationPoints.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsolePluginService

public ConsolePluginService()

Default constructor.

Method Detail

init

protected void init()

Initialize the available IntegrationPoints.

getHelpTOC

public TOC getHelpTOC(String locale)

This method returns a merged Table Of Contents for all found help sets for the given locale.

getHelpIndex

public Index getHelpIndex(String locale)

This method returns a merged Table Of Contents for all found help sets for the given locale.

getResources

public Map<String,List<URL>> getResources(String name)

This method searches the classpath of all plugins for the requested resource and returns all instances of it (if any). This method will NOT return null, but may return an empty List.

addIntegrationPoints

public void addIntegrationPoints(List<IntegrationPoint> points,
                                 String id)

This method allows new IntegrationPoints to be added to the known IntegrationPoints.

addIntegrationPoint

public void addIntegrationPoint(IntegrationPoint point,
                                String id)

This method allows a new IntegrationPoint to be added to the known IntegrationPoints.

getIntegrationPoints

public List<IntegrationPoint> getIntegrationPoints(String type)

This method returns the IntegrationPoints associated with the given type.

Parameters:

type - The type of IntegrationPoints to retrieve.

getModuleClassLoader

public ClassLoader getModuleClassLoader(String moduleName)

This method returns the ClassLoader associated with the requested module. If the requested module does not exist, has not been initialized, or does not contain any admin console extensions, this method will return null.

Parameters:

moduleName - The name of the module.

Returns:

null, or the module's ClassLoader.