org.alfresco.repo.transfer.fsr

Interface TransferListener

public interface TransferListener

The interface to implement in order to monitor and react to incoming transfers. Objects of this type can be registered with an instance of the HookableTransferMonitorImpl class via its HookableTransferMonitorImpl.setListeners(java.util.List) method.

Since:

4.0

Author:

Brian Remmington

Method Summary

Methods

Modifier and Type	Method and Description
void	created(String transferId, org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef parentNode, String newPath, boolean orphan) Called when a folder or file is created in response to an inbound transfer.
void	deleted(String transferId, org.alfresco.service.cmr.repository.NodeRef sourceNode, String path) Called when a folder or file is deleted in response to an inbound transfer.
void	moved(String transferId, org.alfresco.service.cmr.repository.NodeRef sourceNode, String oldPath, org.alfresco.service.cmr.repository.NodeRef newParent, String newPath) Called when a folder or file is moved in response to an inbound transfer.
void	statusChanged(String transferId, org.alfresco.service.cmr.transfer.TransferProgress.Status status) Called when an inbound transfer changes state.
void	updated(String transferId, org.alfresco.service.cmr.repository.NodeRef sourceNode, String path) Called when a file is updated in response to an inbound transfer.

Method Detail

created

void created(String transferId,
           org.alfresco.service.cmr.repository.NodeRef sourceNode,
           org.alfresco.service.cmr.repository.NodeRef parentNode,
           String newPath,
           boolean orphan)
             throws org.alfresco.service.cmr.transfer.TransferException

Called when a folder or file is created in response to an inbound transfer. The creation is complete at the point this operation is invoked.

Parameters:

transferId - The identifier of the transfer currently in progress.

sourceNode - The identifier of the node from the source repository

parentNode - The identifier of the parent node from the source repository

newPath - The path to the file/folder that has been created

orphan - True if the parent folder does not currently exist locally. In this case the new file/folder will have been created in a temporary location

Throws:

org.alfresco.service.cmr.transfer.TransferException - Throwing an exception from this operation will cause the transfer to stop.

deleted

void deleted(String transferId,
           org.alfresco.service.cmr.repository.NodeRef sourceNode,
           String path)
             throws org.alfresco.service.cmr.transfer.TransferException

Called when a folder or file is deleted in response to an inbound transfer. The deletion is complete at the point that this operation is invoked.

Parameters:

transferId - The identifier of the transfer currently in progress.

sourceNode - The identifier of the node from the source repository

path - The path of the file/folder that has been deleted

Throws:

org.alfresco.service.cmr.transfer.TransferException - Throwing an exception from this operation will cause the transfer to stop.

moved

void moved(String transferId,
         org.alfresco.service.cmr.repository.NodeRef sourceNode,
         String oldPath,
         org.alfresco.service.cmr.repository.NodeRef newParent,
         String newPath)
           throws org.alfresco.service.cmr.transfer.TransferException

Called when a folder or file is moved in response to an inbound transfer. The move is complete at the point this operation is invoked.

Parameters:

transferId - The identifier of the transfer currently in progress.

sourceNode - The identifier of the node from the source repository

oldPath - The location where the file/folder used to be

newParent - The identifier of the new parent node in the source repository

newPath - The location to which the file/folder has been moved

Throws:

org.alfresco.service.cmr.transfer.TransferException - Throwing an exception from this operation will cause the transfer to stop.

updated

void updated(String transferId,
           org.alfresco.service.cmr.repository.NodeRef sourceNode,
           String path)
             throws org.alfresco.service.cmr.transfer.TransferException

Called when a file is updated in response to an inbound transfer. The update is complete at the point this operation is invoked.

Parameters:

transferId - The identifier of the transfer currently in progress.

sourceNode - The identifier of the node from the source repository

path - The location of the file that has been updated.

Throws:

org.alfresco.service.cmr.transfer.TransferException - Throwing an exception from this operation will cause the transfer to stop.

statusChanged

void statusChanged(String transferId,
                 org.alfresco.service.cmr.transfer.TransferProgress.Status status)
                   throws org.alfresco.service.cmr.transfer.TransferException

Called when an inbound transfer changes state. See TransferProgress.Status for the possible statuses.

Parameters:

transferId - The identifier of the transfer currently in progress.

status - The new status of the transfer.

Throws:

org.alfresco.service.cmr.transfer.TransferException - Throwing an exception from this operation will cause the transfer to stop if it isn't already complete.

See Also:

TransferProgress.Status