Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

Strictly speaking, inside a Zip file the structure is flat, so there is no "directories" but only file entries.  However, in practice almost all Zip tools give the illusion of directories by leveraging the slash characters '/' in the name of each Zip entry.  For our the discussion here, we follow this "directory" practice to make things more clearsuch practice and treat the inside of a Zip file as if it were a conventional filesystem.

Suppose there are 2 hypothetical volumes in the corpus: foo.001122, which has 5 pages, and bar.ark:/13960/t123, which has 3 pages.  Both volumes also have the associated METS xml files.  The client tries to request for these 2 volumes, and also tries to request for another volume gon.000000 which no longer exists in the corpus.

Request DescriptionZip Structure LayoutExplanation of Entries

Retrieve volumes

concat=false 

Expand

 

 

foo.001122/ is a directory named after the first volume, foo.001122.  The directory name underwent a Pairtree clean process, but since it does not contain any filesystem unsafe characters, the cleaned ID looks the same as the original

inside foo.001122/, files 00000001.txt through 00000005.txt are the 5 pages of this volume

mets.xml will also be inside of foo.001122/ if the request parameter mets=true

bar.ark+=13960=t123/ is a directory named after the second volume, bar.ark:/13960/t123.  The directory name underwent a Pairtree clean process so that filesystem-unsafe characters such as colons ':' and slashes '/' are escaped and replaced with filesystem-safe characters.

inside bar.ark+=13960=t123/, files 00000001.txt through 00000003.txt are the 3 pages of this volume

mets.xml will also be inside of bar.ark+=13960=t123/ if the request parameter mets=true

ERROR.err is a file at the top level.  It is represent if the request encountered some errors and the detailed error information is stored in this file.

 

 

 

1.1 OAuth2 Authentication

...