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 Details

    • logSummaryCreated

      void logSummaryCreated(NodeRef sourceNode, NodeRef destNode, NodeRef newParent, 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(NodeRef sourceNode, NodeRef destNode, String path)
      Log the creation of a new node
      Parameters:
      sourceNode - NodeRef
      destNode - NodeRef
      path - The path of the updated node

    • logSummaryDeleted

      void logSummaryDeleted(NodeRef sourceNode, NodeRef destNode, String path)
      Log the deletion of a node
      Parameters:
      sourceNode - NodeRef
      destNode - NodeRef
      path - The path of the updated node

    • logSummaryMoved

      void logSummaryMoved(NodeRef sourceNodeRef, NodeRef destNodeRef, String oldPath, NodeRef newParent, String newPath)
      After the transfer has completed this method reads the log.
      Parameters:
      sourceNodeRef - NodeRef
      destNodeRef - NodeRef
      oldPath - String
      newParent - NodeRef
      newPath - String

    • logSummaryComment

      void logSummaryComment(Object obj) throws TransferException
      log an ad-hoc message
      Parameters:
      obj - Object
      Throws:
      TransferException

    • logSummaryException

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

    • logSummaryUpdateStatus

      void logSummaryUpdateStatus(TransferProgress.Status status) throws TransferException
      update the status of the transfer
      Parameters:
      status - TransferProgress.Status
      Throws:
      TransferException

    • finishSummaryReport

      void finishSummaryReport()
      called to close the report file