Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "BaSyx / Documentation / Components / Registry / Features"

m (Adds health endpoint documentation)
 
(4 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
The AAS Registry Components supports a multitude of features with a great range of configuration options:
 
The AAS Registry Components supports a multitude of features with a great range of configuration options:
 
* [[BaSyx_/_Documentation_/_Components_/_Registry_/_Features_/_Storage_Backend | Storage Backend]]
 
* [[BaSyx_/_Documentation_/_Components_/_Registry_/_Features_/_Storage_Backend | Storage Backend]]
 +
* [[BaSyx_/_Documentation_/_Components_/_Registry_/_Features_/_Tagged_Directory | Tagged Directory]]
 
* MQTT Eventing
 
* MQTT Eventing
 +
** [[BaSyx_/_Documentation_/_Components_/_Registry_/_Features_/_Hierarchical_MQTT | Hierarchical MQTT Eventing]]
 
** [[BaSyx_/_Documentation_/_Components_/_Registry_/_Features_/_Simple_MQTT | Simple MQTT Eventing]]
 
** [[BaSyx_/_Documentation_/_Components_/_Registry_/_Features_/_Simple_MQTT | Simple MQTT Eventing]]
−
 
+
* [[BaSyx_/_Documentation_/_Components_/_Registry_/_Features_/_Authorization | Authorization]]
−
== Authorization ==
+
* [[BaSyx_/_Documentation_/_Components_/_Features_/_Health Endpoint| Health Endpoint]]
−
 
+
−
Authorization is disabled by default. Basic authorization can be configured in the registry.properties:
+
−
 
+
−
registry.authorization=Enabled
+
−
registry.authorization=Disabled
+
−
 
+
−
== Tagged Directory ==
+
−
 
+
−
The TaggedDirectory is disabled by default. It can be configured in the registry.properties:
+
−
 
+
−
  registry.taggedDirectory=Enabled
+
−
  registry.taggedDirectory=Disabled
+
−
 
+
−
== Tagged Directory ==
+
−
 
+
−
''[Disclaimer: In development branch]''
+
−
A tagged directory is an implementation of the registry that allows to associate AAS with tags. When in use, AAS can be retrieved based on tags. <blockquote>
+
−
'''Disclaimer:''' Currently only works with an InMemory backend. Persistent backends (SQL and MondoDB), as well as combination with Authorization, or MQTT is yet to be supported.
+
−
</blockquote>
+
−
 
+
−
== Authorized AAS Registry ==
+
−
 
+
−
As stated above in [[BaSyx_/_Documentation_/_Components_/_Context | context configuration]] there are some properties stated related to JWT based Authorization. This Authorization
+
−
mechanism makes authorized access to the AAS Registry. Read and write authorization is enabled. In order to read from the registry or write to the registry there is a need of
+
−
authorization token.
+
−
 
+
−
Example demonstrating above scenario is here [[BaSyx_/_Scenarios_/_Authorization | Authorized AAS Registry]].
+
−
 
+
−
== Eventing with MQTT ==
+
−
 
+
−
Additionally, to the '''registry.properties''' file, you need to edit the [[BaSyx_/_Documentation_/_Components_/_MQTT | '''mqtt.properties''' file]] in order to connect to the right MQTT broker. The MQTT configuration file can be found in the same folder as the backend configuration. It allows you to add credentials and a Quality of Service level (default: 1) besides the mandatory server address.
+
−
 
+
−
Information about what events will be published can be found in the [[BaSyx_/_Developer_/_Extensions_/_Eventing | eventing extension]].
+

Latest revision as of 06:23, 2 January 2023

Overview | Interface | Component | Features

AAS Registry Features

The AAS Registry Components supports a multitude of features with a great range of configuration options:

Retrieved from "https://wiki.eclipse.org/index.php?title=BaSyx_/_Documentation_/_Components_/_Registry_/_Features&oldid=446553"

This page was last modified 06:23, 2 January 2023 by Frank Schnicke.

Back to the top