Package org.alfresco.repo.transfer

Interface TransferSummaryReport

  • All Known Implementing Classes:
    TransferSummaryReportImpl
    public interface TransferSummaryReport
    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)

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void finishSummaryReport()
      called to close the report file
      void logSummaryComment​(java.lang.Object obj)
      log an ad-hoc message
      void logSummaryCreated​(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, org.alfresco.service.cmr.repository.NodeRef newParent, java.lang.String newPath, boolean orphan)
      Log the creation of a new node
      void logSummaryDeleted​(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, java.lang.String path)
      Log the deletion of a node
      void logSummaryException​(java.lang.Object obj, java.lang.Throwable ex)
      log an ad-hoc message and an exception
      void logSummaryMoved​(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef destNodeRef, java.lang.String oldPath, org.alfresco.service.cmr.repository.NodeRef newParent, java.lang.String newPath)
      After the transfer has completed this method reads the log.
      void logSummaryUpdated​(org.alfresco.service.cmr.repository.NodeRef sourceNode, org.alfresco.service.cmr.repository.NodeRef destNode, java.lang.String path)
      Log the creation of a new node
      void logSummaryUpdateStatus​(TransferProgress.Status status)
      update the status of the transfer

    • Method Detail

      • logSummaryCreated

        void logSummaryCreated​(org.alfresco.service.cmr.repository.NodeRef sourceNode,
                       org.alfresco.service.cmr.repository.NodeRef destNode,
                       org.alfresco.service.cmr.repository.NodeRef newParent,
                       java.lang.String newPath,
                       boolean orphan)
        Log the creation of a new node
        Parameters:
        sourceNode - NodeRef
        destNode - NodeRef
        newParent - NodeRef
        newPath - String
        orphan - boolean

      • logSummaryUpdated

        void logSummaryUpdated​(org.alfresco.service.cmr.repository.NodeRef sourceNode,
                       org.alfresco.service.cmr.repository.NodeRef destNode,
                       java.lang.String path)
        Log the creation of a new node
        Parameters:
        sourceNode - NodeRef
        destNode - NodeRef
        path - The path of the updated node

      • logSummaryDeleted

        void logSummaryDeleted​(org.alfresco.service.cmr.repository.NodeRef sourceNode,
                       org.alfresco.service.cmr.repository.NodeRef destNode,
                       java.lang.String path)
        Log the deletion of a node
        Parameters:
        sourceNode - NodeRef
        destNode - NodeRef
        path - The path of the updated node

      • logSummaryMoved

        void logSummaryMoved​(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                     org.alfresco.service.cmr.repository.NodeRef destNodeRef,
                     java.lang.String oldPath,
                     org.alfresco.service.cmr.repository.NodeRef newParent,
                     java.lang.String newPath)
        After the transfer has completed this method reads the log.
        Parameters:
        sourceNodeRef - NodeRef
        destNodeRef - NodeRef
        oldPath - String
        newParent - NodeRef
        newPath - String

      • logSummaryException

        void logSummaryException​(java.lang.Object obj,
                         java.lang.Throwable ex)
                  throws TransferException
        log an ad-hoc message and an exception
        Parameters:
        obj - Object
        ex - Throwable
        Throws:
        TransferException

      • finishSummaryReport

        void finishSummaryReport()
        called to close the report file