The bag resource is used by the Ingest-Server and Replication Shell. It describes the base attributes of a collection in Chronopolis.
Bag
id: Long
name: String
depositor: String
createdAt: DateTime // The date the bag was created in the ingest server
updatedAt: DateTime // The last time the bag was updated
creator: String // The user who created the bag in the ingest server
location: String // Relative location
tokenLocation: String // Relative location
tagManifestDigest: String // Ignored in json output
tokenDigest: String // Ignored in json output
status: BagStatus // enum; ignored in json output
fixityAlgorithm: String // currently SHA-256
size: Long // size in bytes
totalFiles: Long // Number of files in the bag, including the tag files
replicatingNodes: Set<Node> // Nodes who have successfully replicated the bag
requiredReplications: Int // Number of replications required for preservation
OUT OF DATE JSON Example:
{ "id": 1, "name": "bag-0", "depositor": "test-depositor", "location": "bags/test-bag-0", "tokenLocation": "tokens/test-bag-0-tokens", "fixityAlgorithm": "SHA-256", "size": 14821 }
BagStatus
An enumerated type describing the various states a bag can have in its lifetime.
- DEPOSITED - The ingest-server has created a DB record for the bag after notification from an intake service
- INITIALIZED - The ingest-server has performed necessary tasks before tokenizing (extracting form an archive/file counts and sizes for metadata)
- TOKENIZED - The ingest-server has created ACE tokens for a bag and written them to a file for replication
- REPLICATING - Replication requests have been created for a bag which are currently in progress
- PRESERVED - All replication requests have finished successfully and the number of required replications have been met
- ERROR - Somewhere along the line something bad happened
Deprecated Status Enums
- (1.3.0-RELEASE) REPLICATED
- (1.1.1-RELEASE) STAGED
