com.tridion.deployer

Class ModuleFactory

java.lang.Object

com.tridion.deployer.ModuleFactory

All Implemented Interfaces:

com.tridion.configuration.Configurable

public class ModuleFactory
extends Object
implements com.tridion.configuration.Configurable

Factory class for creating Modules's.

Author:

Hans Speijer

Method Summary

Modifier and Type	Method and Description
void	configure(com.tridion.configuration.Configuration config) Configures the ModuleFactory.
Module	createModule(com.tridion.configuration.Configuration config) Creates a Module based on the passed Configuration.
Module	createModule(com.tridion.configuration.Configuration config, Processor processor) Creates a Module based on the passed Configuration with the passed Processor.
Module	createModuleOnPreference(com.tridion.configuration.Configuration config, Processor processor) Creates Module class by calling constructor with single config argument.
static ModuleFactory	getInstance() Standard singleton method to return an instance.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ModuleFactory getInstance()

Standard singleton method to return an instance.

Returns:

The one and only instance of this class.

configure

public void configure(com.tridion.configuration.Configuration config)
               throws com.tridion.configuration.ConfigurationException

Configures the ModuleFactory.

Specified by:

configure in interface com.tridion.configuration.Configurable

Parameters:

config - Configuration object to get configuration entries from.

Throws:

com.tridion.configuration.ConfigurationException - If something goes wrong configuring the ModuleFactory.

createModuleOnPreference

public Module createModuleOnPreference(com.tridion.configuration.Configuration config,
                                       Processor processor)
                                throws com.tridion.configuration.ConfigurationException

Creates Module class by calling constructor with single config argument. If class has no particular constructor then the constructor with config and processor is called.

If neither of the attempts are successful, or calling constructors lead other errors, an exception will be thrown.

Parameters:

config - Configuration containing a binding for the Module.

processor - Processor which will be passed to the Module's constructor.

Returns:

A Module initialised with the passed Processor.

Throws:

com.tridion.configuration.ConfigurationException - If no processor has been registered for the passed action or something goes wrong constructing or instantiating the Module.

createModule

public Module createModule(com.tridion.configuration.Configuration config)
                    throws com.tridion.configuration.ConfigurationException

Creates a Module based on the passed Configuration.

Parameters:

config - Configuration containing a binding for the Module.

Returns:

A Module initialised with the passed Processor.

Throws:

com.tridion.configuration.ConfigurationException - If no processor has been registered for the passed action or something goes wrong constructing or instantiating the Module.

createModule

public Module createModule(com.tridion.configuration.Configuration config,
                           Processor processor)
                    throws com.tridion.configuration.ConfigurationException

Creates a Module based on the passed Configuration with the passed Processor.

Parameters:

config - Configuration containing a binding for the Module.

processor - Processor which will be passed to the Module's constructor.

Returns:

A Module initialised with the passed Processor.

Throws:

com.tridion.configuration.ConfigurationException - If no processor has been registered for the passed action or something goes wrong constructing or instantiating the Module.