org.gatein.wsrp.api.plugins

Interface Plugins

All Known Implementing Classes:

AbstractPlugins

public interface Plugins

An entry point for the WSRP plugins system with the underlying server. The portal server in which WSRP is running must provide an implementation of this interface so that WSRP can properly access user-developed plugins.

Author:

Chris Laprun

Field Summary

Fields

Modifier and Type	Field and Description
static String	WSRP_PLUGIN_EXTENSION_SUFFIX The extension that identifies WSRP plugins.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	createPluginInstance(String className, Class<T> pluginClass) Instantiates a plugin implementation using the default constructor of the plugin identified by the specified fully qualified class name, specifying that the implementation must implement the specified plugin interface.
List<String>	getKnownPluginInterfaceNames() Retrieves the list of currently known extension points as plugins in our WSRP implementations.
List<String>	getPluginImplementationNames(Class pluginClass, String defaultImplementationClassName) Retrieves a list of fully qualified names of detected implementations of the specified WSRP extension interface, providing a default implementation class name.

Field Detail

WSRP_PLUGIN_EXTENSION_SUFFIX

static final String WSRP_PLUGIN_EXTENSION_SUFFIX

The extension that identifies WSRP plugins. Note that this is just a marker as for backward compatibility reasons, plain jar extensions are also supported.

See Also:

Constant Field Values

Method Detail

getKnownPluginInterfaceNames

List<String> getKnownPluginInterfaceNames()

Retrieves the list of currently known extension points as plugins in our WSRP implementations. These are interfaces that the WSRP plugin system can detect and work with.

Returns:

the list of currently known plugin interface fully qualified names

getPluginImplementationNames

List<String> getPluginImplementationNames(Class pluginClass,
                                        String defaultImplementationClassName)

Retrieves a list of fully qualified names of detected implementations of the specified WSRP extension interface, providing a default implementation class name.

Parameters:

pluginClass - the Class object representing the WSRP plugin interface we want to retrieve the implementations of

defaultImplementationClassName - the fully qualified name of the default implementation for the specified plugin

Returns:

a list of fully qualified names of detected implementations of the specified WSRP plugin interface

createPluginInstance

<T> T createPluginInstance(String className,
                         Class<T> pluginClass)

Instantiates a plugin implementation using the default constructor of the plugin identified by the specified fully qualified class name, specifying that the implementation must implement the specified plugin interface.

Type Parameters:

T - the type of the plugin

Parameters:

className - the fully qualified name of the implementation class to instantiate

pluginClass - the interface of the plugin of which we want to create an instance

Returns:

an instance of the specified implementation class provided it properly implements the specified plugin interface