org.bitrepository.integrityservice.reports

Class BasicIntegrityReporter

java.lang.Object

org.bitrepository.integrityservice.reports.BasicIntegrityReporter

All Implemented Interfaces:

IntegrityReporter

public class BasicIntegrityReporter
extends Object
implements IntegrityReporter

Constructor Summary

Constructors

Constructor and Description
BasicIntegrityReporter(String collectionID, String workflowType, File reportsDir)

Method Summary

Methods

Modifier and Type	Method and Description
void	generateReport() Creates the human readable report for the entire integrity issue.
String	generateSummaryOfReport() Create a human readable summary of the integrity issue.
String	getCollectionID() Return the ID of the collection that the report is about.
File	getReport() Retrieves the written report
boolean	hasIntegrityIssues()
boolean	hasReport() Method to test if a report is available
void	reportChecksumIssue(String fileID, String pillarID) Report that a file have a checksum issues on a given pillar
void	reportDeletedFile(String fileID) Report that a file has been deleted from the collection.
void	reportMissingChecksum(String fileID, String pillarID) Report that a file is missing a checksum on a given pillar
void	reportMissingFile(String fileID, String pillarID) Report that a file is missing from a pillar
void	reportObsoleteChecksum(String fileID, String pillarID) Report that a file have an obsolete checksum on a given pillar

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicIntegrityReporter

public BasicIntegrityReporter(String collectionID,
                      String workflowType,
                      File reportsDir)

Method Detail

hasIntegrityIssues

public boolean hasIntegrityIssues()

Specified by:

hasIntegrityIssues in interface IntegrityReporter

Returns:

Whether the integrity check gave a positive result. E.g. returns false, if any integrity problems occurred (whether any files were missing, any disagreements about checksum, etc.).

hasReport

public boolean hasReport()

Description copied from interface: IntegrityReporter

Method to test if a report is available

Specified by:

hasReport in interface IntegrityReporter

Returns:

true if an integrity report is available.

getReport

public File getReport()
               throws FileNotFoundException

Description copied from interface: IntegrityReporter

Retrieves the written report

Specified by:

getReport in interface IntegrityReporter

Throws:

FileNotFoundException - if no report is found

generateReport

public void generateReport()
                    throws IOException

Description copied from interface: IntegrityReporter

Creates the human readable report for the entire integrity issue. This involves all the specifics, e.g. at single file-level.

Specified by:

generateReport in interface IntegrityReporter

Throws:

IOException

generateSummaryOfReport

public String generateSummaryOfReport()

Description copied from interface: IntegrityReporter

Create a human readable summary of the integrity issue. Should only contain the overall issue description, not specifics.

Specified by:

generateSummaryOfReport in interface IntegrityReporter

Returns:

The summary of the integrity issue.

getCollectionID

public String getCollectionID()

Description copied from interface: IntegrityReporter

Return the ID of the collection that the report is about.

Specified by:

getCollectionID in interface IntegrityReporter

Returns:

The collectionID

reportDeletedFile

public void reportDeletedFile(String fileID)
                       throws IOException

Description copied from interface: IntegrityReporter

Report that a file has been deleted from the collection. Note this is not considered a integrity issue.

Specified by:

reportDeletedFile in interface IntegrityReporter

Parameters:

fileID - The ID of the file that has been removed

Throws:

IOException - if writing fails

reportMissingFile

public void reportMissingFile(String fileID,
                     String pillarID)
                       throws IOException

Description copied from interface: IntegrityReporter

Report that a file is missing from a pillar

Specified by:

reportMissingFile in interface IntegrityReporter

Parameters:

fileID - The ID of the file that is missing

pillarID - The ID of the pillar that the file is missing on.

Throws:

IOException

reportChecksumIssue

public void reportChecksumIssue(String fileID,
                       String pillarID)
                         throws IOException

Description copied from interface: IntegrityReporter

Report that a file have a checksum issues on a given pillar

Specified by:

reportChecksumIssue in interface IntegrityReporter

Parameters:

fileID - The ID of the file that has a checksum issue

pillarID - The ID of the pillar with the checksum issue

Throws:

IOException

reportMissingChecksum

public void reportMissingChecksum(String fileID,
                         String pillarID)
                           throws IOException

Description copied from interface: IntegrityReporter

Report that a file is missing a checksum on a given pillar

Specified by:

reportMissingChecksum in interface IntegrityReporter

Parameters:

fileID - The ID of the file that is missing a checksum

pillarID - The ID of the pillar that does not have the checksum for the file

Throws:

IOException

reportObsoleteChecksum

public void reportObsoleteChecksum(String fileID,
                          String pillarID)
                            throws IOException

Description copied from interface: IntegrityReporter

Report that a file have an obsolete checksum on a given pillar

Specified by:

reportObsoleteChecksum in interface IntegrityReporter

Parameters:

fileID - The ID of the file with the obsolete checksum

pillarID - The ID of the pillar that have the obsolete checksum

Throws:

IOException