org.nuxeo.ecm.platform.replication.common

Interface Reporter

All Known Implementing Classes:

NXReporter

public interface Reporter

The manager for the tracking log. The process keeps the track of the operations in a log file (export.log, import.log respectively) located in the same level with the “Replication Root”. This log file is serving for 2 purposes: allows resume and offers progress information. The log files contains:

a header with overall information (server connected, time of start, time of end, etc.)

a section for documentary base listing one by one:

current time

current index

the ID of documents processed

a section for every other types

An instance of the reporter can be obtained through the factory, don't get one directly through constructor.

Author:

cpriceputu

Method Summary

Methods

Modifier and Type	Method and Description
String	getHeader() Reads the header.
String	getLastEntry() Reads the last entry.
int	getNumberOfDocuments() Retrieves the number of entries.
long	getTotalSize() Computes the sum of the blob size.
void	writeEntry(String documentId, int blobsSize) Writes an entry at the end of the file.
void	writeHeader(String documentaryScope, boolean resume) Writes the header at the begin of the file.

Method Detail

writeEntry

void writeEntry(String documentId,
              int blobsSize)
                throws ClientException

Writes an entry at the end of the file.

Throws:

ClientException

writeHeader

void writeHeader(String documentaryScope,
               boolean resume)
                 throws ClientException

Writes the header at the begin of the file.

Throws:

ClientException

getHeader

String getHeader()
                 throws ClientException

Reads the header.

Throws:

ClientException

getLastEntry

String getLastEntry()
                    throws ClientException

Reads the last entry.

Throws:

ClientException

getNumberOfDocuments

int getNumberOfDocuments()
                         throws ClientException

Retrieves the number of entries.

Throws:

ClientException

getTotalSize

long getTotalSize()
                  throws ClientException

Computes the sum of the blob size.

Throws:

ClientException