org.alfresco.repo.transfer

Class LoggingTransferProgressMonitorImpl

java.lang.Object

org.alfresco.repo.transfer.LoggingTransferProgressMonitorImpl

All Implemented Interfaces:

TransferProgressMonitor

public class LoggingTransferProgressMonitorImpl
extends Object
implements TransferProgressMonitor

Author:

brian

Constructor Summary

Constructors

Constructor and Description
LoggingTransferProgressMonitorImpl()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingTransferProgressMonitorImpl

public LoggingTransferProgressMonitorImpl()

Method Detail

setDelegate

public void setDelegate(TransferProgressMonitor delegate)

Parameters:

delegate - the delegate to set

getProgress

public TransferProgress getProgress(String transferId)
                             throws TransferException

Description copied from interface: TransferProgressMonitor

Read the progress of the

Specified by:

getProgress in interface TransferProgressMonitor

Parameters:

transferId - String

Returns:

TransferProgress

Throws:

TransferException

See Also:

TransferProgressMonitor.getProgress(java.lang.String)

logException

public void logException(String transferId,
                         Object obj,
                         Throwable ex)
                  throws TransferException

Description copied from interface: TransferProgressMonitor

log an ad-hoc message and an exception

Specified by:

logException in interface TransferProgressMonitor

Parameters:

transferId - String

obj - Object

ex - Throwable

Throws:

TransferException

See Also:

TransferProgressMonitor.logException(java.lang.String, java.lang.Object, java.lang.Throwable)

logComment

public void logComment(String transferId,
                       Object obj)
                throws TransferException

Description copied from interface: TransferProgressMonitor

log an ad-hoc message

Specified by:

logComment in interface TransferProgressMonitor

Parameters:

transferId - String

obj - Object

Throws:

TransferException

See Also:

TransferProgressMonitor.logComment(java.lang.String, java.lang.Object)

logCreated

public void logCreated(String transferId,
                       org.alfresco.service.cmr.repository.NodeRef sourceNode,
                       org.alfresco.service.cmr.repository.NodeRef destNode,
                       org.alfresco.service.cmr.repository.NodeRef parentNode,
                       String parentPath,
                       boolean orphan)

Description copied from interface: TransferProgressMonitor

Log the creation of a new node

Specified by:

logCreated in interface TransferProgressMonitor

Parameters:

transferId - String

sourceNode - NodeRef

destNode - NodeRef

parentPath - String

orphan - boolean

logUpdated

public void logUpdated(String transferId,
                       org.alfresco.service.cmr.repository.NodeRef sourceNode,
                       org.alfresco.service.cmr.repository.NodeRef destNode,
                       String parentPath)

Description copied from interface: TransferProgressMonitor

Log the creation of a new node

Specified by:

logUpdated in interface TransferProgressMonitor

Parameters:

transferId - String

sourceNode - NodeRef

destNode - NodeRef

parentPath - The path of the updated node

logMoved

public void logMoved(String transferId,
                     org.alfresco.service.cmr.repository.NodeRef sourceNode,
                     org.alfresco.service.cmr.repository.NodeRef destNode,
                     String oldPath,
                     org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                     String parentPath)

Description copied from interface: TransferProgressMonitor

After the transfer has completed this method reads the log.

Specified by:

logMoved in interface TransferProgressMonitor

Parameters:

transferId - String

sourceNode - NodeRef

destNode - NodeRef

oldPath - String

parentNodeRef - NodeRef

parentPath - String

logDeleted

public void logDeleted(String transferId,
                       org.alfresco.service.cmr.repository.NodeRef sourceNode,
                       org.alfresco.service.cmr.repository.NodeRef destNode,
                       String parentPath)

Description copied from interface: TransferProgressMonitor

Log the deletion of a node

Specified by:

logDeleted in interface TransferProgressMonitor

Parameters:

transferId - String

sourceNode - NodeRef

destNode - NodeRef

parentPath - The path of the deleted node

updateProgress

public void updateProgress(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

Parameters:

transferId - String

currPos - int

endPos - int

Throws:

TransferException

See Also:

TransferProgressMonitor.updateProgress(java.lang.String, int, int)

updateProgress

public void updateProgress(String transferId,
                           int currPos)
                    throws TransferException

Description copied from interface: TransferProgressMonitor

update the progress of the specified transfer

Specified by:

updateProgress in interface TransferProgressMonitor

Parameters:

transferId - String

currPos - int

Throws:

TransferException

See Also:

TransferProgressMonitor.updateProgress(java.lang.String, int)

updateStatus

public void updateStatus(String transferId,
                         TransferProgress.Status status)
                  throws TransferException

Description copied from interface: TransferProgressMonitor

update the startus of the transfer

Specified by:

updateStatus in interface TransferProgressMonitor

Parameters:

transferId - String

status - Status

Throws:

TransferException

See Also:

TransferProgressMonitor.updateStatus(java.lang.String, org.alfresco.service.cmr.transfer.TransferProgress.Status)

getLogInputStream

public InputStream getLogInputStream(String transferId)
                              throws TransferException

Specified by:

getLogInputStream in interface TransferProgressMonitor

Throws:

TransferException