|
Size: 769
Comment:
|
Size: 1266
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = File characterization API here = | = File characterization API = |
| Line 15: | Line 15: |
| Generates a new PID. | Generates characterization output from analysis of file. |
| Line 18: | Line 18: |
| * {{{String infix}}} The PID of the object. | * {{{org.apache.axis.types.URI fileURI}}} URL to the file to be characterized. |
| Line 21: | Line 21: |
| * {{{String}}} The newly generated unique PID, possibly including the provided infix. | * {{{FileCharacterization}}} Characterisation message and a format ID. Data structure summarized below. === 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}}} * {{{String md5CheckSum}}} |
File characterization API
A webservice will be provided, that given a URL will provide output of characterization tools, and a file format ID. This API is yet to be defined.
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.
WSDL: attachment:FileCharacterizer.xml
File Characterization API
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.
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
String md5CheckSum