Skip to content

Latest commit

 

History

History
521 lines (384 loc) · 12.6 KB

DictionaryPlugin.md

File metadata and controls

521 lines (384 loc) · 12.6 KB

Dictionary Plugin

Version: 1.0

Status: ⚫⚫⚫

Dictionary plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the Dictionary plugin. It includes detailed specification about its configuration, methods provided and notifications sent.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym Description
API Application Programming Interface
HTTP Hypertext Transfer Protocol
JSON JavaScript Object Notation; a data interchange format
JSON-RPC A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term Description
callsign The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID Description
HTTP HTTP specification
JSON-RPC JSON-RPC 2.0 specification
JSON JSON specification
Thunder Thunder API Reference

Description

The Dictionary plugin provides functionality for dictionary management.

The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [Thunder].

Configuration

The table below lists configuration options of the plugin.

Name Type M/O Description
callsign string mandatory Plugin instance name (default: Dictionary)
classname string mandatory Class name: Dictionary
locator string mandatory Library name: libThunderDictionary.so
startmode string mandatory Determines in which state the plugin should be moved to at startup of the framework
configuration object optional ...
configuration?.storage string optional Filename of DataModel file (default: DataModel.json)

Interfaces

This plugin implements the following interfaces:

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Methods

The following methods are provided by the Dictionary plugin:

Built-in methods:

Method Description
versions Retrieves a list of JSON-RPC interfaces offered by this service
exists Checks if a JSON-RPC method or property exists
register Registers for an asynchronous JSON-RPC notification
unregister Unregisters from an asynchronous JSON-RPC notification

Dictionary interface methods:

Method Description
get Getters for the dictionary
set Setters for the dictionary
pathentries Get a list of all entries for this namespace (could be keys or nested namespaces)

versions method

Retrieves a list of JSON-RPC interfaces offered by this service.

Parameters

This method takes no parameters.

Result

Name Type M/O Description
result array mandatory A list ofsinterfaces with their version numbers
Array length must be at most 255 elements.
result[#] object mandatory ...
result[#].name string mandatory Name of the interface
result[#].major integer mandatory Major part of version number
result[#].minor integer mandatory Minor part of version number
result[#].patch integer mandatory Patch part of version version number

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Dictionary.1.versions"
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "name": "JMyInterface",
      "major": 1,
      "minor": 0,
      "patch": 0
    }
  ]
}

exists method

Checks if a JSON-RPC method or property exists.

Description

This method will return True for the following methods/properties: versions, exists, register, unregister, get, set, pathentries.

Parameters

Name Type M/O Description
params object mandatory ...
params.method string mandatory Name of the method or property to look up

Result

Name Type M/O Description
result boolean mandatory Denotes if the method exists or not

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Dictionary.1.exists",
  "params": {
    "method": "versions"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": false
}

register method

Registers for an asynchronous JSON-RPC notification.

Description

This method supports the following event names: modified.

Parameters

Name Type M/O Description
params object mandatory ...
params.event string mandatory Name of the notification to register for
params.id string mandatory Client identifier

Result

Name Type M/O Description
result null mandatory Always null

Errors

Message Description
ERROR_FAILED_REGISTERED Failed to register for the notification (e.g. already registered)

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Dictionary.1.register",
  "params": {
    "event": "modified",
    "id": "myapp"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

unregister method

Unregisters from an asynchronous JSON-RPC notification.

Description

This method supports the following event names: modified.

Parameters

Name Type M/O Description
params object mandatory ...
params.event string mandatory Name of the notification to register for
params.id string mandatory Client identifier

Result

Name Type M/O Description
result null mandatory Always null

Errors

Message Description
ERROR_FAILED_UNREGISTERED Failed to unregister from the notification (e.g. not yet registered)

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Dictionary.1.unregister",
  "params": {
    "event": "modified",
    "id": "myapp"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

get method

Getters for the dictionary.

Parameters

Name Type M/O Description
params object mandatory ...
params.path string mandatory NameSpace path to be used
params.key string mandatory Key to be used

Result

Name Type M/O Description
result string mandatory Value that was retrieved

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Dictionary.1.get",
  "params": {
    "path": "...",
    "key": "..."
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": "..."
}

set method

Setters for the dictionary.

Parameters

Name Type M/O Description
params object mandatory ...
params.path string mandatory NameSpace path to be used
params.key string mandatory Key to be used
params.value string mandatory Value to be set

Result

Name Type M/O Description
result null mandatory Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Dictionary.1.set",
  "params": {
    "path": "...",
    "key": "...",
    "value": "..."
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

pathentries method

Get a list of all entries for this namespace (could be keys or nested namespaces).

Parameters

Name Type M/O Description
params object mandatory ...
params.path string mandatory Namespace path where to get the keys and/or nested namespaces for

Result

Name Type M/O Description
result array mandatory Available nested namespaces and keys for this namespace path
result[#] object mandatory ...
result[#].name string mandatory Name of Key or Namespace
result[#].type string mandatory Type (must be one of the following: Namespace, PersistentKey, VolatileKey)

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Dictionary.1.pathentries",
  "params": {
    "path": "..."
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "name": "...",
      "type": "PersistentKey"
    }
  ]
}

Notifications

Notifications are autonomous events triggered by the internals of the implementation and broadcasted via JSON-RPC to all registered observers. Refer to [Thunder] for information on how to register for a notification.

The following events are provided by the Dictionary plugin:

Dictionary interface events:

Notification Description
modified Changes on the subscribed namespace

modified notification

Changes on the subscribed namespace..

Parameters

The path parameter shall be passed as index to the register call, i.e. register@<path>.

Notification Parameters

Name Type M/O Description
params object mandatory ...
params.key string mandatory Key which value changed
params.value string mandatory Value that changed

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Dictionary.1.register@abc",
  "params": {
    "event": "modified",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.modified@abc",
  "params": {
    "key": "...",
    "value": "..."
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.modified@<path>.