com.exlibris.dps.repository.plugin

Interface CustomFixityPlugin

public interface CustomFixityPlugin

Plugin for user defined fixity (checksum).
This plugin interface only supports java implementation.

Author:

PeterK

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAgent() Returns the agent name.
java.lang.String	getAlgorithm() Returns the fixity algorithm.
java.util.List<java.lang.String>	getErrors() Returns list of mismatches detected during fixity calculation.
java.lang.String	getFixity(java.lang.String filePath, java.lang.String oldFixity) Calculates and returns fixity for the given file.

Method Detail

getFixity

java.lang.String getFixity(java.lang.String filePath,
                           java.lang.String oldFixity)
                    throws java.lang.Exception

Calculates and returns fixity for the given file. If the old fixity isn't null and the new fixity doesn't match it, it is possible to add a list of detailed errors to help identify the source of the problem.

Parameters:

filePath - the path to the file

oldFixity - the value of the previous fixity on this file, null if this is the first time this type of fixity is calculated on the file

Returns:

the new fixity

Throws:

java.lang.Exception - on any error during the actual fixity calculation

getAlgorithm

java.lang.String getAlgorithm()

Returns the fixity algorithm.

Returns:

The name of the algorithm this plugin calculates

getAgent

java.lang.String getAgent()

Returns the agent name.

Returns:

The agent of the plugin type

getErrors

java.util.List<java.lang.String> getErrors()

Returns list of mismatches detected during fixity calculation. These errors should include additional information when the checksum values mismatch. For example: checksum diff or possible location of file difference.
Any other errors (like IOException during checksum calculation) should be thrown.

Returns:

list of mismatches detected during fixity calculation.