The File Store API on sillysky.net

CRecordFileStoreAddFileToList

Tue, 09 Dec 2025 00:00:00 +0000

This is an internal message from FileStores.

It is used to add a local file (for example, one that has just been created) from the Filestore directory to the FileStore's internal list of all managed files.

{
    "id": "15e58db7-41b9-48c6-9cb8-6a1e76255481",
    "name": "FILE_STORE_ADD_FILE_TO_LIST",
    "isNanoService": "false",
    "type": "REQUEST",
    "namespaces": "",
    "description": "Add a file to the file list.",
    "slots": [
        {
            "key": "1",
            "name": "FILE",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "RECORD",
            "description": "The file description (CRecordFileStoreFile)."
        }
    ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	File	REQUEST	MANDATORY	RECORD	The file description, which must be a CRecordFileStoreFile type record.

Record Usage

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

CRecordFileStoreAddLocalFile

Tue, 09 Dec 2025 00:00:00 +0000

This message imports a local file into the FileStore of a nyssr.net node.

This message belongs to the FileStore API. The message is a nanoservice of the SYSTEM namespace.

{
  "id": "e62b8dea-1596-415a-b054-3fb15fd4d354",
  "name": "FILE_STORE_ADD_LOCAL_FILE",
  "description": "Add a local file to the file store.",
  "isNanoService": "true",
  "type": "REQUEST",
  "namespaces": "SYSTEM",
  "slots": [
    {
      "key": "1",
      "name": "PATH",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The path of the file."
    },
    {
      "key": "2",
      "name": "RELATIVE_DESTINATION_PATH",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The relative path of the file in the storage directory (without file name)."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	PATH	REQUEST	MANDATORY	STRING	The path of the file to import.
2	RELATIVE_DESTINATION_PATH	REQUEST	MANDATORY	STRING	All files in FileStore are identified by a relative path to the FileStore base directory.
Example: “images/admin.jpeg”

While the relative path of the file serves as the key to finding it, the file path is an absolute path where the file can be found before import. Thus, the relative path may significantly differ from the current path.

CRecordFileStoreFile

Tue, 09 Dec 2025 00:00:00 +0000

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.

CRecordFileStoreGetChunk

Tue, 09 Dec 2025 00:00:00 +0000

This is an internal message from FileStores.

FileStores don't transmit entire files at once to avoid clogging network lines. Every file download is split into many small chunks. This message is used to retrieve one chunk of a file from another FileStore.

{
    "id": "60ff0699-bca8-400b-a997-7a1bbb8724c9",
    "name": "FILE_STORE_GET_CHUNK",
    "description": "Get a file chunk from a network file store.",
    "isNanoService": "false",
    "type": "REQUEST",
    "slots": [
        {
            "key": "hash",
            "name": "HASH",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "STRING",
            "description": "The hash of the file."
            },
        {
            "key": "pos",
            "name": "CHUNK_POSITION",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "LONG",
            "description": "The position of the chunk in the file."
            },
        {
            "key": "len",
            "name": "CHUNK_LENGTH",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "INT",
            "description": "The length of the chunk."
            },
        {
            "key": "bytes",
            "name": "BYTES",
            "direction": "RESPONSE",
            "presenceConstraint": "MANDATORY",
            "type": "BYTE_ARRAY",
            "description": "The bytes (and length) of the chunk."
        }
    ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
hash	HASH	REQUEST	MANDATORY	STRING	The hash of the file.
pos	CHUNK_POSITION	REQUEST	MANDATORY	LONG	The position of the chunk in the file.
len	CHUNK_LENGTH	REQUEST	MANDATORY	INT	The length of the chunk.
bytes	BYTES	RESPONSE	MANDATORY	BYTE_ARRAY	The bytes (and length) of the chunk.

Record Usage

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

CRecordFileStoreGetFileInfo

Tue, 09 Dec 2025 00:00:00 +0000

The message retrieves information about a file stored in a The File Store API.

This message belongs to the FileStore API. However, when it is sent to the The File Registry API, the FileRegistry selects a FileStore that hosts the requested file and forwards the message to that FileStore. In this way, the sender not only receives the file's data but also learns which FileStore it is stored in.

{
  "id": "eddce1c9-070c-420b-b08a-709ac4ad8996",
  "name": "FILE_STORE_GET_FILE_INFO",
  "description": "Get the metadata for a file from a network file store.",
  "isNanoService": "true",
  "type": "REQUEST",
  "namespaces": "SYSTEM",
  "slots": [
    {
      "key": "1",
      "name": "FILE",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "RECORD",
      "description": "A single file record."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	FILE	REQUEST	MANDATORY	RECORD	When a request is made, the hash and/or path of the file is stored in the CRecordFileStoreFile record. The recipient then fills in the remaining fields of the record for the response.

Usage

Request

The payload of the record consists only of a record of type CRecordFileStoreFile. In the request (outbound), the path and optionally the hash of the requested file are transmitted. In the response (return), the record contains the remaining information about the requested file if successful.

CRecordFileStoreNotifyFileDownloaded

Tue, 09 Dec 2025 00:00:00 +0000

This is an internal message from FileStores.

A file was downloaded by a FileStore Job from another FileStore. The FileStore will add the file to its internal lists and subsequently register it with the File Registry.

{
    "id": "b39ebcec-07f7-4442-a448-6cf6229bbcf2",
    "name": "FILE_STORE_NOTIFY_FILE_DOWNLOADED",
    "description": "Notification: A file has been downloaded and saved into the indexed directory.",
    "isNanoService": "false",
    "type": "NOTIFICATION",
    "slots": [
        {
            "key": "1",
            "name": "PATH",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "STRING",
            "description": "The requested path."
        },
        {
            "key": "2",
            "name": "HASH",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "STRING",
            "description": "The requested hash."
        },
        {
            "key": "3",
            "name": "FILE_ENTRY",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "RECORD",
            "description": "A file record (CRecordFileStoreFile) on success."
        },
        {
            "key": "4",
            "name": "BYTES",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "BYTE_ARRAY",
            "description": "The bytes if the byte array was requested."
        },
        {
            "key": "5",
            "name": "FILE",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "OBJECT",
            "description": "The file object if a file object was requested."
        },
        {
            "key": "6",
            "name": "RESULT_CODE",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "INT",
            "description": "The result code of the download."
        },
        {
            "key": "7",
            "name": "RESULT_TEXT",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "STRING",
            "description": "The result text of the download. This error text originates from the download job."
        }
    ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	PATH	REQUEST	MANDATORY	STRING	The requested path.
2	HASH	REQUEST	MANDATORY	STRING	The requested hash.
3	FILE_ENTRY	REQUEST	MANDATORY	RECORD	A file record (CRecordFileStoreFile) on success.
4	BYTES	REQUEST	MANDATORY	BYTE_ARRAY	The bytes if the byte array was requested.
5	FILE	REQUEST	MANDATORY	OBJECT	The file object if a file object was requested.
6	RESULT_CODE	REQUEST	MANDATORY	INT	The result code of the download. This error code originates from the download job.
7	RESULT_TEXT	REQUEST	MANDATORY	STRING	The result text of the download. This error text originates from the download job.

Record Usage

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

CRecordFileStoreNotifyFileImported

Tue, 09 Dec 2025 00:00:00 +0000

This is an internal message from FileStores.

This message serves as a notification from a file import job to the FileStore. It indicates that a new file has been successfully imported. The FileStore will subsequently add the file to its internal lists and register it with the File Registry.

{
    "id": "02bf09f0-d1d8-40af-9788-e9a46c884c74",
    "name": "FILE_STORE_NOTIFY_FILE_IMPORTED",
    "description": "Notification: A file has been imported into the indexed directory.",
    "isNanoService": "false",
    "type": "NOTIFICATION",
    "slots": [
        {
            "key": "1",
            "name": "FILE_RECORD",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "RECORD",
            "description": "The file record. Type: CRecordFileStoreFile."
        }
    ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	FILE_RECORD	REQUEST	MANDATORY	RECORD	The file record (CRecordFileStoreFile).

Record Usage

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

CRecordFileStoreRequestFile

Tue, 09 Dec 2025 00:00:00 +0000

Request a file from a The File Store API. This request should always be sent to the local FileStore, as it will download the file from another FileStore if necessary and then return it in the response.

This message belongs to the FileStore API. The message is a nanoservice of the SYSTEM namespace.

{
    "id": "0b85e177-500e-47dc-b794-4675e0985d94",
    "name": "FILE_STORE_REQUEST_FILE",
    "description": "Request a file from the local file store.",
    "isNanoService": "true",
    "type": "REQUEST",
    "namespaces": "SYSTEM",
    "slots": [
        {
          "key": "path",
          "name": "PATH",
          "direction": "REQUEST",
          "presenceConstraint": "CONDITIONAL_EXCLUSIVE",
          "type": "STRING",
          "description": "The relative path of the file.\nCan be null, if hash is provided."
        },
        {
          "key": "hash",
          "name": "HASH",
          "direction": "REQUEST",
          "presenceConstraint": "CONDITIONAL_EXCLUSIVE",
          "type": "STRING",
          "description": "MD5 hash in base32 (use CMd5.toBase32()).\nCan be null, if path is provided."
        },
        {
          "key": "how",
          "name": "DELIVERY_TYPE",
          "direction": "REQUEST",
          "presenceConstraint": "OPTIONAL",
          "type": "BYTE",
          "description": "1 (default) as byte array, 2 as java.util.File."
        },
        {
          "key": "rec",
          "name": "FILE_RECORD",
          "direction": "RESPONSE",
          "presenceConstraint": "MANDATORY",
          "type": "RECORD",
          "description": "A record of type CRecordFileStoreFile."
        },
        {
          "key": "file",
          "name": "FILE",
          "direction": "RESPONSE",
          "presenceConstraint": "CONDITIONAL_EXCLUSIVE",
          "type": "OBJECT",
          "description": "A java.util.File."
        },
        {
          "key": "ba",
          "name": "BYTES",
          "direction": "RESPONSE",
          "presenceConstraint": "CONDITIONAL_EXCLUSIVE",
          "type": "BYTE_ARRAY",
          "description": "The bytes of the file."
        }
    ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
path	PATH	REQUEST	CONDITIONAL_EXCLUSIVE	STRING	The relative path of the file.
Can be null, if hash is provided.
hash	HASH	REQUEST	CONDITIONAL_EXCLUSIVE	STRING	MD5 hash in base32 (use CMd5.toBase32()).
Can be null, if path is provided.
how	DELIVERY_TYPE	REQUEST	OPTIONAL	BYTE	1 (default) as a byte array
2 as java.util.File object.
rec	FILE_RECORD	RESPONSE	MANDATORY	RECORD	A record of type CRecordFileStoreFile.
file	FILE	RESPONSE	CONDITIONAL_EXCLUSIVE	OBJECT	If a java.util.File object was requested, the object for a file in the local FileStore is delivered here if successful.
ba	BYTES	RESPONSE	CONDITIONAL_EXCLUSIVE	BYTE_ARRAY	If the data in the file was requested, the byte array of the file contents is delivered here if successful.

The request requires specifying the relative path of the file. Optionally, a hash can be included if a specific version of the file is needed. Furthermore, you can specify whether the file should be delivered as a byte array (default) or as a local file.

CRecordFileStoreStoreChunk

Tue, 09 Dec 2025 00:00:00 +0000

This is an internal message from FileStores.

This message is used when files are transferred from one FileStore to another. Files are not transferred in one piece but in blocks (Default: 10000 bytes per block). This specific message is used to transfer a single file block.

{
    "id": "def6693e-5729-44a5-9532-dc5b872375d5",
    "name": "FILE_STORE_STORE_CHUNK",
    "description": "Store a file chunk into a network file store.",
    "isNanoService": "false",
    "type": "REQUEST",
    "slots": [
        {
            "key": "hash",
            "name": "HASH",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "STRING",
            "description": "The hash of the file."
        },
        {
            "key": "bytes",
            "name": "BYTES",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "BYTE_ARRAY",
            "description": "The bytes (and length) of the chunk."
        },
        {
            "key": "pos",
            "name": "FILE_POSITION",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "LONG",
            "description": "The file position of the chunk."
        }
    ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
hash	HASH	REQUEST	MANDATORY	STRING	The MD5 hash of the file (Base64 encoded).
bytes	BYTES	REQUEST	MANDATORY	BYTE_ARRAY	The bytes (and length) of the chunk.
pos	FILE_POSITION	REQUEST	MANDATORY	LONG	The file position of the chunk.

Record Usage

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

CRecordFileStoreStoreFile

Tue, 09 Dec 2025 00:00:00 +0000

This is an internal message from FileStores.

This message saves a file from a target to a file store. The accompanying record contains the file description. After receiving the message, the file store begins requesting the first chunks.

{
    "id": "b88cdb0c-fb4f-4910-9bdd-c1b18257c5bd",
    "name": "FILE_STORE_STORE_FILE",
    "description": "Store a file into a network file store.",
    "isNanoService": "false",
    "type": "REQUEST",
    "slots": [
        {
            "key": "1",
            "name": "FILE",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "RECORD",
            "description": "A single file record. Type: CRecordFileStoreFile."
        }
    ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	FILE	REQUEST	MANDATORY	RECORD	The CRecordFileStoreFile record contains the description of the file to be stored in 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.