net.sf.pipet.api
Interface ModuleInterface.ModuleConfigurator

Enclosing interface:

ModuleInterface

public static interface ModuleInterface.ModuleConfigurator

Interface for module configuration. An object implementing this interface is created for configuring a module in one of the phases of the module life cycle: the subjected module may be an installed module, a pipeline module, or a pipeline instance module.

Method Summary

boolean

configure(ModuleAttributes atts, Collection<ModuleDefinition> pipeline, net.sf.qxs.messenger.Messenger logger) A call to this method configures the module by setting the configuration variables in the ModuleAttributes object which is passed as a parameter.

Method Detail

configure

boolean configure(ModuleAttributes atts,
                  Collection<ModuleDefinition> pipeline,
                  net.sf.qxs.messenger.Messenger logger)
                  throws ResourceException

A call to this method configures the module by setting the configuration variables in the ModuleAttributes object which is passed as a parameter.

Parameters:

atts - the module data to be configured.

pipeline - the collection of modules which constitute the pipeline.

logger - a logging interface.

Returns:

true if the configuration changed; false otherwise.

Throws:

ResourceException