CRecordFileStoreFile: File Meta Data

This record is a data record for transporting information about a file.

This message belongs to the The File Store API API.

{
  "id": "2152ee2c-45fa-4f46-8ad1-e91c3b77fd0c",
  "name": "FILE_STORE_FILE",
  "description": "A file record.",
  "isNanoService": "false",
  "type": "DATA_RECORD",
  "slots": [
    {
      "key": "1",
      "name": "HASH",
      "type": "STRING",
      "description": "The hash of the file (base32 encoded)."
    },
    {
      "key": "2",
      "name": "PATH",
      "type": "STRING",
      "description": "The relative path of the file."
    },
    {
      "key": "3",
      "name": "FILE_LENGTH",
      "type": "LONG",
      "description": "The length of the file."
    },
    {
      "key": "4",
      "name": "TIME_OF_CREATION",
      "type": "INSTANT",
      "description": "Optional: The creation time stamp."
    },
    {
      "key": "5",
      "name": "TIME_OF_LAST_MODIFICATION",
      "type": "INSTANT",
      "description": "Optional: The time of the last modification."
    }
  ]
}

Slot Description

Key Name Type Description
1 HASH STRING The hash of the file (base32 encoded).
2 PATH STRING The relative path of the file.
3 FILE_LENGTH LONG The length of the file.
4 TIME_OF_CREATION INSTANT Optional: The creation time stamp.
5 TIME_OF_LAST_MODIFICATION INSTANT Optional: The time of the last modification.

This record is used in requests to and responses from the FileStore.

Record Usage

In nyssr.net, we typically don't exchange interfaces between projects. Instead, we use platform-independent Records to describe message formats.

One or more descriptions of these Records are stored in the JSON or XML format as record.json or record.xml within a directory. The Record Generator, an included Swing tool, generates helper classes from these files. These classes can then be used to type-safely write or read messages.

See also: