org.alfresco.repo.transfer
Class AbstractTransferProgressMonitor

java.lang.Object
  extended by org.alfresco.repo.transfer.AbstractTransferProgressMonitor
All Implemented Interfaces:
TransferProgressMonitor
Direct Known Subclasses:
RepoTransferProgressMonitorImpl

public abstract class AbstractTransferProgressMonitor
extends java.lang.Object
implements TransferProgressMonitor


Field Summary
protected static java.lang.String MSG_TRANSFER_CANCELLED
           
protected static java.lang.String MSG_TRANSFER_NOT_FOUND
           
 
Constructor Summary
AbstractTransferProgressMonitor()
           
 
Method Summary
protected abstract  java.io.Writer createUnderlyingLogWriter(java.lang.String transferId)
           
 TransferProgress getProgress(java.lang.String transferId)
          Read the progress of the
protected abstract  TransferProgress getProgressInternal(java.lang.String transferId)
           
 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 parentNodeRef, org.alfresco.service.cmr.repository.Path parentPath, boolean orphan)
          Log the creation of a new node
 void logDeleted(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)
          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 newParentNodeRef, 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 sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef destNodeRef, org.alfresco.service.cmr.repository.Path path)
          Log the creation of a new node
 void setTransactionService(TransactionService transactionService)
           
protected abstract  void storeError(java.lang.String transferId, java.lang.Throwable error)
           
 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.
protected abstract  void updateProgressInternal(java.lang.String transferId, int currPos)
           
protected abstract  void updateProgressInternal(java.lang.String transferId, int currPos, int endPos)
           
 void updateStatus(java.lang.String transferId, TransferProgress.Status status)
          update the startus of the transfer
protected abstract  void updateStatusInternal(java.lang.String transferId, TransferProgress.Status status)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.alfresco.repo.transfer.TransferProgressMonitor
getLogInputStream
 

Field Detail

MSG_TRANSFER_NOT_FOUND

protected static final java.lang.String MSG_TRANSFER_NOT_FOUND
See Also:
Constant Field Values

MSG_TRANSFER_CANCELLED

protected static final java.lang.String MSG_TRANSFER_CANCELLED
See Also:
Constant Field Values
Constructor Detail

AbstractTransferProgressMonitor

public AbstractTransferProgressMonitor()
Method Detail

setTransactionService

public void setTransactionService(TransactionService transactionService)

getProgress

public TransferProgress getProgress(java.lang.String transferId)
                             throws TransferException
Description copied from interface: TransferProgressMonitor
Read the progress of the

Specified by:
getProgress in interface TransferProgressMonitor
Returns:
the progress of the transfer
Throws:
TransferException

getProgressInternal

protected abstract TransferProgress getProgressInternal(java.lang.String transferId)

updateProgress

public void updateProgress(java.lang.String transferId,
                           int currPos,
                           int endPos)
                    throws TransferException
Description copied from interface: TransferProgressMonitor
update the progress of the specified transfer and possibly change the end position.

Specified by:
updateProgress in interface TransferProgressMonitor
Throws:
TransferException

updateProgressInternal

protected abstract void updateProgressInternal(java.lang.String transferId,
                                               int currPos,
                                               int endPos)

updateProgress

public void updateProgress(java.lang.String transferId,
                           int currPos)
                    throws TransferException
Description copied from interface: TransferProgressMonitor
update the progress of the specified transfer

Specified by:
updateProgress in interface TransferProgressMonitor
Throws:
TransferException

updateProgressInternal

protected abstract void updateProgressInternal(java.lang.String transferId,
                                               int currPos)

updateStatus

public final void updateStatus(java.lang.String transferId,
                               TransferProgress.Status status)
                        throws TransferException
Description copied from interface: TransferProgressMonitor
update the startus of the transfer

Specified by:
updateStatus in interface TransferProgressMonitor
Throws:
TransferException

updateStatusInternal

protected abstract void updateStatusInternal(java.lang.String transferId,
                                             TransferProgress.Status status)

logComment

public void logComment(java.lang.String transferId,
                       java.lang.Object obj)
Description copied from interface: TransferProgressMonitor
log an ad-hoc message

Specified by:
logComment in interface TransferProgressMonitor

logException

public void logException(java.lang.String transferId,
                         java.lang.Object obj,
                         java.lang.Throwable ex)
Description copied from interface: TransferProgressMonitor
log an ad-hoc message and an exception

Specified by:
logException in interface TransferProgressMonitor

storeError

protected abstract void storeError(java.lang.String transferId,
                                   java.lang.Throwable error)

logCreated

public 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 parentNodeRef,
                       org.alfresco.service.cmr.repository.Path parentPath,
                       boolean orphan)
Description copied from interface: TransferProgressMonitor
Log the creation of a new node

Specified by:
logCreated in interface TransferProgressMonitor

logUpdated

public void logUpdated(java.lang.String transferId,
                       org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                       org.alfresco.service.cmr.repository.NodeRef destNodeRef,
                       org.alfresco.service.cmr.repository.Path path)
Description copied from interface: TransferProgressMonitor
Log the creation of a new node

Specified by:
logUpdated in interface TransferProgressMonitor

logMoved

public 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 newParentNodeRef,
                     org.alfresco.service.cmr.repository.Path newPath)
Description copied from interface: TransferProgressMonitor
After the transfer has completed this method reads the log.

Specified by:
logMoved in interface TransferProgressMonitor

logDeleted

public void logDeleted(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)
Description copied from interface: TransferProgressMonitor
Log the deletion of a node

Specified by:
logDeleted in interface TransferProgressMonitor

createUnderlyingLogWriter

protected abstract java.io.Writer createUnderlyingLogWriter(java.lang.String transferId)


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