Files
alfresco-community-repo/source/java/org/alfresco/repo/transfer/TransferSummaryReport.java
Alan Davis e70f3f9bd9 Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)
106496: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud)
      106441: Merged V4.2-BUG-FIX (4.2.5) to 5.0.N (5.0.3)
         106391: MNT-14209: Merged V4.2.1 (4.2.1.19) to V4.2-BUG-FIX (4.2.5)
            106130: Merged DEV to V4.2.1 (4.2.1.19)
               106126: MNT-14059 : Replication job reports list all content eligible for replication, not just content that was replicated that job run
                  - added code for the a new simplified (summary) transfer report on the destination server side
                  - updated the jUnit test to check that the new report is generated only when the property: transferservice.simple-report= true
                  - reusing the same format as the old destination side report for the new simplified report, but have only the relevant content
                  - did not modify/break compatibility of the code; did not changes methods in existing interfaces or communication protocols
                  - added a property for the transfer summary report location


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@106632 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2015-06-20 12:29:46 +00:00

99 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 transferId
* @param sourceNode
* @param destNode
* @param newPath
* @param orphan
*/
void logSummaryCreated(NodeRef sourceNode, NodeRef destNode, NodeRef newParent, String newPath, boolean orphan);
/**
* Log the creation of a new node
*
* @param transferId
* @param sourceNode
* @param destNode
* @param path
* The path of the updated node
* @param orphan
*/
void logSummaryUpdated(NodeRef sourceNode, NodeRef destNode, String path);
/**
* Log the deletion of a node
*
* @param transferId
* @param sourceNode
* @param destNode
* @param path
* The path of the deleted node
* @param orphan
*/
void logSummaryDeleted(NodeRef sourceNode, NodeRef destNode, String path);
/**
* After the transfer has completed this method reads the log.
*
* @param transferId
* @return the log
*/
void logSummaryMoved(NodeRef sourceNodeRef, NodeRef destNodeRef, String oldPath, NodeRef newParent, String newPath);
/**
* log an ad-hoc message
*
* @param transferId
* @param obj
* @throws TransferException
*/
void logSummaryComment(Object obj) throws TransferException;
/**
* log an ad-hoc message and an exception
*
* @param transferId
* @param obj
* @param ex
* @throws TransferException
*/
void logSummaryException(Object obj, Throwable ex) throws TransferException;
/**
* update the status of the transfer
*
* @param transferId
* @param status
* @throws TransferException
*/
void logSummaryUpdateStatus(TransferProgress.Status status) throws TransferException;
/**
* called to close the report file
*/
void finishSummaryReport();
}