org.azyva.dragom.execcontext.plugin.support

Class ExecContextPluginFactoryHolder

java.lang.Object

org.azyva.dragom.execcontext.plugin.support.ExecContextPluginFactoryHolder

public class ExecContextPluginFactoryHolder
extends Object

Holds and provides access to ExecContextPluginFactory's.

Allows generic tools to be provided by Dragom or other third party that can be integrated as a client tool by providing a way for client tools to easily provide the ExecContextPluginFactory's to use. Tools provided by Dragom make use of this strategy.

Dragom attempts to remain as independent as possible from external frameworks whose use would have impacts on clients, such as Spring. But at the same time Dragom must not prevent the use of such frameworks. This class allows, but does not force, ExecContextFactory's to be set using a dependency injection framework such as Spring.

ExecContextPluginFactoryHolder can also be used by tools without using a dependency injection framework. ExecContextPluginFactory's can simply be set by bootstrapping code before invoking the tool.

The ExecContextPluginFactory's are simply held in a static Map.

As a convenience, if no ExecContextPluginFactory is set for a given ExecContextPlugin interface, the following strategy is used:

• If the org.azyva.dragom.DefaultExecContextPluginFactory.<interface> system property is defined the identified class is used and instantiated using the default constructor. Example: org.azyva.dragom.DefaultExecContextPluginFactory.org.azyva.dragom.execontext.plugin.WorkspacePlugin=com.acme.MyWorkspacePluginFactory
• Otherwise, if the org.azyva.dragom.DefaultExecContextPluginImpl.<interface> system property is defined, GenericExecContextPluginFactory is used to wrap the identified ExecContextPlugin implementation class as an ExecContextPluginFactory. Example: org.azyva.dragom.DefaultExecContextPluginImpl.org.azyva.dragom.execontext.plugin.WorkspacePlugin=com.acme.MyWorkspaePluginImpl
• Otherwise an ExecContextPluginFactory implementation class name is constructed by taking the ExecContextPlugin interface name, adding the "impl" sub-package and completing the name with the "Default" prefix and "Factory" suffix. If such a class exists, it is used as is. Example: Given the ExecContextPlugin interface org.azyva.dragom.execcontext.plugin.WorkspacePlugin, the ExecContextPluginFactory class would be org.azyva.dragom.execcontext.plugin.impl.DefaultWorkspacePluginFactory.
• Otherwise an ExecContextPlugin implementation class name is constructed by taking the ExecContextPlugin interface name, adding the "impl" sub-package and completing the name with the "Default" prefix and "Impl" suffix and the resulting ExecContextPlugin implementation is wrapped as an ExecContextPluginFactory using GenericExecContextPluginFactory. Example: Given the ExecContextPlugin interface org.azyva.dragom.execcontext.plugin.WorkspacePlugin, the ExecContextPlugin implementation class would be org.azyva.dragom.execcontext.plugin.impl.DefaultWorkspacePluginImpl.

Author:

David Raymond

Constructor Summary

Constructors

Constructor and Description
ExecContextPluginFactoryHolder()

Method Summary

Modifier and Type	Method and Description
static <ExecContextPluginClass extends org.azyva.dragom.execcontext.plugin.ExecContextPlugin> org.azyva.dragom.execcontext.plugin.ExecContextPluginFactory<ExecContextPluginClass>	getExecContextPluginFactory(Class<ExecContextPluginClass> classExecContextPlugin)
static <ExecContextPluginClass extends org.azyva.dragom.execcontext.plugin.ExecContextPlugin> void	setExecContextPluginFactory(Class<ExecContextPluginClass> classExecContextPlugin, org.azyva.dragom.execcontext.plugin.ExecContextPluginFactory<ExecContextPluginClass> execContextPluginFactory) Sets the ExecContextPluginFactory for a given ExecContextPlugin interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecContextPluginFactoryHolder

public ExecContextPluginFactoryHolder()

Method Detail

setExecContextPluginFactory

public static <ExecContextPluginClass extends org.azyva.dragom.execcontext.plugin.ExecContextPlugin> void setExecContextPluginFactory(Class<ExecContextPluginClass> classExecContextPlugin,
                                                                                                                                      org.azyva.dragom.execcontext.plugin.ExecContextPluginFactory<ExecContextPluginClass> execContextPluginFactory)

Sets the ExecContextPluginFactory for a given ExecContextPlugin interface.

Type Parameters:

ExecContextPluginClass - ExecContextPlugin interface class.

Parameters:

classExecContextPlugin - Class of the ExecContextPlugin interface.

execContextPluginFactory - ExecContextPluginFactory.

getExecContextPluginFactory

public static <ExecContextPluginClass extends org.azyva.dragom.execcontext.plugin.ExecContextPlugin> org.azyva.dragom.execcontext.plugin.ExecContextPluginFactory<ExecContextPluginClass> getExecContextPluginFactory(Class<ExecContextPluginClass> classExecContextPlugin)