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

Interface SiegfriedClient

All Superinterfaces:

AutoCloseable, MockOrRestClient, VitamAutoCloseable

All Known Implementing Classes:

SiegfriedClientRest

public interface SiegfriedClient
extends MockOrRestClient

Siegfried client interface

Method Summary

Modifier and Type	Method	Description
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	analysePath(Path filePath)	Call siegfried instance to analyse the given file and format a Json response
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	status(Path filePath)	Call Siegfried instance to get disponibility and version

Methods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Method Details

analysePath

RequestResponse<com.fasterxml.jackson.databind.JsonNode> analysePath(Path filePath)
                                                              throws FormatIdentifierTechnicalException,
FormatIdentifierNotFoundException

Call siegfried instance to analyse the given file and format a Json response

Parameters:

filePath - The file path

Returns:

the identified format embedded in a RequestResponse

Throws:

FormatIdentifierTechnicalException - if some error occurs

FormatIdentifierNotFoundException

status

RequestResponse<com.fasterxml.jackson.databind.JsonNode> status(Path filePath)
                                                         throws FormatIdentifierTechnicalException,
FormatIdentifierNotFoundException

Call Siegfried instance to get disponibility and version

Parameters:

filePath - path to an empty folder (can be null)

Returns:

the identified version embedded in a RequestResponse

Throws:

FormatIdentifierTechnicalException

FormatIdentifierNotFoundException