com.tridion.deployer

Class SectionVisitor

java.lang.Object

com.tridion.deployer.Module

com.tridion.deployer.SectionVisitor

All Implemented Interfaces:

com.tridion.configuration.Configurable

public abstract class SectionVisitor
extends Module

Parent class for section visitors.

Field Summary

Fields inherited from class com.tridion.deployer.Module

transformProcessor

Constructor Summary

Constructors

Constructor and Description
SectionVisitor(com.tridion.configuration.Configuration config) Creates a new instance of SectionVisitor.

Method Summary

Modifier and Type	Method and Description
BinaryStorageBase	getBinaryStorage()
TransportPackage	getCurrentTransportPackage()
protected abstract String	getRootSectionName() Should return the name for the root section that this SectionVisitor is supposed to Process.
TransformerStorage	getTransformerStorage()
void	process(TransportPackage transportPackage) Processes the TransportPackage.
protected abstract void	processItem(Object item, com.tridion.transport.transportpackage.Section currentSection) Abstract method for subclasses to implement.
protected void	processSection(com.tridion.transport.transportpackage.Section section)
protected abstract boolean	setup() This method is called once before processing starts.

Methods inherited from class com.tridion.deployer.Module

configure, getConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

SectionVisitor

public SectionVisitor(com.tridion.configuration.Configuration config)
               throws com.tridion.configuration.ConfigurationException

Creates a new instance of SectionVisitor.

Throws:

com.tridion.configuration.ConfigurationException

Method Detail

process

public void process(TransportPackage transportPackage)
             throws ProcessingException

Description copied from class: Module

Processes the TransportPackage.

Specified by:

process in class Module

Parameters:

transportPackage - package to process

Throws:

ProcessingException - in case of any error.

getRootSectionName

protected abstract String getRootSectionName()

Should return the name for the root section that this SectionVisitor is supposed to Process.

setup

protected abstract boolean setup()

This method is called once before processing starts. The currentTransportPackage will always be valid when this method is called.

processSection

protected void processSection(com.tridion.transport.transportpackage.Section section)
                       throws ProcessingException

Throws:

ProcessingException

processItem

protected abstract void processItem(Object item,
                                    com.tridion.transport.transportpackage.Section currentSection)
                             throws ProcessingException

Abstract method for subclasses to implement. Its purpose is to process an individual item of a deploy action.

Parameters:

item - This generic type should be tested for an implementation of MetaKey that is of interest to the implementation.

currentSection - Section this item is part of

Throws:

ProcessingException - when an error occurs and the deploy action should be considered failed.

getCurrentTransportPackage

public TransportPackage getCurrentTransportPackage()

getBinaryStorage

public BinaryStorageBase getBinaryStorage()

getTransformerStorage

public TransformerStorage getTransformerStorage()