Package fr.gouv.vitam.common.format.identification

# Interface FormatIdentifier

All Known Implementing Classes:
  `FormatIdentifierSiegfried`

public interface FormatIdentifier
Format identifier interface

- ## Method Summary

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

- ## Method Details

  - ### 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