Commit c78b4bef authored by Peter Waher's avatar Peter Waher

Describing sources

parent 1ff662ae
......@@ -56,8 +56,9 @@ the value of the empty string. The quadruple (JID, `id`, `src`, `pt`) should alw
Identities
--------------
The concentrator is free to authorize requests based on the identities provided by the caller. Apart from the JID the caller uses, and the implicit
domain och which the caller has an account, each call can also be annotated using tokens. There are three different types of tokens that can be used:
The concentrator is free to authorize requests based on the identities provided by the caller. It can also restrict or limit the responses to elements
the client is authorized to interact with. Apart from the JID the caller uses, and the implicit domain och which the caller has an account, each call
can also be annotated using tokens. There are three different types of tokens that can be used:
| Attribute | Type | Description |
|:-----------|:--------------|:-------------------|
......@@ -131,13 +132,28 @@ Sources
### getAllDataSources
A client can request a list of all data sources available on a concentrator server by sending a `getAllDataSources` element in a `iq get` to the concentrator.
The concentrator returns a `dataSources` element in the response, consisting of a set of `dataSource` elements, each describing a single data source. Each
`dataSource` contains the following attributes:
| Element | Attribute | Type | Description |
|:-------------|:--------------|:--------------|:-----------------------------------------------------------------------------------------------------------------------------------------|
| `dataSource` | `src` | `xs:string` | Machine-readable identity of the data source. This identity is used in all references to the data source. |
| | `name` | `xs:string` | Human-readable, localized name of the data source. |
| | `hasChildren` | `xs:boolean` | Data sources can be organized in tree structueres. This attribute lets the caller know if the data source has child data sources or not. |
| | `lastChanged` | `xs:dateTime` | Variable data sources use this attribute to report when the last change in the source took place. Used for synchornization. |
### getRootDataSources
### getChildDataSources
A client can request a list of all root data sources available on a concentrator server by sending a `getRootDataSources` element in a `iq get` to the
concentrator. The concentrator returns a `dataSources` element in the response, consisting of a set of `dataSource` elements, each describing a single
root data source.
### subscribe
### getChildDataSources
### unsubscribe
A client can request a list of all child data sources available on a concentrator server by sending a `getChildDataSources` element in a `iq get` to the
concentrator. The source is specified in the `src` attribute. The concentrator returns a `dataSources` element in the response, consisting of a set of
`dataSource` elements, each describing a single child data source.
Nodes
----------
......@@ -210,6 +226,14 @@ Commands
### abortCommonNodeQuery
Events
------------
### subscribe
### unsubscribe
Troubleshooting
---------------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment