Package org.alfresco.repo.transfer

Class AbstractManifestProcessorBase

java.lang.Object

org.alfresco.repo.transfer.AbstractManifestProcessorBase

All Implemented Interfaces:

TransferManifestProcessor, TransferSummaryAware

Direct Known Subclasses:

RepoPrimaryManifestProcessorImpl, RepoRequisiteManifestProcessorImpl, RepoSecondaryManifestProcessorImpl, RepoTertiaryManifestProcessorImpl

public abstract class AbstractManifestProcessorBase
extends Object
implements TransferManifestProcessor, TransferSummaryAware

This abstract class handles the progress monitoring functionality as well as providing some utility methods for sub-classes.

Author:

Brian

Constructor Summary

Constructors

Constructor	Description
AbstractManifestProcessorBase(TransferReceiver receiver, String transferId)

Method Summary

Modifier and Type	Method	Description
protected abstract void	endManifest()
final void	endTransferManifest()	Signals the end of a transfer manifest
protected TransferReceiver	getReceiver()
protected File	getStagingFolder()
protected ChildAssociationRef	getTemporaryLocation(NodeRef nodeRef)	Given the node ref, this method constructs the appropriate ChildAssociationRef that would place this node in the transfer's temporary folder.
protected String	getTransferId()
TransferSummaryReport	getTransferSummaryReport()
protected void	localHandleException(TransferManifestNode node, Throwable ex)	This method is invoked if an exception or error occurs while processing the manifest.
protected void	logComment(String message)
protected void	logCreated(NodeRef sourceNode, NodeRef destNode, NodeRef newParentNode, String parentPath, boolean orphan)
protected void	logDeleted(NodeRef sourceNode, NodeRef destNode, String parentPath)
protected void	logInvasionHierarchy(NodeRef parentRef, NodeRef childRef, NodeService nodeService, org.apache.commons.logging.Log log)	Puts information about current childRef and its parentRef into log in TRACE level.
protected void	logMoved(NodeRef sourceNode, NodeRef destNode, String oldPath, NodeRef newParent, String newPath)
protected void	logSummaryComment(String message)
protected void	logSummaryCreated(NodeRef sourceNode, NodeRef destNode, NodeRef newParentNode, String parentPath, boolean orphan)
protected void	logSummaryDeleted(NodeRef sourceNode, NodeRef destNode, String parentPath)
protected void	logSummaryMoved(NodeRef sourceNode, NodeRef destNode, String oldPath, NodeRef newParent, String newPath)
protected void	logSummaryUpdated(NodeRef sourceNode, NodeRef destNode, String newPath)
protected void	logUpdated(NodeRef sourceNode, NodeRef destNode, String newPath)
protected abstract void	processHeader(TransferManifestHeader header)
protected abstract void	processNode(TransferManifestDeletedNode node)
protected abstract void	processNode(TransferManifestNormalNode node)
final void	processTransferManifestNode(TransferManifestDeletedNode node)	Gives a deleted manifest node to be processed
final void	processTransferManifestNode(TransferManifestNormalNode node)	Gives a manifest node to be processed
final void	processTransferManifiestHeader(TransferManifestHeader header)	Gives the header to be proceessed
void	setTransferSummaryReport(TransferSummaryReport transferSummaryReport)
protected abstract void	startManifest()
final void	startTransferManifest()	Signals the start of a transfer manifest

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractManifestProcessorBase

public AbstractManifestProcessorBase(TransferReceiver receiver,
 String transferId)

Method Details

endTransferManifest

public final void endTransferManifest()

Description copied from interface: TransferManifestProcessor

Signals the end of a transfer manifest

Specified by:

endTransferManifest in interface TransferManifestProcessor

endManifest

protected abstract void endManifest()

processTransferManifestNode

public final void processTransferManifestNode(TransferManifestNormalNode node)

Description copied from interface: TransferManifestProcessor

Gives a manifest node to be processed

Specified by:

processTransferManifestNode in interface TransferManifestProcessor

Parameters:

node - the node

processNode

