fr.gouv.vitam.common.format.identification

Interface FormatIdentifier

All Superinterfaces:

AutoCloseable, VitamAutoCloseable

All Known Implementing Classes:

FormatIdentifierSiegfried

public interface FormatIdentifier
extends VitamAutoCloseable

Format identifier interface

Method Summary

Modifier and Type	Method and Description
List<FormatIdentifierResponse>	analysePath(Path pathToFile) Identify the format of the file identified by its path
FormatIdentifierInfo	status() Get format identifier status

Methods inherited from interface fr.gouv.vitam.common.model.VitamAutoCloseable

close

Method Detail

status

FormatIdentifierInfo status()
                     throws FormatIdentifierTechnicalException,
                            FormatIdentifierNotFoundException

Get format identifier status

Returns:

The format identifier software information containing version

Throws:

FormatIdentifierNotFoundException - if the given identifier could not responds

FormatIdentifierTechnicalException - for any other technical exception

analysePath

List<FormatIdentifierResponse> analysePath(Path pathToFile)
                                    throws FileFormatNotFoundException,
                                           FormatIdentifierTechnicalException,
                                           FormatIdentifierBadRequestException,
                                           FormatIdentifierNotFoundException

Identify the format of the file identified by its path

Parameters:

pathToFile - the path to the file to be identified

Returns:

the FormatIdentifierResponse containing information about the format of the file

Throws:

FileFormatNotFoundException - if a file format is not found by the identifier

FormatIdentifierBadRequestException - if the given path dont match a file

FormatIdentifierNotFoundException - if the given identifier could not responds

FormatIdentifierTechnicalException - for any other technical exception