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

Class FormatIdentifierSiegfried

java.lang.Object

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

All Implemented Interfaces:

FormatIdentifier, VitamAutoCloseable, AutoCloseable

public class FormatIdentifierSiegfried
extends Object
implements FormatIdentifier

Siegfried implementation of format identifier

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRONOM_NAMESPACE Pronom namespace
static String	UNKNOW_NAMESPACE Unknown namespace

Constructor Summary

Constructors

Constructor and Description
FormatIdentifierSiegfried(Map<String,Object> configurationProperties) Configuration should come with 'client', 'rootPath' and 'versionPath' mandatory parameters.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

PRONOM_NAMESPACE

public static final String PRONOM_NAMESPACE

Pronom namespace

See Also:

Constant Field Values

UNKNOW_NAMESPACE

public static final String UNKNOW_NAMESPACE

Unknown namespace

See Also:

Constant Field Values

Constructor Detail

FormatIdentifierSiegfried

public FormatIdentifierSiegfried(Map<String,Object> configurationProperties)
                          throws FormatIdentifierTechnicalException

Configuration should come with 'client', 'rootPath' and 'versionPath' mandatory parameters. If client is 'http': 'host' and 'port' are mandatory. If not, mock client is used.

Parameters:

configurationProperties - the configuration properties needed to instantiate Siegfried format identifier

Throws:

FormatIdentifierTechnicalException - If a technical error occures when the version path is created

IllegalArgumentException - if mandatory parameter are not given or null

Method Detail

status

public FormatIdentifierInfo status()
                            throws FormatIdentifierTechnicalException,
                                   FormatIdentifierNotFoundException

Description copied from interface: FormatIdentifier

Get format identifier status

Specified by:

status in interface FormatIdentifier

Returns:

The format identifier software information containing version

Throws:

FormatIdentifierTechnicalException - for any other technical exception

FormatIdentifierNotFoundException - if the given identifier could not responds

analysePath

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

Description copied from interface: FormatIdentifier

Identify the format of the file identified by its path

Specified by:

analysePath in interface FormatIdentifier

Parameters:

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

FormatIdentifierTechnicalException - for any other technical exception

FormatIdentifierBadRequestException - if the given path dont match a file

FormatIdentifierNotFoundException - if the given identifier could not responds

close

public void close()

Specified by:

close in interface VitamAutoCloseable

Specified by:

close in interface AutoCloseable