Package org.alfresco.repo.transfer.report

Interface TransferReporter

All Known Implementing Classes:

TransferReporterImpl

public interface TransferReporter

Provides methods to create transfer report.

Method Summary

Modifier and Type	Method	Description
NodeRef	createTransferReport(String transferName, Exception e, TransferTarget target, TransferDefinition definition, List<TransferEvent> events, File snapshotFile)	Create a transfer report of failure
NodeRef	createTransferReport(String transferName, Transfer transfer, TransferTarget target, TransferDefinition definition, List<TransferEvent> events, File snapshotFile)	Create a transfer report of success
NodeRef	writeDestinationReport(String transferName, TransferTarget target, File tempFile)	Write the destination transfer report into the local repo.

Method Detail

createTransferReport

NodeRef createTransferReport(String transferName,
                             Transfer transfer,
                             TransferTarget target,
                             TransferDefinition definition,
                             List<TransferEvent> events,
                             File snapshotFile)

Create a transfer report of success

Parameters:

transferName - - the unique name of this transfer - probably based upon the time of transfer.

transfer - the transfer.

target - the target of the transfer

definition - the definition of the transfer

events - the transfer events generated by the transfer.

snapshotFile - the snapshot file

Returns:

the node ref of the transfer report

createTransferReport

NodeRef createTransferReport(String transferName,
                             Exception e,
                             TransferTarget target,
                             TransferDefinition definition,
                             List<TransferEvent> events,
                             File snapshotFile)

Create a transfer report of failure

Parameters:

transferName - - the unique name of this transfer - probably based upon the time of transfer.

e - the exception

target - the target of the transfer

definition - the definition of the transfer

events -

snapshotFile - the snapshot file

Returns:

the node ref of the transfer report

writeDestinationReport

NodeRef writeDestinationReport(String transferName,
                               TransferTarget target,
                               File tempFile)

Write the destination transfer report into the local repo.

Parameters:

transferName - the unique name of this transfer - probably based upon the time of transfer.

target - the target of the transfer

tempFile - the temporary file containing the contents of the destination side transfer report.

Returns:

the node ref of the transfer report