CRecordSetPluginList

This message transmits the lists of JAR files needed for an update.

The message is part of the API of the software update or the NY_LocalSoftwareUpdaterPlugIn plugin. The message belongs to a nanoservice in the SYSTEM namespace.

{
  "id": "55310d32-5724-4c36-a108-b03c0481b746",
  "name": "SET_PLUGIN_LIST",
  "isService": "true",
  "namespaces": "SYSTEM",
  "description": "Set the library and plugin list of the node.\nEntries can have short names (json-simple),\nlong names (json-simple-1.1.1),\nfull names (json-simple-1.1.1.jar) or\nadditional hash codes (json-simple-1.1.1.jar(XYNWCBXB3367HES79YHDNA9G6G)).",
  "slots": [
    {
      "key": "1",
      "name": "SESSION_TOKEN",
      "direction": "REQUEST",
      "mandatory": "true",
      "type": "STRING",
      "description": "The session token to check authorization."
    },
    {
      "key": "2",
      "name": "LIBRARY_LIST",
      "direction": "REQUEST",
      "mandatory": "false",
      "type": "STRING_ARRAY",
      "description": "The new list of libraries in the classpath (directory lib)."
    },
    {
      "key": "3",
      "name": "PLUGIN_LIST",
      "direction": "REQUEST",
      "mandatory": "false",
      "type": "STRING_ARRAY",
      "description": "The list of plugins to download (directory plugins)."
    },
    {
      "key": "4",
      "name": "PLUGIN_TO_LOAD_LIST",
      "direction": "REQUEST",
      "mandatory": "false",
      "type": "STRING_ARRAY",
      "description": "The new list of plugins to load on start-up."
    },
    {
      "key": "5",
      "name": "REBOOT",
      "direction": "REQUEST",
      "mandatory": "false",
      "type": "BOOLEAN",
      "description": "True: Node shall reboot after updating the software."
    }
  ]
}

Arguments

• SESSION_TOKEN : Valid session token. The NY_Shutdown permission is required for the reboot. The NY_SoftwareUpdate permission is required for downloading JARs.
• LIBRARY_LIST : Optional: The list of libraries and the kernel JAR to download. The hash is optional and is only required if you want to distinguish between files with the same name but different versions. The hash value of the file is displayed on the console when the file is imported into the FileStore. Only the files that do not already exist will be downloaded. Files that existed before the update and no longer exist will be imported into the remote FileStore and deleted from the directory. If this list is missing, the kernel file and libraries will not be modified.
• PLUGIN_LIST : Optional: The list of plugins in the plugins directory. The hash is optional and is only required if you want to distinguish between files with the same name but different versions. The hash value of the file is displayed on the console when the file is imported into the FileStore. Only the files that do not already exist will be downloaded. Files that existed before the update and no longer exist will be imported into the remote FileStore and deleted from the directory. If the list is missing, the files in the plugins directory will not be modified.
• PLUGIN_TO_LOAD_LIST : Optional: The list of plugins to load when the node is started. If this list is missing, the node's existing list is not modified. Preferably use filenames without version numbers here. The kernel automatically selects the latest version when there are multiple versions of a plugin. This way, you avoid updating the list when installing new software.
• REBOOT : The default here is true for rebooting the nodes after the update.