org.alfresco.repo.transfer

Class AbstractManifestProcessorBase

java.lang.Object

org.alfresco.repo.transfer.AbstractManifestProcessorBase

All Implemented Interfaces:

TransferManifestProcessor

Direct Known Subclasses:

RepoPrimaryManifestProcessorImpl, RepoRequisiteManifestProcessorImpl, RepoSecondaryManifestProcessorImpl, RepoTertiaryManifestProcessorImpl

public abstract class AbstractManifestProcessorBase
extends java.lang.Object
implements TransferManifestProcessor

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

Constructor Summary

Constructors

Constructor and Description
AbstractManifestProcessorBase(TransferReceiver receiver, java.lang.String transferId)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	endManifest()
void	endTransferManifest() Signals the end of a transfer manifest
protected TransferReceiver	getReceiver()
protected java.io.File	getStagingFolder()
protected org.alfresco.service.cmr.repository.ChildAssociationRef	getTemporaryLocation(org.alfresco.service.cmr.repository.NodeRef nodeRef) Given the node ref, this method constructs the appropriate ChildAssociationRef that would place this node in the transfer's temporary folder.
protected java.lang.String	getTransferId()
protected void	localHandleException(TransferManifestNode node, java.lang.Throwable ex) This method is invoked if an exception or error occurs while processing the manifest.
protected void	logComment(java.lang.String message)
protected void	logCreated(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, org.alfresco.service.cmr.repository.NodeRef newParentNode, java.lang.String parentPath, boolean orphan)
protected void	logDeleted(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, java.lang.String parentPath)
protected void	logMoved(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, java.lang.String oldPath, org.alfresco.service.cmr.repository.NodeRef newParent, java.lang.String newPath)
protected void	logUpdated(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, java.lang.String newPath)
protected abstract void	processHeader(TransferManifestHeader header)
protected abstract void	processNode(TransferManifestDeletedNode node)
protected abstract void	processNode(TransferManifestNormalNode node)
void	processTransferManifestNode(TransferManifestDeletedNode node) Gives a deleted manifest node to be processed
void	processTransferManifestNode(TransferManifestNormalNode node) Gives a manifest node to be processed
void	processTransferManifiestHeader(TransferManifestHeader header) Gives the header to be proceessed
protected abstract void	startManifest()
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 Detail

AbstractManifestProcessorBase

public AbstractManifestProcessorBase(TransferReceiver receiver,
                             java.lang.String transferId)

Method Detail

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

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

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

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 org.alfresco.service.cmr.repository.ChildAssociationRef getTemporaryLocation(org.alfresco.service.cmr.repository.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 -

Returns:

getStagingFolder

protected java.io.File getStagingFolder()

getReceiver

protected TransferReceiver getReceiver()

getTransferId

protected java.lang.String getTransferId()

localHandleException

protected void localHandleException(TransferManifestNode node,
                        java.lang.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 -

ex -

logComment

protected void logComment(java.lang.String message)

logCreated

protected void logCreated(org.alfresco.service.cmr.repository.NodeRef sourceNode,
              org.alfresco.service.cmr.repository.NodeRef destNode,
              org.alfresco.service.cmr.repository.NodeRef newParentNode,
              java.lang.String parentPath,
              boolean orphan)

logDeleted

protected void logDeleted(org.alfresco.service.cmr.repository.NodeRef sourceNode,
              org.alfresco.service.cmr.repository.NodeRef destNode,
              java.lang.String parentPath)

logUpdated

protected void logUpdated(org.alfresco.service.cmr.repository.NodeRef sourceNode,
              org.alfresco.service.cmr.repository.NodeRef destNode,
              java.lang.String newPath)

logMoved

protected void logMoved(org.alfresco.service.cmr.repository.NodeRef sourceNode,
            org.alfresco.service.cmr.repository.NodeRef destNode,
            java.lang.String oldPath,
            org.alfresco.service.cmr.repository.NodeRef newParent,
            java.lang.String newPath)