org.gatein.wsrp.api.plugins

Class AbstractPlugins

java.lang.Object

org.gatein.wsrp.api.plugins.AbstractPlugins

All Implemented Interfaces:

Plugins

public abstract class AbstractPlugins
extends Object
implements Plugins

Provides base behavior for server-specific Plugins implementations.

Author:

Chris Laprun

Field Summary

Fields inherited from interface org.gatein.wsrp.api.plugins.Plugins

WSRP_PLUGIN_EXTENSION_SUFFIX

Constructor Summary

Constructors

Constructor and Description
AbstractPlugins()

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.
protected abstract <T> Class<? extends T>	getImplementationNamed(String className, Class<T> pluginClass) Retrieves the Class object corresponding to the implementation named as specified by the provided name of the specified plugin interface.
protected abstract List<String>	getImplementationNamesFor(String pluginClassName, String defaultImplementationClassName) Retrieves a list of fully qualified names of detected implementations of the WSRP extension interface specified by its provided fully qualified name, providing a default implementation class name.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPlugins

public AbstractPlugins()

Method Detail

getKnownPluginInterfaceNames

public List<String> getKnownPluginInterfaceNames()

Description copied from interface: Plugins

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.

Specified by:

getKnownPluginInterfaceNames in interface Plugins

Returns:

the list of currently known plugin interface fully qualified names

getPluginImplementationNames

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

Description copied from interface: Plugins

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

Specified by:

getPluginImplementationNames in interface Plugins

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

getImplementationNamesFor

protected abstract List<String> getImplementationNamesFor(String pluginClassName,
                                     String defaultImplementationClassName)

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

Parameters:

pluginClassName - the fully qualified name of the plugin interface of which we want to retrieve the available implementations

defaultImplementationClassName - the fully qualified name of the default implementation

Returns:

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

createPluginInstance

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

Description copied from interface: Plugins

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.

Specified by:

createPluginInstance in interface Plugins

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

getImplementationNamed

protected abstract <T> Class<? extends T> getImplementationNamed(String className,
                                            Class<T> pluginClass)
                                                      throws ClassNotFoundException

Retrieves the Class object corresponding to the implementation named as specified by the provided name of the specified plugin interface.

Type Parameters:

T - the type of the plugin

Parameters:

className - the fully qualified name of the implementation which Class we want to retrieve

pluginClass - the interface of the plugin which the specified implementation is supposed to conform to

Returns:

the Class object for the specified implementation of the provided plugin interface

Throws:

ClassNotFoundException - if no such implementation exists