The bag resource is used by the Ingest-Server and Replication Shell. It describes the base attributes of a collection in Chronopolis.
Bag
id: Longname: Stringdepositor: StringcreatedAt: DateTime // The date the bag was created in the ingest serverupdatedAt: DateTime // The last time the bag was updatedcreator: String // The user who created the bag in the ingest serverlocation: String // Relative locationtokenLocation: String // Relative locationtagManifestDigest: String // Ignored in json outputtokenDigest: String // Ignored in json outputstatus: BagStatus // enum; ignored in json outputfixityAlgorithm: String // currently SHA-256size: Long // size in bytestotalFiles: Long // Number of files in the bag, including the tag filesreplicatingNodes: Set<Node> // Nodes who have successfully replicated the bagrequiredReplications: 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 }
| Field | Type | Description |
|---|---|---|
id | Long | The ID of the Bag |
size | Long | The bag's size in bytes |
name | String | The name of the Bag |
creator | String | The user who created the bag in the Ingest Server |
depositor | String | The organization to which the Bag belongs |
status | BagStatus | Status of the Bag |
totalFiles | Long | Number of files in the Bag, including the tag files |
createdAt | DateTime | The date the Bag was created in the ingest server |
updatedAt | DateTime | The last time the Bag was updated |
replicatingNodes | Set<Node> | Nodes who have successfully replicated the bag |
requiredReplications | int | Number of replications required for preservation |
bagStorage | StagingStorageModel | Active Staging Information for a bag's data |
tokenStorage | StagingStorageModel | Active Staging Information for a bag's tokens |
StagingStorageModel
Staging Information about where content is stored and fixity information for that data
| Field | Type | Description |
|---|---|---|
| size | Long | The total size of the staged data |
| path | String | The relative path to the staged data (can point to either a file or a directory) |
| region | Long | ID of the StorageRegion which the data is staged on |
| active | Boolean | Boolean flag showing if the data is still staged |
| totalFiles | Long | The number of files staged |
| fixities | Set<Fixity> | Fixity values of the staged data |
Fixity
Fixity Information for validating staged content
| Field | Type | Description |
|---|---|---|
| value | String | The computed digest |
| algorithm | String | The name of the algorithm used |
| createdAt | DateTime | The time of creation of the digest |
...
BagStatus
An enumerated type describing the various states a bag can have in its lifetime.
...
- (1.3.0-RELEASE) REPLICATED
- (1.1.1-RELEASE) STAGED
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": 2,
"size": 1030783586432,
"totalFiles": 173357,
"bagStorage": {
"active": true,
"size": 1030783586432,
"region": 1,
"totalFiles": 173357,
"path": "ncar/acadis_20150419",
"fixities": [
{
"value": "c9680a2ec9a367f2f218a3d90dbcde3bcff9ed3eb8f7d9c61e525ba1735270da",
"algorithm": "SHA-256",
"createdAt": "2017-11-30T11:02:50.85746Z"
}
]
},
"tokenStorage": {
"active": true,
"size": 1,
"region": 2,
"totalFiles": 1,
"path": "ncar/acadis_201504192015-06-06",
"fixities": [
{
"value": "67593e0c4b02a2cbeb1c2440589373654a44b7ef93c889f6290569e92ced21ea",
"algorithm": "SHA-256",
"createdAt": "2017-11-30T11:02:50.85746Z"
}
]
},
"createdAt": "2016-06-07T12:26:18.13944Z",
"updatedAt": "2016-06-07T12:26:18.13944Z",
"name": "acadis_20150419",
"creator": "admin",
"depositor": "ncar",
"status": "PRESERVED",
"requiredReplications": 3,
"replicatingNodes": [
"ncar",
"umiacs",
"ucsd"
]
} |