com.exlibris.dps.sdk.formatidentification

Interface FormatIdentificationPlugin

public interface FormatIdentificationPlugin

Interface for the FormatIdentificationPlugin type.
The plugin performs file format identification
This plugin interface only supports java implementation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAgentName()
java.lang.String	getAgentSignatureVersion()
java.lang.String	getAgentVersion()
java.lang.String	getFormatRegistryName()
FormatIdentificationResult	identifyFormat(java.lang.String filePath) Performs the file format identification.

Method Detail

getAgentName

java.lang.String getAgentName()

Returns:

- format identification plugin agent name

getAgentVersion

java.lang.String getAgentVersion()

Returns:

- format identification plugin agent version

getAgentSignatureVersion

java.lang.String getAgentSignatureVersion()

Returns:

- format identification plugin agent signature file version

getFormatRegistryName

java.lang.String getFormatRegistryName()

Returns:

- format identification plugin registry name

identifyFormat

FormatIdentificationResult identifyFormat(java.lang.String filePath)

Performs the file format identification. Return result that contain a list of format matches and the relevant format identification method (SIGNATURE, CONTAINER or EXTENSION)

Parameters:

- - filePath - the path to the file that needs format identification

Returns:

- FormatIdentificationResult - list of format matches and the relevant format identification method