r-io suitereference docsThree ways into the platform: the REST resources served by each web application, the WebSocket topics that push live events to clients, and the SOAP contracts of the sixteen backend services. Language drivers wrap the first two behind business-oriented ports.
REST paths are relative to a web application server, http://<host>:<port>/<app>/…, where {app} is the application name (r-ioga, r-ioda, r-iota…). Resources of the shared module gind-webapp-generic-application-users exist in every application; resources listed under a specific application exist only there. Ports are in Configuration & ports.
DWApplicationService registers a BasicCredentialAuthFilter that authenticates against the system service and injects a DWUser principal. 34 of the 36 resources require it (@Auth); only the application context, ping, checkTaskDone, OpenAPI and the simplified /{app}/user login resource are open. No role restriction is enforced at present (the @RolesAllowed("admin") annotations are commented out).
Every model, process or sensor call is scoped by the user’s current collaboration and knowledge space, selected through /system/collaboration/collaboration/select/{id} and …/knowledge/select/{collaborationId}/{knowledgeSpaceId}. The application context (/generic-application/context/applicationContext) returns the effective metamodel and the WebSocket topic templates.
PubSubServerServlet on /ws/pubsub/* takes the rest of the path as topic. Topics are prefixed by the hash codes of the collaboration and knowledge space names, so a client subscribes to ws://host:port/ws/pubsub/<collabHash>/<ksHash>/models/. A chat servlet (/ws/chat/*) and a SockJS shim (/sockjs-node/*) also exist; r-iomega adds an OpenAI Realtime proxy.
Operations are listed as they appear in the Jersey classes; a leading method applies to the sub-paths that follow it.
gind-webapp-generic-application-users (all applications)| Resource | Base path | Operations |
|---|---|---|
| DWApplicationContextResource | /{app}/generic-application/context | GET applicationContext — effective metamodel, topic templates, strategies, albertModels, environmentVariables |
| DefaultResource · OnlyGetResource | /{app}/generic-application/default · …/onlyget | GET ping · GET checkTaskDone — completes a human task by name (personId, taskName, collaborationName, knowledgeSpaceName); the collaboration and knowledge-space names must match existing ones exactly, otherwise the call is refused (the task update would reach no client). Optional repeated outputName/outputValue pairs set output variables already declared in the task “Output Properties”. |
| OpenApiResource | /{app}/openapi.json | GET — OpenAPI descriptor when swagger.enabled |
| SystemResource | /{app}/generic-application/system | POST user/login, user/logout, user/register · GET user/users, user/users/{id}, user/hasAdmins, user/export/{userId} · POST/DELETE user/users · GET collaboration/collaborations[/{userId}], collaboration/collaboration/{id}, collaboration/knowledgeSpace/{id}, collaboration/collaboration/select/{id}, collaboration/knowledge/select/{cid}/{kid}, collaboration/collaboration/export/{id}, collaboration/knowledges/{cid}, collaboration/users/{cid}, collaboration/attachKnowledgeSpaceToCollaboration · POST collaboration/findCollaborationsByName, collaboration/collaborations, collaboration/connectUserToCollaboration · DELETE collaboration/collaborations/{id}, collaboration/knowledgeSpace/{id} · GET ping |
| UserResource | /{app}/user | POST login, logout, getUsers |
| CoreResource | /{app}/generic-application/core | POST/PUT nodes · POST nodes/getNode, nodes/findNodesByTypesAndOrProperties · DELETE nodes/{id} · POST/PUT edges · POST edges/getEdge · DELETE edges/{id} |
| Neo4JResource | /{app}/generic-application/neo4j | POST query — raw Cypher |
| ModelsResource | /{app}/generic-application/models | POST publishModel, synchronize, addModelsFromURL, freeze, cloneModelFromStatus · GET query, query/multiple · PUT deleteModels · POST playback/checkpoint, playback/restore · GET playback/state (playbackId and step; memory-only checkpoints). See Scenario timelines. |
| MetaModelsResource | /{app}/generic-application/metamodels | GET getUMLEffectiveDomain · POST publishSyncEffectiveDomain, unpublishSyncEffectiveDomain, extractSyncEffectiveDomain · GET content?domain=|extension= — what a domain or an extension brings (its own concepts grouped by package, its own relations), for the Edit project page of r-ioga |
| StorageResource · FileResource | …/storage · …/file | POST query, update · GET download, POST upload (multipart) |
| HumanTaskResource | /{app}/generic-application/persons/humantask | GET todoList/{assignedToId}, subscribeToAddTasksByAssignedToResource/{assignedToId} · POST updateTask |
| Person3DModelResource | …/person-3d-model | POST generate |
| MoveToResource | /{app}/generic-application/trajectory | POST moveTo, tracked, arrive, plan, entrances, travelled · POST simulate, findSimulation, saveSimulation, simulations, updateSimulation, deleteSimulation, deleteSituation, stopSimulation, finishSimulation, accelerate · POST taskSteps, isInside — what the forks of a scenario read · POST runs, saveRun, deleteRun, restoreRunSettings, POST and GET runVideo — the runs of a scenario and their videos · GET alertThreshold — alert threshold of the risks, read only · POST movedActors, playEffectStep, lateTasks, finishLateTasks — simulated moves, gradual effects and late tasks · POST taskDues, finishTask, endWait — tasks taken at once (Auto) by r-iosemit, see Scenario timelines — “Move To” of a movable resource along the pedestrian networks, expected paths of move tasks, and the simulations of the supervised tasks (moves and other tasks) saved in the open game scenario |
| IndoorPedestrianNetworkResource | /{app}/generic-application/indoor-pedestrian-network | POST generate — indoor pedestrian network of a building (corridors, doors, stairs, entrances) read from its indoor 2D plans and its 3D model |
| Site3DModelResource | /{app}/generic-application/site-3d-model | POST generate — GLB from a surface, an object, usable indoor plans or a reviewed site layout. POST analyze — orthophoto (IGN BD ORTHO, else Esri World Imagery), OpenStreetMap buildings, local tree detection and AI completion when available. Blender is required for construction. See Maps & 3D generation. |
| AIChatbotResource | /{app}/generic-application/aichatbot | POST query, describePicture, inventStory, invent{Functions, Roles, RolesFromObjectives, Actualities, Potentialities, Potential, Persons, Goods, Buildings, Roads, RoadNetworkFromTerritory, WaterNetworkFromTerritory, ElectricalNetworkFromTerritory, UrbanRailNetworkFromTerritory, PedestrianNetworkFromTerritory, Groups, Territories, Sensors, Iots, PositionFromTerritory, Pictures, CodeExplanation}, similarityLevel, loadDocumentsForRAG, exportDocumentsFromRAG, showInfosDocumentsInRAG, restoreRAGFromDirectory, deleteRAG, findContextAndPartnersInRAG · GET getRiopiotContext · GET ollama/status?mode=&url=, POST ollama/install, GET ollama/install/{taskId}, POST ollama/install/{taskId}/cancel — local AI service, see Local AI |
| ProcessResource | /{app}/r-ioga/process | POST deduceProcess, deploy, undeploy, supervise, runSync, runASync, findAssociatedStrategiesToRisk, cancelOrchestration, subscribeOnDeploymentService, subscribeOnProcessInstanceEventService, subscribeExchangesByInstance · GET list, instancesByProcess/{name}, processInstance/{id}, exchangesByInstance/{id}, getProcessModels/{name}, getProcessDeployResult/{name}, pauseOrchestration/{id}, resumeOrchestration/{id} · DELETE deleteOrchestration/{id} · POST runtimeDiff {supervisedSolutionId, deducedSolutionId} — what a deduction “From what was done” adds to, removes from and keeps in the running process (tasks paired by the function they were deduced from and their sub-process; only tasks are added) · POST modifyRunningProcess — the part not started yet of a running process is modified in place in the engine (tasks and sequence flows added, ids removed), all or nothing, then republished in the knowledge space and in the expected world of the supervised solution |
| SolutionResource | /{app}/r-ioga/solution | POST selectSolution, deduceSolutionASync, deploySolution, undeploySolution, superviseSolution, runASyncSolution, cancelSolution, endSupervisionIfResolved, deductionTrace, deductionTraces · POST eligibleActors?task= — the actors that can take a human task of the solution under review, the closest first · POST changeTaskActor?task=&actor= — gives the task to another actor in the review, plans its move again and computes the indicators again · GET findSelectedSolution · POST validateSolution — checks that the processes of a solution, as edited in the review of r-iota before deployment, can be deployed as they are ({valid, errors, warnings, indicators}), then computes its indicators again with the KPIL script of the project |
| ProjectResource | /{app}/r-ioga/projects | GET findProjectsByUserAndCollaboration/{collab}, projects/{id}, getProjectByNameInCollaboration, findEffectiveDomainByProjectId, findEffectivePackageByNameByProjectId, exportExcelData/{id}, containsRangeOnMetricsOrIndicators/{id} · POST projects, projects/metaModelRemovalImpact (concepts and instances that unchecking domains or extensions would remove), downloadRemoteUsecase, loadProjectFromUsecase, sharedModifications, exportProject, importProject, importExcelData · PUT projects · DELETE projects/{id}, resetAll — the archive stores each game scenario in game_scenarios/<Name>/ with its datasets/ and media/ (see scenario timelines) — Project archives & shared resources |
| SemanticResource | /{app}/r-ioga/semantic | POST exportToOWL, exportToTurtle, exportToJsonLd |
| InterpretationRulesResource | /{app}/r-ioga/interpretation_rules | POST importRule, addRules, addCepRuleDefinitions, addRulesFromURL, predict · GET rules, rule · DELETE deleteRules, deleteRule |
| SensorManagerResource | /{app}/sensorManager | POST createSensor, startSensor, stopSensor, deleteSensor, getSensor, setLocked, findSensorByTopic, updateConfigOfSensor, start/pause/update/continuousSignalIsStartedOnJSONConnector · GET getSensors, findSensorByProtocol/{type}/{nature}/{collab}/{ks} |
| CampaignResource | /{app}/r-iosepe/campaign | POST publishCampaign, getFailureSolutions, getAllCampaigns, findSolutionsByMetrics, createCampaign, updateCampaign, updateCampaignSolutionFlags, deleteCampaign · GET campaigns/{id}, campaignSolutionsFromCampaign/{id}, getCampaignsByUser, campaigns/{campaignId}/{solutionId} |
| UseCaseClockResource | /{app}/generic-application/clock | GET — clock of the use case of the user (now, offset to the server time, mode SERVER_TIME or SET, remote control, last change) · POST {date} — remote setting by a tool, refused unless the remote control is allowed · PUT settings {date | serverTime: true, remoteControl} — settings of the operator (r-ioga Edit project). Runtime state kept in the MongoDB collection useCaseClocks, not exported with the use case, and broadcast on the CLOCK topic; registered by RIOGAService, so present in r-ioga and in the applications built on it (r-iocal, r-ioda, r-ioded, r-ioplay, r-iored, r-iose, r-iosemit, r-iote). See Scenario timelines. |
| InterpretationResource | /{app}/generic-application/interpretation | GET quiet?timeout= — waits until no sensor event, CEP rule, interpretation or 2L wave is under way ({quiet, waitedMillis}, 60 s at most) |
| KnowledgeConsolidationResource | /{app}/generic-application/knowledge-consolidation | GET mechanisms, report · POST propose, apply, semantic-pertinence — see Knowledge consolidation |
| TrajectoryExtrapolationResource | /{app}/generic-application/extrapolation | GET the current extrapolations, their topic, horizon and switch · POST enabled, reset — the trajectories extended to the danger zones, see Digital twin |
| ForecastProjectionResource | /{app}/generic-application/forecast | POST snapshots — a ForecastSnapshot of a Forecast node, stored and projected through the CEP rules of the predicted sensor (returns the projection) · POST snapshots/{forecastId}/restore — sets back a previous snapshot, or clears it with an empty body · GET projections, projections/{forecastId}/last, projections/{forecastId}?limit=, sensors/{sensorId}/projections, sensors/{sensorId}/forecasts (ids of the forecasts predicting the sensor), connections (last state of the connection of each sensor and forecast to its provider: CONNECTED, FAILING, SUSPENDED or DISCONNECTED) · POST projected-conditions — when 2L conditions become true in the projected situation · POST/GET projection-spaces {date, threshold}, DELETE projection-spaces/{id} · GET proposals · POST proposals/{id}/transfer-model, proposals/{id}/deployed, proposals/{id}/{approve | refuse | defer | retry} (a refusal needs a justification) — forecasts and prospective deductions; projections kept in the MongoDB collection forecastProjections and pushed on …/sensors/forecast-projection; registered by RIOGAService, so present in r-ioga and in the applications built on it (r-iocal, r-ioda, r-ioded, r-ioplay, r-iored, r-iose, r-iosemit, r-iote) |
| Application · resource | Base path | Operations |
|---|---|---|
| r-ioga · EventBrokerResource | /{app}/r-ioga/eventBroker | GET getAllTopics · POST subscribe, unsubscribe |
| r-ioga · TimeSeriesResource | /{app}/r-ioga/timeSeries | POST write, update, query, delete, deleteAll |
| r-iota · SupervisionResource | /{app}/r-iota/supervision | GET strategies, configuration, state, point?date= · POST configuration, period {periodSeconds}, compute, memorizeBeforeCancel {memorizeDoneTasks}, autoMode {enabled, insertMoves, insertWaits, includeForecast, consolidateKnowledge}, activation {enabled}, extrapolation {enabled}, alertDefinition {riskProbabilityThreshold} (0..1, 0.5 by default; any active actuality is an alert) — continuous supervision of the solution (SupervisionEngine); WebSocket supervisionStatusEvent on the SOLUTION topic |
| r-iota · LightControlerResource | /{app}/r-iota/lightcontroler | PUT controlLight |
| r-ioded · DroolsStrategiesResource | /{app}/r-ioded/drools | GET strategies, strategies/{id}, strategies/{id}/export · POST strategies, strategies/{id}/clone, strategies/import, strategies/{id}/validate, strategies/{id}/publish, strategies/{id}/test |
| r-iosepe · ExcelResource · JsonResource | /{app}/r-iosepe/campaign/excel · …/json | POST exportCampaign, exportSolutions |
| r-iosemit · GameMasterResource | /{app}/gameMaster | POST setCurrentGameScenario, getCurrentGameScenario, getGameScenarios, createGameScenario, updateGameScenario, deleteGameScenario, saveGameScenario |
| r-iosemit · MockEndpointsManagerResource | /{app}/mockEndpointManager | POST createMockEndpoint, startMockEndpoint, stopMockEndpoint, deleteMockEndpoint, getMockEndpoints, findMockEndpointByGoodId, runActuatorOnMockEndpoint, addExchangeOnMockEndpoint, deleteExchangeOnMockEndpoint, playExchangeOnMockEndpoint |
| r-iosemit · SensorControlerResource | /{app}/sensorControler | POST getSensorControlers, createSensorControler, updateSensorControler, launchDataSetOnTopic, pauseDataSetOnTopic, stopDataSetOnTopic, addBreakpoints, removeBreakpoints, getBreakpoints, sendEventToSensor, addDatasetAndRefreshModelOnSensorControlerFrom{File,Json}, updateDataset…From{File,Json}, removeDatasetOnSensorControler, getXMLDataOfDataset, updateDatasetAndModelConfiguration · GET findSensorControlerByProtocol/{type}/{nature}/{scenario}/{collab}/{ks} |
| r-ioplay · GeoJSONResource | /{app}/geoJSON | POST loadPredefinedGeoJSONFiles, deployGeoJSONFiles, undeployGeoJSONFiles · GET getGeoJSONFiles |
| r-ioplay · GisResource | /{app}/gis | POST findConceptsHere, detectConceptsInside, findInOSM |
| r-iomega · AssistantResource | /{app}/api/assistant | GET getToolsInfo · POST handle |
| r-iomega · OpenAIAudioResource | /{app}/openai/audio | POST tts, stt · GET realtime/token |
Templates are published in the application context under mapTopicDefinitionsTemplate; clients replace ${collaborationNameHascode} and ${knowledgeSpaceNameHascode} with the Java hash code of the regex-friendly names, and optional placeholders with an id or an empty string.
| Topic | Template | Carries |
|---|---|---|
| MODELS | ${c}/${k}/models/ | Node and edge add, update and remove events of the graph |
| MONITORING | ${c}/${k}/monitoring/${processInstanceId}? | Process exchanges and instance progression |
| PROCESS | ${c}/${k}/process/ | Deploy, undeploy and asynchronous run responses |
| SOLUTION | ${c}/${k}/solution/ | Deduction progress, scenarios and errors |
| TASKS | ${c}/${k}/tasks/${personNodeId}? | Human-task add, update and remove events, global or per person |
| SENSORS | ${c}/${k}/sensors/ | Sensor status and measurement notifications; …/sensors/simulated-moves carries the progress of simulated moves (r-iosemit), …/sensors/forecast-projection the projections of the forecasts |
| CAMPAIGN | ${c}/${k}/campaign/ | Campaign and solution updates |
| LLM_REASONNING | ${c}/${k}/llmreasonning/${requestId} | AI chatbot graph structure and progress events |
| CLOCK | ${c}/${k}/clock/ | Changes of the use-case clock (set, back to server time, remote control) |
| ALL | ${c}/${k}/ | Declared but not functional |
Every backend service extends SPIWebServicePrimitives and registers one or more JAX-WS implementations under an endpoint suffix. WS-Notification producers all expose producerService (Subscribe, Unsubscribe, GetCurrentMessage, GetResourceProperty) and consumers NotifierClientService (Notify, SubscribeOn, UnSubscribeOn); they are not repeated below. WSDL files live in the *-client modules under src/main/resources/wsdl.
| Service · endpoint | Contract | Operations |
|---|---|---|
| Governance container · port 10101 · base /gov | ||
| GovCore | core_gov · core-gov.wsdl | addNode, updateNode, getNode, removeNode, addEdge, updateEdge, getEdge, removeEdge, query |
| GovSystem | system_gov · system-gov.wsdl | users (add, update, get, remove, getAllUsers, getAdministrators, findUserByEmail, findUserByLoginAndPassword), collaborations (add, update, get, remove, getAllCollaborations, findCollaborationsByName, findCollaborationsOfUser, exportCollaboration, connect/disconnectUserToCollaboration, getUsersInCollaboration), knowledge spaces (add, update, get, remove, attach/detachKnowledgeSpaceToCollaboration, getKnowledgeSpacesInCollaboration, findKnowledgeSpacesByName, findKnowledgeSpacesByUserAndCollaboration, getKnowledgeSpaceByNameInCollaboration) |
| GovNeo4J | neo4jService · neo4j.wsdl | query |
| GovMetaCore | meta_core_gov · meta-core-gov.wsdl | add/update/get/removeConcept, add/update/get/removeRelation, add/update/get/removeConnexionRule |
| GovMetaModels | meta_models_gov · meta-models-gov.wsdl | publish/unpublish/extractSyncMetaModel, publish/unpublish/extractASyncMetaModel, publish/unpublish/extractSyncEffectiveDomain; callback port: …ASyncMetaModelCallBack, sendCallbackError |
| GovModels | models_gov · models-gov.wsdl | publish/unpublish/extract/freezeSyncModel, cloneSyncModelFromStatus and ASync variants; callback port: …ASyncModelCallBack, sendCallbackError |
| GovDeduction | deductionService · deduction.wsdl | deduceASync; callback port deductionCallBack: deductionASyncCallBackResponse (implemented by the web applications) |
| GovAIChatbot | ai_chatbot · ai-chatbot.wsdl | query, queryOnPictures, invent* (functions, roles, actualities, potentialities, persons, goods, groups, territories, sensors, iots, buildings, roads, pictures, code explanation, problems from news, road, water, electrical, urban rail and pedestrian networks), similarityLevel, RAG (load, export, show, restore, delete, findContextAndPartners); publisher port: publishGraph{Structure, Progress, Completed, Error, Warning}Event |
| GovAICommandAssistant | ai_command_assistant · ai-command-assistant.wsdl | handle, getToolsInfo |
| GovCoreSubscriber · LLNotifier | producerService · NotifierClientService | graph event producer; 2L update/add node notifier |
| Interpretation container · port 10106 · base /InterpretationEngine | ||
| LowLevelInterpretationManager | InterpretationConfigsCommandService · InterpretationApi.wsdl | deploy, undeploy, getInterpretationConfig, getInterpretationConfigs, updateInterpretationConfig, predict |
| LowLevelInterpretation{Subscriber, CepNotifier, MLNotifier} · HighLevelInterpretation{Subscriber, Notifier} | producerService · NotifierClientService | WS-Notification plumbing of the low and high levels |
| CEP rules manager (standalone module) | cepRulesManager, cepRulesSubscriber, cepRulesNotifier | same contract as the low-level manager |
| Perception, simulation and evaluation | ||
| detectionEngine · 10108 | detectionService · detection.wsdl | detect — now returns an empty report (kept so that the WSDL and generated models do not change) |
| sensorManager · 10107 | sensor-manager-service · sensor-manager.wsdl | createSensor, deleteSensor, updateConfigOfSensor, startSensor, stopSensor, stopAllSensor, listen, setLocked, setStoreMediaOnSensor, getSensor, getSensors, findSensorByTopic, findSensorByInternalUrl, findSensorByProtocol, backup/restoreTimeSeriesDB, start/pause/updateContinuousSignalOnJSONConnector |
| sensorControler · 10107 | sensor-controler-service · sensor-controler.wsdl | create/update/destroySensorControler, get/find…, add/update/get/removeDataset…, storeDataset…, resetDataset…, play/pause/stopDataSetOnTopic…, add/remove/getBreakpoints, sendEventToSensor, getXMLDataOfDataset, updateDatasetAndModelConfiguration |
| GameMasterServer · 10110 | game_master-service · game_master_api.wsdl | get/find/create/update/delete/saveGameScenario(s), get/setCurrentGameScenario, exportGameScenarios, updateSensorControlerBackup, updateMockEndpointBackup |
| mockEndpointsManager · 10108 | mock-endpoint-manager-service · mock-endpoints-manager.wsdl | create/delete/start/stopMockEndpoint, stopAllMockEndpoints, updateConfigOfMockEndpoint, get/findMockEndpoint…, runActuatorOnMockEndpoint, add/delete/playExchangeOnMockEndpoint |
| TestCampaign · 10109 | campaignManager · campaignManager.wsdl | create/update/get/deleteCampaign, findCampaignByName, getCampaignWithoutResources, getAllCampaignsWithoutResources, getCampaignsWithoutResourcesByUser, add/update/removeSolution, getSolutionsFromCampaign, findSolutionsByMetrics, findSolutionByName/ById/BySignature, countSolutions, countSolutionsByMetrics, getFailureSolutions, addConceptsPostAnalyze |
| Workflow, tasks and monitoring | ||
| WorkflowEngine_deployerService · 10103 | DeploymentService · Process.wsdl | deploy, undeploy, listProcesses, getProcess, subscribeOnDeploymentService |
| WorkflowEngine_commandService | CommandService · CommandService.wsdl | pause, resume, stop, delete, cancel, getProcessModels, modifyRunningProcess |
| <process>__d_<deploymentId> (per deployed process) | ProcessInstance.wsdl | runSync, runASync; callback sendASyncResponse |
| HumanTask · 10102 | humantaskService · humantask.wsdl | addTaskSync, addTaskASync, updateTask, removeTask, getTask, findTask, getTodoList, findTasksByProcessInstanceId, subscribe/unSubscribeTasksByAssignedToResource; callback addTaskASyncCallBack |
| ProcessMonitoring · 10104 | ProcessMonitoring · ProcessMonitoring.wsdl | get/add/update/deleteProcessInstance(s), get/add/update/deleteExchange(s), getProcessInformation, subscribeOnExchangesOfInstance, subscribeOnExchangesOfAllInstances, subscribeOnProcessInstanceEventService |
| Data and integration | ||
| StorageService · 10100 | storageService · gind-storage.wsdl | put, get, query, update, remove, removeAll (document topics notified by the event storage variant) |
| timeseries · 19000 | timeseriesService · timeseries.wsdl | createTimeseriesCollection, write, update, query, delete, deleteAll, getTimeseriesCollectionNames, dump/restoreTimeseriesCollection |
| BrokerRegister · BrokerSubscriber · BrokerNotifier · 10105 | event-broker-service · event-broker.wsdl | register, unregister, getAllTopics (+ producer and notifier contracts) |
| h2_gis · 10111 · osm_gis · 10112 | store_gis · find_gis · store-gis.wsdl, find-gis.wsdl | store_gis: query, loadGeoJSONFile, deployGeoJSONFile, undeployGeoJSONFile, getGeoJSONFilesStored — find_gis: findConceptsFromLatLng, findConceptsInsidePolygon, findConceptsInsideBBox — client callback: receiveConceptContainedInPolygon, receiveConceptContainedInBBox |
| websocketCommandService · 12000 (web application side) | websocketCommand.wsdl | getResult — SOAP result bridged to a WebSocket topic |
| echo · concat · 1113 (test mocks) | echo.wsdl · concat.wsdl | echo · concat — toy partners of the helloworld process |
Drivers call the REST resources above with HTTP Basic credentials and listen to the WebSocket topics; models are the generated types of each language.
| Language · location | Ports / clients | Operations |
|---|---|---|
Java · java/packaging/gind-java-driver | IUsers, IMetaModels, IModels, IProcess, ISolution, ITasks, IEvents, IUsecase + WSock* listeners | login, logout, getUsers, register, findUserByName, findAssociatedPerson · getPredefinedUsecaseDefinitions, loadUsecase, isAlreadyLoadedUsecase, getUsecaseContext · push, pushpull, reload, query, getNodesByTypesAndOrProperties, get/removeNodeById, get/removeEdgeById · subscribeExchangesByInstance · deduceSolutionASync(FromSimpleSatisfactionStrategy), deploy/undeploy/supervise/select/runASync/cancelSolution · updateTask, subscribeToAddTasksByAssignedToResource · findSensorFromNode, findSensorsByType, start/stopSensor(s), sendEventOnSensor · findSensorsFixedOnto |
Python · python/backend/gind-python-driver | RestDriver; UsersDriverClient, MetaModelsDriverClient, ModelsDriverClient, ProcessDriverClient, TasksDriverClient, AppUserTaskDriverClient; app ports AppUser, AppTask, AppTaskListener | login, logout, get_users · get_usecase_context, get_project_by_name_in_collaboration, get_effective_domain, set_project_mode · push, push_pull, reload, query, get_nodes_by_types_and_or_properties · deduce, deploy, deploy_process, run_async · get_todolist, update_task · refresh_users, find_user_by_id, todo-list WebSocket functions |
C# · csharp/backend/gind-csharp-driver | RestDriver; IUsers, IMetaModels, IModels, IProcess, ITasks, IEvents, ISupervision, IAppUserTask + wsock_functions | login, logout, getUsers · usecase definitions and context · push, pushpull, reload, query, node/edge by id · deduce, deploy, deployProcess, undeploy, runSync, runASync, supervise, pause, resume, delete, cancel, exchangesByInstance, subscribeExchangesByInstance · getTodoList, getTasks, updateTask · findSensorsByType, createSensor, start/stopSensor(s), sendEventOnJSONConnector, isSimulation · supervision getState, getPoint, compute (/r-iota/supervision) |
Dart · dart/frontend/gind_r_io4u/lib/driver/rest/adapters | Users/System, MetaModels, Models, Solution, Tasks, Events, MockEndpoints, Chatbots, Files, Usecase driver clients + web_socket/api listeners | getUser(s), updateUser · getProjectByNameInCollaboration, getEffectiveDomain · push, pushpull, query, reload, delete, node/edge by id, patchEdge(s) · deduceSolution, deploySolution, runASyncSolution, superviseSolution, undeploySolution, pause, resume, cancel, delete, exchangesByInstance · getTodoList, subscribeToTodoList, updateTask · sensors start/stop/send/continuous signal · mock endpoints and exchanges · inventActualities, inventPictures · upload(s) · getGeoLocInstances |
# python/backend/gind-python-driver — context keys mirror unified_config.properties from fr_emac_gind_rio.driver.rest.RestDriver import RestDriver from fr_emac_gind_rio.driver.rest.ports.IProcess import SatisfactionStrategy from fr_emac_gind_rio.utils.system_user import SystemUser from lxml.etree import QName context = {"host": "127.0.0.1", "r-ioda...port": "9102", "r-iose...port": "9110", "r-ioxo...port": "9126", "websocket-command-service-port": "12000"} driver = RestDriver(context, SystemUser("login", "password")) driver.meta_model_driver.get_usecase_context(knowledge_space_name="IMT Albi Crisis", collaboration_name="R-IO Suite") objectives = driver.model_driver.get_nodes_by_types_and_or_properties( types=[QName("http://fr.emac.gind/collaborative-model", "Objective")]) reports = driver.process_driver.deduce(SatisfactionStrategy(objectives_order=objectives)) user = driver.app_user_task_driver.refresh_users()[0] user.login() # opens the WebSocket to-do channel todo = user.refresh_todo_list()
Signatures: RestDriver(context: Dict, user: SystemUser), MetaModelsDriverClient.get_usecase_context(knowledge_space_name, collaboration_name), ModelsDriverClient.get_nodes_by_types_and_or_properties(types, properties=None, node_status=None), ProcessDriverClient.deduce(satisfaction_strategy), AppUser.login(subscribe_on_task=True), AppUser.refresh_todo_list(). The Python driver addresses r-ioda, r-iose and the legacy r-ioxo name (port 9126); the example shipped in gind-python-driver-examples-test still uses an older constructor and should not be copied.
// csharp/backend/gind-csharp-driver — one RestDriver for r-ioda, r-iose, r-ioxo and r-iota using gind_csharp_driver_rest; using gind_csharp_utils; using fr_emac_gind_model; using System.Xml; RestDriver driver = RestDriver.createRestDriver("127.0.0.1", 9102, 9110, 9126, 9108, new SystemUser("login", "password")); var ucDef = await driver.metaModelDriver.findPredefinedUsecaseDefinitionByName("IMT Albi Crisis"); UsecaseContext uc = await driver.metaModelDriver.loadUsecase(ucDef, "R-IO Suite"); uc.startWSockUsecaseChannel(); // model events through /ws/pubsub node[] objectives = await driver.modelDriver.getNodesByTypesAndOrProperties( new[] { new XmlQualifiedName("Objective", "http://fr.emac.gind/collaborative-model") }); deductionReport[] reports = await driver.processDriver.deduce(new SatisfactionStrategy(objectives)); genericModel processModel = ((deductionResult)reports[0].Item).genericModel; node processNode = GenericModelUtil.getNodesByType( new XmlQualifiedName("Process", "http://fr.emac.gind/collaborative-model"), processModel)[0]; DeployResult deployed = await driver.processDriver.deploy(processNode);
Signatures: RestDriver.createRestDriver(host, riodaPort, riosePort, rioxoPort, riotaPort, user) (or createRestDriverFromConfigFile(path, user)), MetaModelsDriverClient.findPredefinedUsecaseDefinitionByName(name), loadUsecase(definition, collaborationName), ModelsDriverClient.getNodesByTypesAndOrProperties(types, properties=null, status=ACTIVE), ProcessDriverClient.deduce(strategy), deploy(processNode). Credentials travel as an HTTP Basic token built by SystemUser; never hard-code them in shared code.
Against a local standalone, through the r-ioga server (port 9100). Replace the credentials with an account created in r-ioga.
# liveness (no authentication) curl http://localhost:9100/r-ioga/generic-application/default/ping # list collaborations of the authenticated user curl -u login:password http://localhost:9100/r-ioga/generic-application/system/collaboration/collaborations # select a collaboration and a knowledge space (scopes every later call) curl -u login:password http://localhost:9100/r-ioga/generic-application/system/collaboration/knowledge/select/{collaborationId}/{knowledgeSpaceId} # find nodes by type in the current knowledge space curl -u login:password -H "Content-Type: application/json" \ -d '{"types":["{http://fr.emac.gind/collaborative-model}Person"]}' \ http://localhost:9100/r-ioga/generic-application/core/nodes/findNodesByTypesAndOrProperties # live model events (topic = hash(collaboration)/hash(knowledge space)/models/) websocat ws://localhost:9100/ws/pubsub/{collabHash}/{ksHash}/models/
Trois portes d’entrée dans la plateforme : les ressources REST servies par chaque application web, les topics WebSocket qui poussent les événements en direct vers les clients, et les contrats SOAP des seize services backend. Les drivers par langage enveloppent les deux premières derrière des ports métier.
Les chemins REST sont relatifs à un serveur d’application web, http://<hôte>:<port>/<app>/…, où {app} est le nom de l’application (r-ioga, r-ioda, r-iota…). Les ressources du module partagé gind-webapp-generic-application-users existent dans toutes les applications ; celles listées sous une application précise n’existent que là. Les ports figurent dans Configuration & ports.
DWApplicationService enregistre un BasicCredentialAuthFilter qui authentifie auprès du service système et injecte un principal DWUser. 34 des 36 ressources l’exigent (@Auth) ; seuls le contexte applicatif, ping, checkTaskDone, OpenAPI et la ressource de connexion simplifiée /{app}/user sont ouverts. Aucune restriction de rôle n’est appliquée à ce jour (les annotations @RolesAllowed("admin") sont commentées).
Chaque appel de modèle, de processus ou de capteur est cadré par la collaboration et l’espace de connaissance courants de l’utilisateur, choisis via /system/collaboration/collaboration/select/{id} et …/knowledge/select/{collaborationId}/{knowledgeSpaceId}. Le contexte applicatif (/generic-application/context/applicationContext) renvoie le métamodèle effectif et les gabarits de topics WebSocket.
PubSubServerServlet sur /ws/pubsub/* prend le reste du chemin comme topic. Les topics sont préfixés par les codes de hachage des noms de collaboration et d’espace de connaissance : un client s’abonne à ws://hôte:port/ws/pubsub/<hashCollab>/<hashKs>/models/. Une servlet de chat (/ws/chat/*) et un shim SockJS (/sockjs-node/*) existent aussi ; r-iomega ajoute un proxy OpenAI Realtime.
Les opérations sont listées telles qu’elles apparaissent dans les classes Jersey ; une méthode en tête s’applique aux sous-chemins qui la suivent.
gind-webapp-generic-application-users (toutes les applications)| Ressource | Chemin de base | Opérations |
|---|---|---|
| DWApplicationContextResource | /{app}/generic-application/context | GET applicationContext — métamodèle effectif, gabarits de topics, stratégies, albertModels, environmentVariables |
| DefaultResource · OnlyGetResource | /{app}/generic-application/default · …/onlyget | GET ping · GET checkTaskDone — termine une tâche humaine par son nom (personId, taskName, collaborationName, knowledgeSpaceName) ; les noms de collaboration et d’espace de connaissance doivent correspondre exactement à des noms existants, sinon l’appel est refusé (la mise à jour de la tâche n’atteindrait aucun client). Des paires répétées facultatives outputName/outputValue renseignent des variables de sortie déjà déclarées dans les « Output Properties » de la tâche. |
| OpenApiResource | /{app}/openapi.json | GET — descripteur OpenAPI si swagger.enabled |
| SystemResource | /{app}/generic-application/system | POST user/login, user/logout, user/register · GET user/users, user/users/{id}, user/hasAdmins, user/export/{userId} · POST/DELETE user/users · GET collaboration/collaborations[/{userId}], collaboration/collaboration/{id}, collaboration/knowledgeSpace/{id}, collaboration/collaboration/select/{id}, collaboration/knowledge/select/{cid}/{kid}, collaboration/collaboration/export/{id}, collaboration/knowledges/{cid}, collaboration/users/{cid}, collaboration/attachKnowledgeSpaceToCollaboration · POST collaboration/findCollaborationsByName, collaboration/collaborations, collaboration/connectUserToCollaboration · DELETE collaboration/collaborations/{id}, collaboration/knowledgeSpace/{id} · GET ping |
| UserResource | /{app}/user | POST login, logout, getUsers |
| CoreResource | /{app}/generic-application/core | POST/PUT nodes · POST nodes/getNode, nodes/findNodesByTypesAndOrProperties · DELETE nodes/{id} · POST/PUT edges · POST edges/getEdge · DELETE edges/{id} |
| Neo4JResource | /{app}/generic-application/neo4j | POST query — Cypher brut |
| ModelsResource | /{app}/generic-application/models | POST publishModel, synchronize, addModelsFromURL, freeze, cloneModelFromStatus · GET query, query/multiple · PUT deleteModels · POST playback/checkpoint, playback/restore · GET playback/state (playbackId et step ; points conservés en mémoire uniquement). Voir Chronologies de scénario. |
| MetaModelsResource | /{app}/generic-application/metamodels | GET getUMLEffectiveDomain · POST publishSyncEffectiveDomain, unpublishSyncEffectiveDomain, extractSyncEffectiveDomain · GET content?domain=|extension= — ce qu’apporte un domaine ou une extension (ses propres concepts groupés par package, ses propres relations), pour la page Edit project de r-ioga |
| StorageResource · FileResource | …/storage · …/file | POST query, update · GET download, POST upload (multipart) |
| HumanTaskResource | /{app}/generic-application/persons/humantask | GET todoList/{assignedToId}, subscribeToAddTasksByAssignedToResource/{assignedToId} · POST updateTask |
| Person3DModelResource | …/person-3d-model | POST generate |
| MoveToResource | /{app}/generic-application/trajectory | POST moveTo, tracked, arrive, plan, entrances, travelled · POST simulate, findSimulation, saveSimulation, simulations, updateSimulation, deleteSimulation, deleteSituation, stopSimulation, finishSimulation, accelerate · POST taskSteps, isInside — ce que lisent les fourches d’un scénario · POST runs, saveRun, deleteRun, restoreRunSettings, POST et GET runVideo — les runs d’un scénario et leurs vidéos · GET alertThreshold — seuil d’alerte des risques, en lecture seule · POST movedActors, playEffectStep, lateTasks, finishLateTasks — déplacements simulés, effets progressifs et tâches en retard · POST taskDues, finishTask, endWait — tâches prises d’office (Auto) par r-iosemit, voir Chronologies de scénario — « Move To » d’une ressource mobile le long des réseaux piétons, chemins attendus des tâches de déplacement et simulations des tâches supervisées (déplacements et autres tâches) enregistrées dans le scénario de jeu ouvert |
| IndoorPedestrianNetworkResource | /{app}/generic-application/indoor-pedestrian-network | POST generate — réseau piéton intérieur d’un bâtiment (couloirs, portes, escaliers, entrées) lu depuis ses plans intérieurs 2D et son modèle 3D |
| Site3DModelResource | /{app}/generic-application/site-3d-model | POST generate — GLB depuis une surface, un objet, des plans intérieurs exploitables ou une disposition de site revue. POST analyze — orthophoto (IGN BD ORTHO, sinon Esri World Imagery), bâtiments OpenStreetMap, détection locale des arbres et complément IA lorsqu’il est disponible. Blender est nécessaire à la construction. Voir Cartes et génération 3D. |
| AIChatbotResource | /{app}/generic-application/aichatbot | POST query, describePicture, inventStory, invent{Functions, Roles, RolesFromObjectives, Actualities, Potentialities, Potential, Persons, Goods, Buildings, Roads, RoadNetworkFromTerritory, WaterNetworkFromTerritory, ElectricalNetworkFromTerritory, UrbanRailNetworkFromTerritory, PedestrianNetworkFromTerritory, Groups, Territories, Sensors, Iots, PositionFromTerritory, Pictures, CodeExplanation}, similarityLevel, loadDocumentsForRAG, exportDocumentsFromRAG, showInfosDocumentsInRAG, restoreRAGFromDirectory, deleteRAG, findContextAndPartnersInRAG · GET getRiopiotContext · GET ollama/status?mode=&url=, POST ollama/install, GET ollama/install/{taskId}, POST ollama/install/{taskId}/cancel — service d’IA locale, voir IA locale |
| ProcessResource | /{app}/r-ioga/process | POST deduceProcess, deploy, undeploy, supervise, runSync, runASync, findAssociatedStrategiesToRisk, cancelOrchestration, subscribeOnDeploymentService, subscribeOnProcessInstanceEventService, subscribeExchangesByInstance · GET list, instancesByProcess/{name}, processInstance/{id}, exchangesByInstance/{id}, getProcessModels/{name}, getProcessDeployResult/{name}, pauseOrchestration/{id}, resumeOrchestration/{id} · DELETE deleteOrchestration/{id} · POST runtimeDiff {supervisedSolutionId, deducedSolutionId} — ce qu’une déduction « From what was done » ajoute au processus en cours, en retire et y garde (tâches appariées par la fonction dont elles sont déduites et leur sous-processus ; seules des tâches sont ajoutées) · POST modifyRunningProcess — la partie non commencée d’un processus en cours est modifiée sur place dans le moteur (tâches et flux de séquence ajoutés, identifiants retirés), tout ou rien, puis republiée dans l’espace de connaissance et dans le monde attendu de la solution supervisée |
| SolutionResource | /{app}/r-ioga/solution | POST selectSolution, deduceSolutionASync, deploySolution, undeploySolution, superviseSolution, runASyncSolution, cancelSolution, endSupervisionIfResolved, deductionTrace, deductionTraces · POST eligibleActors?task= — les acteurs qui peuvent prendre une tâche humaine de la solution en revue, le plus proche d’abord · POST changeTaskActor?task=&actor= — confie la tâche à un autre acteur dans la revue, replanifie son déplacement et recalcule les indicateurs · GET findSelectedSolution · POST validateSolution — vérifie que les processus d’une solution, tels que modifiés dans la revue de r-iota avant déploiement, sont déployables en l’état ({valid, errors, warnings, indicators}), puis recalcule ses indicateurs avec le script KPIL du projet |
| ProjectResource | /{app}/r-ioga/projects | GET findProjectsByUserAndCollaboration/{collab}, projects/{id}, getProjectByNameInCollaboration, findEffectiveDomainByProjectId, findEffectivePackageByNameByProjectId, exportExcelData/{id}, containsRangeOnMetricsOrIndicators/{id} · POST projects, projects/metaModelRemovalImpact (concepts et instances que décocher des domaines ou des extensions retirerait), downloadRemoteUsecase, loadProjectFromUsecase, sharedModifications, exportProject, importProject, importExcelData · PUT projects · DELETE projects/{id}, resetAll — l’archive range chaque scénario de jeu dans game_scenarios/<Nom>/ avec ses datasets/ et media/ (voir les chronologies de scénario) — Archives de projet et ressources partagées |
| SemanticResource | /{app}/r-ioga/semantic | POST exportToOWL, exportToTurtle, exportToJsonLd |
| InterpretationRulesResource | /{app}/r-ioga/interpretation_rules | POST importRule, addRules, addCepRuleDefinitions, addRulesFromURL, predict · GET rules, rule · DELETE deleteRules, deleteRule |
| SensorManagerResource | /{app}/sensorManager | POST createSensor, startSensor, stopSensor, deleteSensor, getSensor, setLocked, findSensorByTopic, updateConfigOfSensor, start/pause/update/continuousSignalIsStartedOnJSONConnector · GET getSensors, findSensorByProtocol/{type}/{nature}/{collab}/{ks} |
| CampaignResource | /{app}/r-iosepe/campaign | POST publishCampaign, getFailureSolutions, getAllCampaigns, findSolutionsByMetrics, createCampaign, updateCampaign, updateCampaignSolutionFlags, deleteCampaign · GET campaigns/{id}, campaignSolutionsFromCampaign/{id}, getCampaignsByUser, campaigns/{campaignId}/{solutionId} |
| UseCaseClockResource | /{app}/generic-application/clock | GET — horloge du cas d’usage de l’utilisateur (maintenant, écart à l’heure du serveur, mode SERVER_TIME ou SET, pilotage à distance, dernier changement) · POST {date} — réglage à distance par un outil, refusé si le pilotage à distance n’est pas autorisé · PUT settings {date | serverTime: true, remoteControl} — réglages de l’opérateur (r-ioga Edit project). État d’exécution conservé dans la collection MongoDB useCaseClocks, non exporté avec le cas d’usage, et diffusé sur le topic CLOCK ; enregistrée par RIOGAService, donc présente dans r-ioga et dans les applications bâties sur lui (r-iocal, r-ioda, r-ioded, r-ioplay, r-iored, r-iose, r-iosemit, r-iote). Voir Chronologies de scénario. |
| InterpretationResource | /{app}/generic-application/interpretation | GET quiet?timeout= — attend qu’aucun événement capteur, règle CEP, interprétation ou vague 2L ne soit en cours ({quiet, waitedMillis}, 60 s au plus) |
| KnowledgeConsolidationResource | /{app}/generic-application/knowledge-consolidation | GET mechanisms, report · POST propose, apply, semantic-pertinence — voir Consolidation des connaissances |
| TrajectoryExtrapolationResource | /{app}/generic-application/extrapolation | GET les extrapolations courantes, leur topic, leur horizon et leur interrupteur · POST enabled, reset — les trajectoires prolongées vers les zones de danger, voir Jumeau numérique |
| ForecastProjectionResource | /{app}/generic-application/forecast | POST snapshots — un ForecastSnapshot d’un nœud Forecast, enregistré et projeté à travers les règles CEP du capteur prévu (renvoie la projection) · POST snapshots/{forecastId}/restore — remet un snapshot précédent, ou l’efface avec un corps vide · GET projections, projections/{forecastId}/last, projections/{forecastId}?limit=, sensors/{sensorId}/projections, sensors/{sensorId}/forecasts (identifiants des prévisions qui prédisent le capteur), connections (dernier état de la connexion de chaque capteur et prévision à son fournisseur : CONNECTED, FAILING, SUSPENDED ou DISCONNECTED) · POST projected-conditions — quand des conditions 2L deviennent vraies dans la situation projetée · POST/GET projection-spaces {date, threshold}, DELETE projection-spaces/{id} · GET proposals · POST proposals/{id}/transfer-model, proposals/{id}/deployed, proposals/{id}/{approve | refuse | defer | retry} (un refus exige une justification) — prévisions et déductions prospectives ; projections conservées dans la collection MongoDB forecastProjections et poussées sur …/sensors/forecast-projection ; enregistrée par RIOGAService, donc présente dans r-ioga et dans les applications bâties sur lui (r-iocal, r-ioda, r-ioded, r-ioplay, r-iored, r-iose, r-iosemit, r-iote) |
| Application · ressource | Chemin de base | Opérations |
|---|---|---|
| r-ioga · EventBrokerResource | /{app}/r-ioga/eventBroker | GET getAllTopics · POST subscribe, unsubscribe |
| r-ioga · TimeSeriesResource | /{app}/r-ioga/timeSeries | POST write, update, query, delete, deleteAll |
| r-iota · SupervisionResource | /{app}/r-iota/supervision | GET strategies, configuration, state, point?date= · POST configuration, period {periodSeconds}, compute, memorizeBeforeCancel {memorizeDoneTasks}, autoMode {enabled, insertMoves, insertWaits, includeForecast, consolidateKnowledge}, activation {enabled}, extrapolation {enabled}, alertDefinition {riskProbabilityThreshold} (0..1, 0,5 par défaut ; toute actualité active est une alerte) — supervision continue de la solution (SupervisionEngine) ; WebSocket supervisionStatusEvent sur le topic SOLUTION |
| r-iota · LightControlerResource | /{app}/r-iota/lightcontroler | PUT controlLight |
| r-ioded · DroolsStrategiesResource | /{app}/r-ioded/drools | GET strategies, strategies/{id}, strategies/{id}/export · POST strategies, strategies/{id}/clone, strategies/import, strategies/{id}/validate, strategies/{id}/publish, strategies/{id}/test |
| r-iosepe · ExcelResource · JsonResource | /{app}/r-iosepe/campaign/excel · …/json | POST exportCampaign, exportSolutions |
| r-iosemit · GameMasterResource | /{app}/gameMaster | POST setCurrentGameScenario, getCurrentGameScenario, getGameScenarios, createGameScenario, updateGameScenario, deleteGameScenario, saveGameScenario |
| r-iosemit · MockEndpointsManagerResource | /{app}/mockEndpointManager | POST createMockEndpoint, startMockEndpoint, stopMockEndpoint, deleteMockEndpoint, getMockEndpoints, findMockEndpointByGoodId, runActuatorOnMockEndpoint, addExchangeOnMockEndpoint, deleteExchangeOnMockEndpoint, playExchangeOnMockEndpoint |
| r-iosemit · SensorControlerResource | /{app}/sensorControler | POST getSensorControlers, createSensorControler, updateSensorControler, launchDataSetOnTopic, pauseDataSetOnTopic, stopDataSetOnTopic, addBreakpoints, removeBreakpoints, getBreakpoints, sendEventToSensor, addDatasetAndRefreshModelOnSensorControlerFrom{File,Json}, updateDataset…From{File,Json}, removeDatasetOnSensorControler, getXMLDataOfDataset, updateDatasetAndModelConfiguration · GET findSensorControlerByProtocol/{type}/{nature}/{scenario}/{collab}/{ks} |
| r-ioplay · GeoJSONResource | /{app}/geoJSON | POST loadPredefinedGeoJSONFiles, deployGeoJSONFiles, undeployGeoJSONFiles · GET getGeoJSONFiles |
| r-ioplay · GisResource | /{app}/gis | POST findConceptsHere, detectConceptsInside, findInOSM |
| r-iomega · AssistantResource | /{app}/api/assistant | GET getToolsInfo · POST handle |
| r-iomega · OpenAIAudioResource | /{app}/openai/audio | POST tts, stt · GET realtime/token |
Les gabarits sont publiés dans le contexte applicatif sous mapTopicDefinitionsTemplate ; les clients remplacent ${collaborationNameHascode} et ${knowledgeSpaceNameHascode} par le code de hachage Java des noms normalisés, et les espaces réservés optionnels par un identifiant ou une chaîne vide.
| Topic | Gabarit | Transporte |
|---|---|---|
| MODELS | ${c}/${k}/models/ | Événements d’ajout, de mise à jour et de suppression de nœuds et d’arêtes du graphe |
| MONITORING | ${c}/${k}/monitoring/${processInstanceId}? | Échanges de processus et progression des instances |
| PROCESS | ${c}/${k}/process/ | Déploiement, retrait et réponses d’exécution asynchrone |
| SOLUTION | ${c}/${k}/solution/ | Progression, scénarios et erreurs de déduction |
| TASKS | ${c}/${k}/tasks/${personNodeId}? | Événements de tâches humaines, globaux ou par personne |
| SENSORS | ${c}/${k}/sensors/ | Notifications d’état et de mesure des capteurs ; …/sensors/simulated-moves transporte l’avancement des déplacements simulés (r-iosemit), …/sensors/forecast-projection les projections des prévisions |
| CAMPAIGN | ${c}/${k}/campaign/ | Mises à jour de campagnes et de solutions |
| LLM_REASONNING | ${c}/${k}/llmreasonning/${requestId} | Événements de structure et de progression du graphe du chatbot IA |
| CLOCK | ${c}/${k}/clock/ | Changements de l’horloge du cas d’usage (réglage, retour à l’heure du serveur, pilotage à distance) |
| ALL | ${c}/${k}/ | Déclaré mais non fonctionnel |
Chaque service backend étend SPIWebServicePrimitives et enregistre une ou plusieurs implémentations JAX-WS sous un suffixe d’endpoint. Les producteurs WS-Notification exposent tous producerService (Subscribe, Unsubscribe, GetCurrentMessage, GetResourceProperty) et les consommateurs NotifierClientService (Notify, SubscribeOn, UnSubscribeOn) ; ils ne sont pas répétés ci-dessous. Les WSDL sont dans les modules *-client sous src/main/resources/wsdl.
| Service · endpoint | Contrat | Opérations |
|---|---|---|
| Conteneur de gouvernance · port 10101 · base /gov | ||
| GovCore | core_gov · core-gov.wsdl | addNode, updateNode, getNode, removeNode, addEdge, updateEdge, getEdge, removeEdge, query |
| GovSystem | system_gov · system-gov.wsdl | utilisateurs (add, update, get, remove, getAllUsers, getAdministrators, findUserByEmail, findUserByLoginAndPassword), collaborations (add, update, get, remove, getAllCollaborations, findCollaborationsByName, findCollaborationsOfUser, exportCollaboration, connect/disconnectUserToCollaboration, getUsersInCollaboration), espaces de connaissance (add, update, get, remove, attach/detachKnowledgeSpaceToCollaboration, getKnowledgeSpacesInCollaboration, findKnowledgeSpacesByName, findKnowledgeSpacesByUserAndCollaboration, getKnowledgeSpaceByNameInCollaboration) |
| GovNeo4J | neo4jService · neo4j.wsdl | query |
| GovMetaCore | meta_core_gov · meta-core-gov.wsdl | add/update/get/removeConcept, add/update/get/removeRelation, add/update/get/removeConnexionRule |
| GovMetaModels | meta_models_gov · meta-models-gov.wsdl | publish/unpublish/extractSyncMetaModel, publish/unpublish/extractASyncMetaModel, publish/unpublish/extractSyncEffectiveDomain ; port de rappel : …ASyncMetaModelCallBack, sendCallbackError |
| GovModels | models_gov · models-gov.wsdl | publish/unpublish/extract/freezeSyncModel, cloneSyncModelFromStatus et variantes ASync ; port de rappel : …ASyncModelCallBack, sendCallbackError |
| GovDeduction | deductionService · deduction.wsdl | deduceASync ; port de rappel deductionCallBack : deductionASyncCallBackResponse (implémenté par les applications web) |
| GovAIChatbot | ai_chatbot · ai-chatbot.wsdl | query, queryOnPictures, invent* (fonctions, rôles, actualités, potentialités, personnes, biens, groupes, territoires, capteurs, IoT, bâtiments, routes, images, explication de code, problèmes depuis l’actualité, réseaux routier, hydraulique, électrique, ferroviaire urbain et piéton), similarityLevel, RAG (load, export, show, restore, delete, findContextAndPartners) ; port publisher : publishGraph{Structure, Progress, Completed, Error, Warning}Event |
| GovAICommandAssistant | ai_command_assistant · ai-command-assistant.wsdl | handle, getToolsInfo |
| GovCoreSubscriber · LLNotifier | producerService · NotifierClientService | producteur d’événements du graphe ; notifier 2L des ajouts/mises à jour de nœuds |
| Conteneur d’interprétation · port 10106 · base /InterpretationEngine | ||
| LowLevelInterpretationManager | InterpretationConfigsCommandService · InterpretationApi.wsdl | deploy, undeploy, getInterpretationConfig, getInterpretationConfigs, updateInterpretationConfig, predict |
| LowLevelInterpretation{Subscriber, CepNotifier, MLNotifier} · HighLevelInterpretation{Subscriber, Notifier} | producerService · NotifierClientService | plomberie WS-Notification des niveaux bas et haut |
| Gestionnaire de règles CEP (module autonome) | cepRulesManager, cepRulesSubscriber, cepRulesNotifier | même contrat que le gestionnaire bas niveau |
| Perception, simulation et évaluation | ||
| detectionEngine · 10108 | detectionService · detection.wsdl | detect — renvoie désormais un rapport vide (conservé pour que le WSDL et les modèles générés ne changent pas) |
| sensorManager · 10107 | sensor-manager-service · sensor-manager.wsdl | createSensor, deleteSensor, updateConfigOfSensor, startSensor, stopSensor, stopAllSensor, listen, setLocked, setStoreMediaOnSensor, getSensor, getSensors, findSensorByTopic, findSensorByInternalUrl, findSensorByProtocol, backup/restoreTimeSeriesDB, start/pause/updateContinuousSignalOnJSONConnector |
| sensorControler · 10107 | sensor-controler-service · sensor-controler.wsdl | create/update/destroySensorControler, get/find…, add/update/get/removeDataset…, storeDataset…, resetDataset…, play/pause/stopDataSetOnTopic…, add/remove/getBreakpoints, sendEventToSensor, getXMLDataOfDataset, updateDatasetAndModelConfiguration |
| GameMasterServer · 10110 | game_master-service · game_master_api.wsdl | get/find/create/update/delete/saveGameScenario(s), get/setCurrentGameScenario, exportGameScenarios, updateSensorControlerBackup, updateMockEndpointBackup |
| mockEndpointsManager · 10108 | mock-endpoint-manager-service · mock-endpoints-manager.wsdl | create/delete/start/stopMockEndpoint, stopAllMockEndpoints, updateConfigOfMockEndpoint, get/findMockEndpoint…, runActuatorOnMockEndpoint, add/delete/playExchangeOnMockEndpoint |
| TestCampaign · 10109 | campaignManager · campaignManager.wsdl | create/update/get/deleteCampaign, findCampaignByName, getCampaignWithoutResources, getAllCampaignsWithoutResources, getCampaignsWithoutResourcesByUser, add/update/removeSolution, getSolutionsFromCampaign, findSolutionsByMetrics, findSolutionByName/ById/BySignature, countSolutions, countSolutionsByMetrics, getFailureSolutions, addConceptsPostAnalyze |
| Workflow, tâches et supervision | ||
| WorkflowEngine_deployerService · 10103 | DeploymentService · Process.wsdl | deploy, undeploy, listProcesses, getProcess, subscribeOnDeploymentService |
| WorkflowEngine_commandService | CommandService · CommandService.wsdl | pause, resume, stop, delete, cancel, getProcessModels, modifyRunningProcess |
| <processus>__d_<deploymentId> (par processus déployé) | ProcessInstance.wsdl | runSync, runASync ; rappel sendASyncResponse |
| HumanTask · 10102 | humantaskService · humantask.wsdl | addTaskSync, addTaskASync, updateTask, removeTask, getTask, findTask, getTodoList, findTasksByProcessInstanceId, subscribe/unSubscribeTasksByAssignedToResource ; rappel addTaskASyncCallBack |
| ProcessMonitoring · 10104 | ProcessMonitoring · ProcessMonitoring.wsdl | get/add/update/deleteProcessInstance(s), get/add/update/deleteExchange(s), getProcessInformation, subscribeOnExchangesOfInstance, subscribeOnExchangesOfAllInstances, subscribeOnProcessInstanceEventService |
| Données et intégration | ||
| StorageService · 10100 | storageService · gind-storage.wsdl | put, get, query, update, remove, removeAll (topics de documents notifiés par la variante event storage) |
| timeseries · 19000 | timeseriesService · timeseries.wsdl | createTimeseriesCollection, write, update, query, delete, deleteAll, getTimeseriesCollectionNames, dump/restoreTimeseriesCollection |
| BrokerRegister · BrokerSubscriber · BrokerNotifier · 10105 | event-broker-service · event-broker.wsdl | register, unregister, getAllTopics (+ contrats producteur et notifier) |
| h2_gis · 10111 · osm_gis · 10112 | store_gis · find_gis · store-gis.wsdl, find-gis.wsdl | store_gis : query, loadGeoJSONFile, deployGeoJSONFile, undeployGeoJSONFile, getGeoJSONFilesStored — find_gis : findConceptsFromLatLng, findConceptsInsidePolygon, findConceptsInsideBBox — rappel client : receiveConceptContainedInPolygon, receiveConceptContainedInBBox |
| websocketCommandService · 12000 (côté application web) | websocketCommand.wsdl | getResult — résultat SOAP relayé vers un topic WebSocket |
| echo · concat · 1113 (mocks de test) | echo.wsdl · concat.wsdl | echo · concat — partenaires jouets du processus helloworld |
Les drivers appellent les ressources REST ci-dessus avec des identifiants HTTP Basic et écoutent les topics WebSocket ; les modèles sont les types générés de chaque langage.
| Langage · emplacement | Ports / clients | Opérations |
|---|---|---|
Java · java/packaging/gind-java-driver | IUsers, IMetaModels, IModels, IProcess, ISolution, ITasks, IEvents, IUsecase + écouteurs WSock* | login, logout, getUsers, register, findUserByName, findAssociatedPerson · getPredefinedUsecaseDefinitions, loadUsecase, isAlreadyLoadedUsecase, getUsecaseContext · push, pushpull, reload, query, getNodesByTypesAndOrProperties, get/removeNodeById, get/removeEdgeById · subscribeExchangesByInstance · deduceSolutionASync(FromSimpleSatisfactionStrategy), deploy/undeploy/supervise/select/runASync/cancelSolution · updateTask, subscribeToAddTasksByAssignedToResource · findSensorFromNode, findSensorsByType, start/stopSensor(s), sendEventOnSensor · findSensorsFixedOnto |
Python · python/backend/gind-python-driver | RestDriver ; UsersDriverClient, MetaModelsDriverClient, ModelsDriverClient, ProcessDriverClient, TasksDriverClient, AppUserTaskDriverClient ; ports applicatifs AppUser, AppTask, AppTaskListener | login, logout, get_users · get_usecase_context, get_project_by_name_in_collaboration, get_effective_domain, set_project_mode · push, push_pull, reload, query, get_nodes_by_types_and_or_properties · deduce, deploy, deploy_process, run_async · get_todolist, update_task · refresh_users, find_user_by_id, fonctions WebSocket de liste de tâches |
C# · csharp/backend/gind-csharp-driver | RestDriver ; IUsers, IMetaModels, IModels, IProcess, ITasks, IEvents, ISupervision, IAppUserTask + wsock_functions | login, logout, getUsers · définitions et contexte de cas d’usage · push, pushpull, reload, query, nœud/arête par id · deduce, deploy, deployProcess, undeploy, runSync, runASync, supervise, pause, resume, delete, cancel, exchangesByInstance, subscribeExchangesByInstance · getTodoList, getTasks, updateTask · findSensorsByType, createSensor, start/stopSensor(s), sendEventOnJSONConnector, isSimulation · supervision getState, getPoint, compute (/r-iota/supervision) |
Dart · dart/frontend/gind_r_io4u/lib/driver/rest/adapters | clients Users/System, MetaModels, Models, Solution, Tasks, Events, MockEndpoints, Chatbots, Files, Usecase + écouteurs web_socket/api | getUser(s), updateUser · getProjectByNameInCollaboration, getEffectiveDomain · push, pushpull, query, reload, delete, nœud/arête par id, patchEdge(s) · deduceSolution, deploySolution, runASyncSolution, superviseSolution, undeploySolution, pause, resume, cancel, delete, exchangesByInstance · getTodoList, subscribeToTodoList, updateTask · capteurs start/stop/send/signal continu · mock endpoints et échanges · inventActualities, inventPictures · upload(s) · getGeoLocInstances |
# python/backend/gind-python-driver — context keys mirror unified_config.properties from fr_emac_gind_rio.driver.rest.RestDriver import RestDriver from fr_emac_gind_rio.driver.rest.ports.IProcess import SatisfactionStrategy from fr_emac_gind_rio.utils.system_user import SystemUser from lxml.etree import QName context = {"host": "127.0.0.1", "r-ioda...port": "9102", "r-iose...port": "9110", "r-ioxo...port": "9126", "websocket-command-service-port": "12000"} driver = RestDriver(context, SystemUser("login", "password")) driver.meta_model_driver.get_usecase_context(knowledge_space_name="IMT Albi Crisis", collaboration_name="R-IO Suite") objectives = driver.model_driver.get_nodes_by_types_and_or_properties( types=[QName("http://fr.emac.gind/collaborative-model", "Objective")]) reports = driver.process_driver.deduce(SatisfactionStrategy(objectives_order=objectives)) user = driver.app_user_task_driver.refresh_users()[0] user.login() # opens the WebSocket to-do channel todo = user.refresh_todo_list()
Signatures : RestDriver(context: Dict, user: SystemUser), MetaModelsDriverClient.get_usecase_context(knowledge_space_name, collaboration_name), ModelsDriverClient.get_nodes_by_types_and_or_properties(types, properties=None, node_status=None), ProcessDriverClient.deduce(satisfaction_strategy), AppUser.login(subscribe_on_task=True), AppUser.refresh_todo_list(). Le driver Python adresse r-ioda, r-iose et l’ancien nom r-ioxo (port 9126) ; l’exemple livré dans gind-python-driver-examples-test utilise encore un ancien constructeur et ne doit pas être copié.
// csharp/backend/gind-csharp-driver — one RestDriver for r-ioda, r-iose, r-ioxo and r-iota using gind_csharp_driver_rest; using gind_csharp_utils; using fr_emac_gind_model; using System.Xml; RestDriver driver = RestDriver.createRestDriver("127.0.0.1", 9102, 9110, 9126, 9108, new SystemUser("login", "password")); var ucDef = await driver.metaModelDriver.findPredefinedUsecaseDefinitionByName("IMT Albi Crisis"); UsecaseContext uc = await driver.metaModelDriver.loadUsecase(ucDef, "R-IO Suite"); uc.startWSockUsecaseChannel(); // model events through /ws/pubsub node[] objectives = await driver.modelDriver.getNodesByTypesAndOrProperties( new[] { new XmlQualifiedName("Objective", "http://fr.emac.gind/collaborative-model") }); deductionReport[] reports = await driver.processDriver.deduce(new SatisfactionStrategy(objectives)); genericModel processModel = ((deductionResult)reports[0].Item).genericModel; node processNode = GenericModelUtil.getNodesByType( new XmlQualifiedName("Process", "http://fr.emac.gind/collaborative-model"), processModel)[0]; DeployResult deployed = await driver.processDriver.deploy(processNode);
Signatures : RestDriver.createRestDriver(host, riodaPort, riosePort, rioxoPort, riotaPort, user) (ou createRestDriverFromConfigFile(path, user)), MetaModelsDriverClient.findPredefinedUsecaseDefinitionByName(name), loadUsecase(definition, collaborationName), ModelsDriverClient.getNodesByTypesAndOrProperties(types, properties=null, status=ACTIVE), ProcessDriverClient.deduce(strategy), deploy(processNode). Les identifiants voyagent en jeton HTTP Basic construit par SystemUser ; ne les codez jamais en dur dans du code partagé.
Sur un standalone local, via le serveur r-ioga (port 9100). Remplacez les identifiants par un compte créé dans r-ioga.
# vivacité (sans authentification) curl http://localhost:9100/r-ioga/generic-application/default/ping # lister les collaborations de l’utilisateur authentifié curl -u login:motdepasse http://localhost:9100/r-ioga/generic-application/system/collaboration/collaborations # choisir une collaboration et un espace de connaissance (cadre tous les appels suivants) curl -u login:motdepasse http://localhost:9100/r-ioga/generic-application/system/collaboration/knowledge/select/{collaborationId}/{knowledgeSpaceId} # chercher des nœuds par type dans l’espace de connaissance courant curl -u login:motdepasse -H "Content-Type: application/json" \ -d '{"types":["{http://fr.emac.gind/collaborative-model}Person"]}' \ http://localhost:9100/r-ioga/generic-application/core/nodes/findNodesByTypesAndOrProperties # événements de modèle en direct (topic = hash(collaboration)/hash(espace)/models/) websocat ws://localhost:9100/ws/pubsub/{hashCollab}/{hashKs}/models/