The File Registry API on sillysky.net

CRecordFileRegistryAddFileInfos

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

This message is used for registering files in the FileRegistry. It contains an array with file information: relative path, hash value, file timestamps, and the address of the FileStore where the file is stored.

This message is part of the The File Registry API API.

{
  "id": "1b7e5d1b-9da8-40d4-9aa4-accb093e7f96",
  "name": "FILE_REGISTRY_ADD_FILE_INFOS",
  "isNanoService": false,
  "type": "REQUEST",
  "description": "Add information about files to the file registry.",
  "slots": [
    {
      "key": "rec",
      "name": "FILE_INFO",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "RECORD_ARRAY",
      "description": "The information about files to store in the file registry.
                      Records are from type FILE_REGISTRY_FILE_INFO"
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
rec	FILE_INFO	REQUEST	MANDATORY	RECORD_ARRAY	The information about files to store in the file registry.
Records are from type FILE_REGISTRY_FILE_INFO

Usage

// create a list of records with file information
final List<CRecord> list = new ArrayList<>();
for (...)
{
    final CRecord rec = CRecordFileRegistryFileInfo.create();
    CRecordFileRegistryFileInfo.setPath(rec,
                                        ...);
    CRecordFileRegistryFileInfo.setHash(rec,
                                        ...);
    CRecordFileRegistryFileInfo.setTimeOfLastModification(rec,
                                                          ...);
    CRecordFileRegistryFileInfo.setSourceAddress(rec,
                                                 ...);
    list.add(rec);
}

final CRecord[] arr = list.toArray(new CRecord[0]);

final IId microServiceId = CIdFactory.fromObject("file.registry");
final CEnvelope env = CEnvelope.forMicroService(microServiceId);

final CRecord record = CRecordFileRegistryAddFileInfos.create();
CRecordFileRegistryAddFileInfos.setFileInfo(record,
                                            arr);

sendNotification(env,
                 record);

Record Usage

CRecordFileRegistryFileInfo

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

This record contains information about a file.

This message is part of the The File Registry API API.

{
  "id": "e8994dd7-39e6-4acb-ab91-e680f2daf591",
  "name": "FILE_REGISTRY_FILE_INFO",
  "isNanoService": false,
  "type": "DATA_RECORD",
  "description": "information about a file.",
  "slots": [
    {
      "key": "1",
      "name": "PATH",
      "type": "STRING",
      "description": "The relative path of the file."
    },
    {
      "key": "2",
      "name": "HASH",
      "type": "STRING",
      "description": "The base-32-encoded hash of the file."
    },
    {
      "key": "3",
      "name": "TIME_OF_LAST_MODIFICATION",
      "type": "INSTANT",
      "description": "The time of the last modification of the file."
    },
    {
      "key": "4",
      "name": "SOURCE_ADDRESS",
      "type": "TARGET_ADDRESS",
      "description": "The target address of the source of the file (optional, if missing the sender address will be used)."
    }
  ]
}

Slot Description

Key	Name	Type	Description
1	PATH	STRING	The relative path of the file.
2	HASH	STRING	The base-32-encoded hash of the file.
3	TIME_OF_LAST_MODIFICATION	INSTANT	The time of the last modification of the file.
4	SOURCE_ADDRESS	TARGET_ADDRESS	The target address of the source of the file (optional, if missing the sender address will be used).

Usage

// create a list of records with file information
final List<CRecord> list = new ArrayList<>();
for (...)
{
    final CRecord rec = CRecordFileRegistryFileInfo.create();
    CRecordFileRegistryFileInfo.setPath(rec,
                                        ...);
    CRecordFileRegistryFileInfo.setHash(rec,
                                        ...);
    CRecordFileRegistryFileInfo.setTimeOfLastModification(rec,
                                                          ...);
    CRecordFileRegistryFileInfo.setSourceAddress(rec,
                                                 ...);
    list.add(rec);
}

final CRecord[] arr = list.toArray(new CRecord[0]);

final IId microServiceId = CIdFactory.fromObject("file.registry");
final CEnvelope env = CEnvelope.forMicroService(microServiceId);

final CRecord record = CRecordFileRegistryAddFileInfos.create();
CRecordFileRegistryAddFileInfos.setFileInfo(record,
                                            arr);

sendNotification(env,
                 record);

Record Usage

CRecordFileRegistryGetFileInfo

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

With it, we retrieve information about available files. The key to the files is the provided relative path of the desired file.

This message is part of the The File Registry API API.

{
  "id": "18124fad-2724-4d9f-bc85-1b835fde5a8d",
  "name": "FILE_REGISTRY_GET_FILE_INFO",
  "isNanoService": false,
  "type": "REQUEST",
  "description": "Get information about a file from the file registry.",
  "slots": [
    {
      "key": "path",
      "name": "PATH",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The relative path of the file."
    },
    {
      "key": "rec",
      "name": "FILE_INFO",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "RECORD_ARRAY",
      "description": "The information about files in the file registry.\nRecords are from type FILE_REGISTRY_FILE_INFO"
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
path	PATH	REQUEST	MANDATORY	STRING	The relative path of the file.
rec	FILE_INFO	RESPONSE	OPTIONAL	RECORD_ARRAY	The information about files in the file registry.
Records are from type FILE_REGISTRY_FILE_INFO

Usage

Send a request to the FileRegistry microservice.

CRecordFileRegistryGetFilePaths

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

Retrieve all relative paths of files registered in the The File Registry API that correspond to the given subdirectory. The number of returned files is limited to 1000.

This message is part of the The File Registry API API.

{
  "id": "fcbfda81-b40d-4bae-ad11-5a5d0a2da8f7",
  "name": "FILE_REGISTRY_GET_FILE_PATHS",
  "isNanoService": false,
  "type": "REQUEST",
  "description": "Get information about all (max 1000) file paths registered in the registry for a given directory.",
  "slots": [
    {
      "key": "1",
      "name": "DIRECTORY",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING",
      "description": "The relative directory to search for. Default is an empty String, i.e. all files registered in the file registry."
    }
    {
      "key": "2",
      "name": "PATHS",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING_ARRAY",
      "description": "All file paths registered in the file registry."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	DIRECTORY	REQUEST	OPTIONAL	STRING	The relative directory to search for. Default is an empty String, i.e. all files registered in the file registry.
2	PATHS	RESPONSE	OPTIONAL	STRING_ARRAY	All file paths registered in the file registry.

Usage

Request

final IId microServiceId = CIdFactory.fromObject("file.registry");
final CEnvelope env = CEnvelope.forMicroService(microServiceId);

final CRecord record = CRecordFileRegistryGetFilePaths.create();
CRecordFileRegistryGetFilePaths.setDirectory(record,
                                             "lib/");

sendRequest(env,
            record);

Catch the response

// in Target constructor
addMessageHandler(CRecordFileRegistryGetFilePaths.ID,
              this::asyncGetFilePaths);

// message handler
private boolean asyncGetFilePaths(@NotNull final CEnvelope aEnvelope,
                                  @NotNull final CRecord aRecord)
{
    if (aEnvelope.isAnswer())
    {
        if (aEnvelope.getResult()
                     .hasSuccess())
        {
            final String[] arr = CRecordFileRegistryGetFilePaths.getPaths(aRecord,
                                                                          null);
            ...
        }
        return true;
    }
    else
    {
        return false;
    }
}