protected abstract void processNode(TransferManifestNormalNode node)
                             throws TransferProcessingException

Throws:

TransferProcessingException

processTransferManifestNode

public final void processTransferManifestNode(TransferManifestDeletedNode node)

Description copied from interface: TransferManifestProcessor

Gives a deleted manifest node to be processed

Specified by:

processTransferManifestNode in interface TransferManifestProcessor

Parameters:

node - the node

processNode

protected abstract void processNode(TransferManifestDeletedNode node)
                             throws TransferProcessingException

Throws:

TransferProcessingException

processTransferManifiestHeader

public final void processTransferManifiestHeader(TransferManifestHeader header)

Description copied from interface: TransferManifestProcessor

Gives the header to be proceessed

Specified by:

processTransferManifiestHeader in interface TransferManifestProcessor

Parameters:

header - the header

processHeader

protected abstract void processHeader(TransferManifestHeader header)

startTransferManifest

public final void startTransferManifest()

Description copied from interface: TransferManifestProcessor

Signals the start of a transfer manifest

Specified by:

startTransferManifest in interface TransferManifestProcessor

startManifest

protected abstract void startManifest()

getTemporaryLocation

protected ChildAssociationRef getTemporaryLocation(NodeRef nodeRef)

Given the node ref, this method constructs the appropriate ChildAssociationRef that would place this node in the transfer's temporary folder. Useful when handling orphans.

Parameters:

nodeRef - NodeRef

Returns:

ChildAssociationRef

getStagingFolder

protected File getStagingFolder()

getReceiver

protected TransferReceiver getReceiver()

getTransferId

protected String getTransferId()

localHandleException

protected void localHandleException(TransferManifestNode node,
 Throwable ex)

This method is invoked if an exception or error occurs while processing the manifest. By default it does nothing, but classes that extend this class can override this to provide custom clean-up.

Parameters:

node - TransferManifestNode

ex - Throwable

logComment

protected void logComment(String message)

logCreated

protected void logCreated(NodeRef sourceNode,
 NodeRef destNode,
 NodeRef newParentNode,
 String parentPath,
 boolean orphan)

logDeleted

protected void logDeleted(NodeRef sourceNode,
 NodeRef destNode,
 String parentPath)

logUpdated

protected void logUpdated(NodeRef sourceNode,
 NodeRef destNode,
 String newPath)

logMoved

protected void logMoved(NodeRef sourceNode,
 NodeRef destNode,
 String oldPath,
 NodeRef newParent,
 String newPath)

logInvasionHierarchy

protected void logInvasionHierarchy(NodeRef parentRef,
 NodeRef childRef,
 NodeService nodeService,
 org.apache.commons.logging.Log log)

Puts information about current childRef and its parentRef into log in TRACE level. Information includes 'name', 'fromRepositoryId', 'aliened' and 'invadedBy' properties. Additionally, collects the same information for children of childRef

Parameters:

parentRef - - NodeRef instance of child node

childRef - - NodeRef instance of parent of the childRef

nodeService - - NodeService instance to get properties and checking other states

log - - Log instance to put log for appropriate class

setTransferSummaryReport

public void setTransferSummaryReport(TransferSummaryReport transferSummaryReport)

getTransferSummaryReport

public TransferSummaryReport getTransferSummaryReport()

Specified by:

getTransferSummaryReport in interface TransferSummaryAware

logSummaryComment

protected void logSummaryComment(String message)

logSummaryCreated

protected void logSummaryCreated(NodeRef sourceNode,
 NodeRef destNode,
 NodeRef newParentNode,
 String parentPath,
 boolean orphan)

logSummaryDeleted

protected void logSummaryDeleted(NodeRef sourceNode,
 NodeRef destNode,
 String parentPath)

logSummaryUpdated

protected void logSummaryUpdated(NodeRef sourceNode,
 NodeRef destNode,
 String newPath)

logSummaryMoved

protected void logSummaryMoved(NodeRef sourceNode,
 NodeRef destNode,
 String oldPath,
 NodeRef newParent,
 String newPath)