com.tridion.deployer

Class Processor

java.lang.Object

com.tridion.deployer.Processor

public class Processor
extends Object

Base Deployer Processor class for processing the contents of a TransportPackage at deploy time. This class contains the basic functionality for handing over a TransportPackage for processing by a number of configured Module's. This class can be extended and methods overridden to provide custom TransportPackage processors.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	action The action that this Processor has been configured to process packages for.
protected Map<String,Module>	modules List of modules that this Processor has been configured to use for processing packages.

Constructor Summary

Constructors

Constructor and Description
Processor(com.tridion.configuration.Configuration configuration) Creates and configures a new instance.
Processor(String action) Creates a new instance with given action.

Method Summary

Modifier and Type	Method and Description
void	addModule(String className, Module module) Adds given Module to module list.
void	configure(com.tridion.configuration.Configuration configuration) Configures this Processor with the passed configuration entry and creates all the configured Module's .
String	getAction() Returns the action of the processor.
Iterator<Module>	getModules() Gets the configured Module's.
void	process(TransportPackage data) Processes a TransportPackage by handing it over to be processed by all the configured Module's.

Methods inherited from class java.lang.Object

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

Field Detail

action

protected String action

The action that this Processor has been configured to process packages for.

modules

protected Map<String,Module> modules

List of modules that this Processor has been configured to use for processing packages.

Constructor Detail

Processor

public Processor(com.tridion.configuration.Configuration configuration)
          throws com.tridion.configuration.ConfigurationException

Creates and configures a new instance. Sub-classes MUST provide a public constructor with the same signature as this is used by the Deployer when creating Processor's.

Parameters:

configuration - Processor configuration entry.

Throws:

com.tridion.configuration.ConfigurationException - If something goes wrong during configuration.

Processor

public Processor(String action)

Creates a new instance with given action.

Parameters:

action - The action string.

Method Detail

addModule

public void addModule(String className,
                      Module module)

Adds given Module to module list.

Parameters:

module - The Module instance to be added.

configure

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

Configures this Processor with the passed configuration entry and creates all the configured Module's . Extending classes should override this method if they require custom configuration or don't require the standard Module configuration and creation.

Parameters:

configuration - Processor configuration entry.

Throws:

com.tridion.configuration.ConfigurationException - If something goes wrong during configuration.

getAction

public String getAction()

Returns the action of the processor.

Returns:

The action of the processor

process

public void process(TransportPackage data)
             throws ProcessingException

Processes a TransportPackage by handing it over to be processed by all the configured Module's. Extending classes should override this method to implement custom processing logic.

Parameters:

data - TransportPackage being deployed.

Throws:

ProcessingException - If something goes wrong processing the TransportPackage (all further processing by other Processor's will be aborted).

getModules

public Iterator<Module> getModules()

Gets the configured Module's.

Returns:

The configured Module; or null if none has been configured.