Application factory collector API on sillysky.net

CRecordAddAppFactory

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

The message CRecordAddAppFactory is used to register an application factory. Any number of application factories can be registered on any number of nodes. When an application is started, the application collector then selects one of the registered factories and starts the application there.

This message belongs to the application factory collector API.
The Application Collector Service is located in the plugin NY_ApplicationFactoryCollectorPlugIn.

{
  "id": "ee3af3ad-16e4-45c7-af8b-8c11e93f18c7",
  "name": "ADD_APP_FACTORY",
  "isNanoService": "false",
  "namespaces": "",
  "description": "Add an application factory.",
  "slots": [
    {
      "key": "app",
      "name": "APPLICATION",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "RECORD",
      "description": "The application as record APPLICATION."
    },
    {
      "key": "factoryAddress",
      "name": "FACTORY_ADDRESS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "TARGET_ADDRESS",
      "description": "The address of the application factory."
    }
  ]
}

Arguments

APPLICATION: The description of the application. See CRecordApplication.
FACTORY_ADDRESS: The target address of the factory.

Usage

Sending the message

Example of use (after generating of the class CRecordAddAppFactory):

CRecordApplication

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

The record CRecordApplication is a data record for the description of an application.

This record belongs to the application factory collector API.
The Application Collector Service is located in the plugin NY_ApplicationFactoryCollectorPlugIn.

{
  "id": "5a8d5a3f-37c0-47f5-bb88-25f5f5e6a20c",
  "name": "APPLICATION",
  "isNanoService": "false",
  "namespaces": "",
  "description": "The application data.",
  "slots": [
    {
      "key": "appId",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "UUID",
      "description": "The ID of an application."
    },
    {
      "key": "appName",
      "name": "NAME",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING",
      "description": "The name of the application."
    },
    {
      "key": "shortAppDesc",
      "name": "SHORT_DESCRIPTION",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING",
      "description": "A short description."
    },
    {
      "key": "longAppDesc",
      "name": "LONG_DESCRIPTION",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING",
      "description": "A long description."
    },
    {
      "key": "iconPath",
      "name": "ICON",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING",
      "description": "The relative path of the icon file in the file store."
    },
    {
      "key": "properties",
      "name": "PROPERTIES",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING_PROPERTIES",
      "description": "Properties for running the application."
    },
    {
      "key": "permissions",
      "name": "PERMISSIONS",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING_ARRAY",
      "description": "Permissions required to start the application."
    }
  ]
}

Arguments

ID: The ID of the application.
NAME: The name of the application.
SHORT_DESCRIPTION: A short description of the application.
LONG_DESCRIPTION: A long description of the application.
ICON: The relative path of an icon. The binary icon can be retrieved from the The File Store API.
PROPERTIES: Predefined arguments for the application.
PERMISSIONS:A list of rights that are required to start the application.

Usage

Sending the message

This record is used, for example, when registering application factories. Example of use (after generating of the class CRecordApplication):

CRecordGetApplicationListForUser

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

The CRecordGetApplicationListForUser message retrieves a list of applications that the user is allowed to start.

This message belongs to the application factory collector API.
The Application Collector Service is located in the plugin NY_ApplicationFactoryCollectorPlugIn.

{
  "id": "25615f1c-5ada-4893-b551-8122f7def7f9",
  "name": "GET_APPLICATION_LIST_FOR_USER",
  "isNanoService": "false",
  "namespaces": "",
  "description": "Fetches a list of applications that the user is allowed to launch.",
  "slots": [
    {
      "key": "1",
      "name": "PLATFORM",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The platform on which the application is to run."
    },
    {
      "key": "10",
      "name": "APPLICATION_LIST",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "RECORD_ARRAY",
      "description": "The application list (maybe empty)."
    }
  ]
}

Arguments

The request also requires the session token, from which the rights of the current user are derived.

CRecordLaunchApplication

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

The message CRecordLaunchApplication is used to start applications. Applications can be hosted and started on any node. The message is first sent to the Application Collector Service, which selects an appropriate factory instance (load balancing) and then forwards the message to the application factory.

This message belongs to the application factory collector API.
The Application Collector Service is located in the plugin NY_ApplicationFactoryCollectorPlugIn.

{
  "id": "d0140763-3cb9-4bd0-8c5f-1562c6e50216",
  "name": "LAUNCH_APPLICATION",
  "isNanoService": "false",
  "namespaces": "",
  "description": "Create and launch an application instance.",
  "slots": [
    {
      "key": "1",
      "name": "APPLICATION_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "UUID",
      "description": "The ID of the application."
    },
    {
      "key": "2",
      "name": "REMOTE_SKIN_CLIENT_NODE",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "NODE_ADDRESS",
      "description": "Optional: The node address of the RemoteSkin client."
    },
    {
      "key": "3",
      "name": "REMOTE_SKIN_TARGET",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "TARGET_ADDRESS",
      "description": "Web Client: An existing RemoteSkin target."
    },
    {
      "key": "4",
      "name": "PROPERTIES",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING_PROPERTIES",
      "description": "Properties for launching the application."
    },
    {
      "key": "10",
      "name": "APP_INSTANCE_ID",
      "direction": "ANSWER",
      "presenceConstraint": "OPTIONAL",
      "type": "UUID",
      "description": "The instance ID of the launched application."
    },
    {
      "key": "11",
      "name": "INSTANCE_ADDRESS",
      "direction": "ANSWER",
      "presenceConstraint": "OPTIONAL",
      "type": "TARGET_ADDRESS",
      "description": "The address of the main target of the application."
    }
  ]
}

Arguments

Starting an application requires a valid session token with the appropriate rights.

CRecordRemoveAppFactory

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

The message CRecordRemoveAppFactory is used to deregister an application factory.

This message belongs to the application factory collector API.
The Application Collector Service is located in the plugin NY_ApplicationFactoryCollectorPlugIn.

{
  "id": "1246722a-b61c-46e4-a42e-08563bb30006",
  "name": "REMOVE_APP_FACTORY",
  "isNanoService": "false",
  "namespaces": "",
  "description": "Remove an application factory.",
  "slots": [
    {
      "key": "appId",
      "name": "APPLICATION_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "UUID",
      "description": "The ID of the application."
    },
    {
      "key": "factoryAddress",
      "name": "FACTORY_ADDRESS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "TARGET_ADDRESS",
      "description": "The address of the application factory."
    }
  ]
}

Arguments

APPLICATION_ID: The ID of the application.
FACTORY_ADDRESS: The target address of the factory.

Usage

Sending the message

Example of use (after generating of the class CRecordRemoveAppFactory):