...
This document shows a series of diagrams depicting the structure of the three varieties of Fedora resources compared with their non-Fedora OCFL representations. Following the diagrams are detailed descriptions of the Fedora naming conventions.
The three varieties of Fedora resources are:
...
The following is the same single-binary OCFL object with both optional and required files used by Fedora.
Note: the ACL resources depicted in this and the following diagrams may be omitted if the given resource chooses to inherit its ACL from the repository's default ACL.
| No Format |
|---|
[object root]
├── 0=ocfl_object_1.0
├── inventory.json
├── inventory.json.sha512
└── v1/
├── inventory.json
├── inventory.json.sha512
└── content/
├── .fcrepo/
│ ├── fcr-root.json <-- Required "header" file holding system metadata about the binary. See description below.
│ ├── fcr-root~fcr-desc.json <-- Required "header" file holding system metadata about the binary's description. See description below.
│ └── fcr-root~fcr-acl.json <-- Optional, only present if this Fedora resource has its own ACL.
├── image.tiff
├── image.tiff~fcr-desc.nt <-- Required "binary description". See description below.
└── image.tiff~fcr-acl.nt <-- Optional, only present if this Fedora resource has its own ACL. |
...
A Fedora container resource is effectively an empty directory with LDP-defined behaviors depending on its "interaction model" (i.e. type: basic, direct, indirect), and associated metadata, along with an optional ACL. Since OCFL does not support empty directories as valid objects, there is no direct OCFL analogous object for a Fedora container atomic resource.
Note: the ACL resources depicted in this and the following diagrams may be omitted if the given resource chooses to inherit its ACL from the repository's default ACL.
| No Format |
|---|
[object root]
├── 0=ocfl_object_1.0
├── inventory.json
├── inventory.json.sha512
└── v1/
├── inventory.json
├── inventory.json.sha512
└── content/
├── .fcrepo/
│ ├── fcr-root.json <-- Required "header" file holding system metadata about the container. See description below.
│ └── fcr-root~fcr-acl.json <-- Optional, only present if this Fedora resource has its own ACL.
├── fcr-container.nt <-- Required file for holding user-properties describing the container. See description below.
└── fcr-container~fcr-acl.nt <-- Optional, only present if this Fedora resource has its own ACL. |
...
Archival groups are a way to collect several Fedora resources into a single OCFL object. The constituent Fedora resources (archival parts) can be any combination of containers and binaries.
Note: the ACL resources depicted in this diagram may be omitted if the given resource chooses to inherit its ACL from an ancestor resource in the nested hierarchy or even from the repository's default ACL.
| No Format |
|---|
[object root]
├── 0=ocfl_object_1.0
├── inventory.json
├── inventory.json.sha512
└── v1/
├── inventory.json
├── inventory.json.sha512
└── content/
├── .fcrepo/
│ ├── fcr-root.json <-- Required "header" file holding system metadata about the archival group.
│ ├── fcr-root~fcr-acl.json <-- Optional, only present if this Fedora resource has its own ACL.
│ ├── image.tiff.json <-- Required "header" file holding system metadata about the binary.
│ ├── image.tiff~fcr-desc.json <-- Required "header" file holding system metadata about the binary's description.
│ ├── image.tiff~fcr-acl.json <-- Optional, only present if this Fedora resource has its own ACL.
│ └── foo/ <-- Required nested structure within .fcrepo/ mirrors content structure
│ ├── foo.json <-- Required "header" file holding system metadata about the nested container.
│ ├── foo~fcr-acl.json <-- Optional, only present if this Fedora resource has its own ACL.
│ ├── bar.xml.json <-- Required "header" file holding system metadata about the binary.
│ ├── bar.xml~fcr-desc.json <-- Required "header" file holding system metadata about the binary's description.
│ └── bar.xml~fcr-acl.json <-- Optional, only present if this Fedora resource has its own ACL.
├── fcr-container.nt <-- Required file for holding user-properties describing the archival group container.
├── fcr-container~fcr-acl.nt <-- Optional, only present if this Fedora resource has its own ACL.
├── image.tiff
├── image.tiff~fcr-desc.nt <-- Required "binary description".
├── image.tiff~fcr-acl.nt <-- Optional, only present if this Fedora resource has its own ACL.
└── foo/
├── fcr-container.nt <-- Required file for holding user-properties describing the archival part container.
├── fcr-container~fcr-acl.nt <-- Optional, only present if this Fedora resource has its own ACL.
├── bar.xml
├── bar.xml~fcr-desc.nt <-- Required "binary description".
└── bar.xml~fcr-acl.nt <-- Optional, only present if this Fedora resource has its own ACL. |
...