Differences between revisions 11 and 12
⇤ ← Revision 11 as of 2008-10-17 13:16:31 →
Size: 1491
Editor: bam
Comment:
← Revision 12 as of 2010-03-17 13:08:50 → ⇥
Size: 1495
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 11: Line 11:
WSDL: attachment:DOMSFileCharacterizer.xml WSDL: [[attachment:DOMSFileCharacterizer.xml]]

File characterization API

A webservice is provided, that given a URL will provide output of characterization tools, and a file format ID.

The concept is that the output of this webservice must be included in a technical datastream for the file object. Also, the format ID must be provided in technical metadata.

File Characterization API

WSDL: DOMSFileCharacterizer.xml

The following describes those methods of the File Characterization API that may be called by the GUI.

characterizeFile

Generates characterization output from analysis of file.

Input parameters:

  • org.apache.axis.types.URI fileURI URL to the file to be characterized.

Returns:

  • FileCharacterization Characterisation message and a format ID. Data structure summarized below.

Throws:

  • IOException If the characterizer failed downloading the file.

  • NoSuchAlgorithmException This exception should never be thrown.

Data structures

FileCharacterization

Returned by characterizeFile.

Characterisation response. Contains the following private fields. Each has corresponding getter and setter methods.

  • byte[] characterizationOutput The output of the characterization tool.

  • String pronomID The PRONOM file format ID.

  • String validationStatus Whether or not the format of the file is valid. Value "VALID" or "INVALID".

  • String md5CheckSum Checksum of the file.

File characterization API (last edited 2010-03-17 13:08:50 by localhost)