Cookies improve the way our website works, by using this website you are agreeing to our use of cookies. For more information see our privacy policy. OK

CRecordFileStoreNotifyFileDownloaded

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.

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