OCFL-JAVA-HTTP

Lightweight HTTP layer for an OCFL repository.

API

• GET /
  • returns {"OCFL ROOT": ...} as JSON
• GET /<object_id>/files
  • add includeDeleted=true URL param to request all files, not just currently active ones
  • add fields=state,size,mimetype,checksum,lastModified URL param to request 1 or more pieces of information about the files
    • state: "A" for currently active files, "D" for files that have been removed in a later OCFL version
    • size: # of bytes
    • checksum: adds "checksum": and "checksumType": "SHA-512"
    • lastModified: UTC timestamp, eg. 2020-11-25T20:30:43.73776Z
  • add objectTimestamps=true URL param to request object created/lastModified timestamps
  • returns {"version": "<head_version_number eg. v3", "object": {"created": "2020-11-20T20:30:43.73776Z", "lastModified": "2020-11-25T20:30:43.73776Z"}, files": {"file1": {"state": "A"}}} as JSON
  • returns 410 Gone if object has been deleted (ie. if all files have been removed from latest version)
• url params for POST/PUT/DELETE
  • message, userName, userAddress, created - these get added to OCFL version info (note: normally 'created' should not be used - it just defaults to now)
• POST /<object_id>/files
  • body: multipart/form-data
    • "params" field - JSON data in the form: {: {"checksum": , "checksumType": "MD5"/"SHA-512"/..., "location": }}
    • "files" field - 1 or more files to be added to the object
  • fails if the object already exists
• PUT /<object_id>/files
  • adding/updating files:
    • body: multipart/form-data (see description in POST section)
    • fails if the object doesn't exist or the files already exist
    • adding the updateExisting=true URL parameter allows updating existing files
  • renaming a file:
    • body: multipart/form-data
      • "rename" field - JSON data in the form: {"old": <old_file_name>, "new": <new_file_name>}
      • other fields/data are ignored
    • returns 404 if <object_id> or <old_file_name> doesn't currently exist, or 409 if <new_file_name> does currently exist
• DELETE /<object_id>/files
  • delete object (by removing all the files in a new version - doesn't actually purge any data)
  • returns 204, if successful (or if object was already deleted), 404 if object doesn't exist
• GET /<object_id>/files/<file_name>/content returns file contents
  • use "Range" header to request partial file contents
  • returns 410 Gone if object or file has been deleted
• DELETE /<object_id>/files/<file_name>
  • delete file <file_name> from object
  • returns 204 if successful (or if file was already deleted), 404 if <file_name> doesn't exist
• GET /<object_id>/versions
  • returns JSON versions data, eg: {"v1": {"created": "2020-11-25T20:30:43.73776Z", "user": "someone someone@school.edu", "message": "test message"}}
  • returns 404 if object doesn't exist
• GET /<object_id>/vN/files
  • retrieve list of files (like /<object_id>/files, but for a specific version)
  • includes "version": "vN" in the output
  • can request fields (like /<object_id>/files)
  • includeDeleted param is not allowed - this only queries the active files in a specific version
  • returns 404 if the object or version doesn't exist
• GET /<object_id>/vN/files/<file_name>/content
  • retrieve contents of file at version N
  • returns 404 if no object, no version, or no file in vN

Development

• test: mvn clean test
• generate executable jar: mvn clean verify
  • creates target/ocfl-java-http-0.1-SNAPSHOT-launcher.jar, which you can run with "java -jar target/ocfl-java-http-0.1-SNAPSHOT-launcher.jar"