org.alfresco.repo.transfer
Class AbstractManifestProcessorBase

java.lang.Object
  extended by 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
AbstractManifestProcessorBase(TransferReceiver receiver, java.lang.String transferId)
           
 
Method Summary
protected abstract  void endManifest()
           
 void endTransferManifest()
          Signals the end of a transfer manifest
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  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, org.alfresco.service.cmr.repository.Path parentPath, boolean orphan)
           
protected  void logDeleted(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, org.alfresco.service.cmr.repository.Path parentPath)
           
protected  void logMoved(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, org.alfresco.service.cmr.repository.Path oldPath, org.alfresco.service.cmr.repository.NodeRef newParent, org.alfresco.service.cmr.repository.Path newPath)
           
protected  void logUpdated(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, org.alfresco.service.cmr.repository.Path 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()

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,
                          org.alfresco.service.cmr.repository.Path parentPath,
                          boolean orphan)

logDeleted

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

logUpdated

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

logMoved

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


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.