mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-29 15:21:53 +00:00
7dd2291753
107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
107413: Merged DEV to 5.0.N (5.0.3)
106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Cleaning of Javadoc,
107565: MNT-13545 Fix compilation after merge of Javadoc
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
93 lines
2.6 KiB
Java
93 lines
2.6 KiB
Java
package org.alfresco.repo.transfer;
|
|
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.transfer.TransferException;
|
|
import org.alfresco.service.cmr.transfer.TransferProgress;
|
|
|
|
/**
|
|
* Used to log relevant changes to transfered files into a summary report of the
|
|
* entire replication job;
|
|
*
|
|
* It should log: created files, deleted, moved, *modified files and relevant
|
|
* errors while handling the files;
|
|
*
|
|
* *modified: each implementation would chose the definition of modified(actual
|
|
* content modification/ new version/ some properties updated)
|
|
*
|
|
*/
|
|
public interface TransferSummaryReport
|
|
{
|
|
|
|
/**
|
|
* Log the creation of a new node
|
|
*
|
|
* @param sourceNode NodeRef
|
|
* @param destNode NodeRef
|
|
* @param newParent NodeRef
|
|
* @param newPath String
|
|
* @param orphan boolean
|
|
*/
|
|
void logSummaryCreated(NodeRef sourceNode, NodeRef destNode, NodeRef newParent, String newPath, boolean orphan);
|
|
|
|
/**
|
|
* Log the creation of a new node
|
|
*
|
|
* @param sourceNode NodeRef
|
|
* @param destNode NodeRef
|
|
* @param path The path of the updated node
|
|
*/
|
|
void logSummaryUpdated(NodeRef sourceNode, NodeRef destNode, String path);
|
|
|
|
/**
|
|
* Log the deletion of a node
|
|
*
|
|
* @param sourceNode NodeRef
|
|
* @param destNode NodeRef
|
|
* @param path The path of the updated node
|
|
*/
|
|
void logSummaryDeleted(NodeRef sourceNode, NodeRef destNode, String path);
|
|
|
|
/**
|
|
* After the transfer has completed this method reads the log.
|
|
*
|
|
* @param sourceNodeRef NodeRef
|
|
* @param destNodeRef NodeRef
|
|
* @param oldPath String
|
|
* @param newParent NodeRef
|
|
* @param newPath String
|
|
*
|
|
*/
|
|
void logSummaryMoved(NodeRef sourceNodeRef, NodeRef destNodeRef, String oldPath, NodeRef newParent, String newPath);
|
|
|
|
/**
|
|
* log an ad-hoc message
|
|
*
|
|
* @param obj Object
|
|
* @throws TransferException
|
|
*/
|
|
void logSummaryComment(Object obj) throws TransferException;
|
|
|
|
/**
|
|
* log an ad-hoc message and an exception
|
|
*
|
|
* @param obj Object
|
|
* @param ex Throwable
|
|
* @throws TransferException
|
|
*/
|
|
void logSummaryException(Object obj, Throwable ex) throws TransferException;
|
|
|
|
/**
|
|
* update the status of the transfer
|
|
*
|
|
* @param status TransferProgress.Status
|
|
* @throws TransferException
|
|
*/
|
|
void logSummaryUpdateStatus(TransferProgress.Status status) throws TransferException;
|
|
|
|
/**
|
|
* called to close the report file
|
|
*/
|
|
void finishSummaryReport();
|
|
|
|
}
|