org.alfresco.repo.transfer
Interface TransferProgressMonitor

All Known Implementing Classes:
AbstractTransferProgressMonitor, LoggingTransferProgressMonitorImpl, RepoTransferProgressMonitorImpl

public interface TransferProgressMonitor


Method Summary
 java.io.InputStream getLogInputStream(java.lang.String transferId)
           
 TransferProgress getProgress(java.lang.String transferId)
          Read the progress of the
 void logComment(java.lang.String transferId, java.lang.Object obj)
          log an ad-hoc message
 void logCreated(java.lang.String transferId, org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, org.alfresco.service.cmr.repository.NodeRef newParent, org.alfresco.service.cmr.repository.Path newPath, boolean orphan)
          Log the creation of a new node
 void logDeleted(java.lang.String transferId, org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, org.alfresco.service.cmr.repository.Path parentPath)
          Log the deletion of a node
 void logException(java.lang.String transferId, java.lang.Object obj, java.lang.Throwable ex)
          log an ad-hoc message and an exception
 void logMoved(java.lang.String transferId, org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef destNodeRef, org.alfresco.service.cmr.repository.Path oldPath, org.alfresco.service.cmr.repository.NodeRef newParent, org.alfresco.service.cmr.repository.Path newPath)
          After the transfer has completed this method reads the log.
 void logUpdated(java.lang.String transferId, org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, org.alfresco.service.cmr.repository.Path parentPath)
          Log the creation of a new node
 void updateProgress(java.lang.String transferId, int currPos)
          update the progress of the specified transfer
 void updateProgress(java.lang.String transferId, int currPos, int endPos)
          update the progress of the specified transfer and possibly change the end position.
 void updateStatus(java.lang.String transferId, TransferProgress.Status status)
          update the startus of the transfer
 

Method Detail

logComment

void logComment(java.lang.String transferId,
                java.lang.Object obj)
                throws TransferException
log an ad-hoc message

Parameters:
transferId -
obj -
Throws:
TransferException

logException

void logException(java.lang.String transferId,
                  java.lang.Object obj,
                  java.lang.Throwable ex)
                  throws TransferException
log an ad-hoc message and an exception

Parameters:
transferId -
obj -
ex -
Throws:
TransferException

logCreated

void logCreated(java.lang.String transferId,
                org.alfresco.service.cmr.repository.NodeRef sourceNode,
                org.alfresco.service.cmr.repository.NodeRef destNode,
                org.alfresco.service.cmr.repository.NodeRef newParent,
                org.alfresco.service.cmr.repository.Path newPath,
                boolean orphan)
Log the creation of a new node

Parameters:
transferId -
sourceNode -
destNode -
newPath -
orphan -

logUpdated

void logUpdated(java.lang.String transferId,
                org.alfresco.service.cmr.repository.NodeRef sourceNode,
                org.alfresco.service.cmr.repository.NodeRef destNode,
                org.alfresco.service.cmr.repository.Path parentPath)
Log the creation of a new node

Parameters:
transferId -
sourceNode -
destNode -
parentPath -
orphan -

logDeleted

void logDeleted(java.lang.String transferId,
                org.alfresco.service.cmr.repository.NodeRef sourceNode,
                org.alfresco.service.cmr.repository.NodeRef destNode,
                org.alfresco.service.cmr.repository.Path parentPath)
Log the deletion of a node

Parameters:
transferId -
sourceNode -
destNode -
parentPath -
orphan -

logMoved

void logMoved(java.lang.String transferId,
              org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
              org.alfresco.service.cmr.repository.NodeRef destNodeRef,
              org.alfresco.service.cmr.repository.Path oldPath,
              org.alfresco.service.cmr.repository.NodeRef newParent,
              org.alfresco.service.cmr.repository.Path newPath)
After the transfer has completed this method reads the log.

Parameters:
transferId -

updateProgress

void updateProgress(java.lang.String transferId,
                    int currPos)
                    throws TransferException
update the progress of the specified transfer

Parameters:
transferId -
currPos -
Throws:
TransferException

updateProgress

void updateProgress(java.lang.String transferId,
                    int currPos,
                    int endPos)
                    throws TransferException
update the progress of the specified transfer and possibly change the end position.

Parameters:
transferId -
currPos -
endPos -
Throws:
TransferException

updateStatus

void updateStatus(java.lang.String transferId,
                  TransferProgress.Status status)
                  throws TransferException
update the startus of the transfer

Parameters:
transferId -
status -
Throws:
TransferException

getProgress

TransferProgress getProgress(java.lang.String transferId)
                             throws TransferException
Read the progress of the

Parameters:
transferId -
Returns:
the progress of the transfer
Throws:
TransferException

getLogInputStream

java.io.InputStream getLogInputStream(java.lang.String transferId)
                                      throws TransferException
Throws:
TransferException


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