Feature impr/digital twin registry by FaheemBhatti · Pull Request #859 · eclipse-basyx/basyx-java-server-sdk

FaheemBhatti · 2025-09-17T12:29:00Z

Description of Changes

This PR adds integration between AASRegistry and AASDIscovery:

The /shell-description endpoint behavior --> calling this endpoint internally calls the discover /lookup endpoint for POST call
The combined AASRegistry and AASDiscovery functionality
The ShellDescriptorsApiDelegate implementation (decorator pattern logic)
Module structure or delegate-based design aspects

Related Issue

BaSyx Configuration for Testing

The Digital Twin Registry supports multiple storage profiles.

Base Configuration (`application.yml`)

SPRING_PROFILE: InMemory or MongoDB (default: MongoDB)
LOGGING_LEVEL: INFO (default)
server.port: 8081
basyx.cors.allowed-methods: GET,POST,PATCH,DELETE,PUT,OPTIONS,HEAD
basyx.cors.allowed-origins: *
management.endpoints.web.exposure.include: health,metrics,mappings
springdoc.api-docs.enabled: true
springdoc.swagger-ui.enabled: true
springdoc.swagger-ui.path: /swagger-ui.html

application-MongoDB.yml

basyx.backend: MongoDB
registry.type: MongoDB
registry.discovery.enabled: true
basyx.aasdiscoveryservice.mongodb.collectionName: aasregistry

application-InMemory.yml

basyx.backend: InMemory
registry.type: InMemory
registry.discovery.enabled: true

MongoDB-specific environment variables:

AUTHENTICATION_DATABASE: <db_name>
DATABASE_HOST: localhost
DATABASE_PORT: <numeric_port>
DATABASE_USERNAME: <db_username>
DATABASE_PASSWORD: <db_password>

aaronzi

Thanks for the PR. I added some review remarks. Please have a look

aaronzi · 2025-09-19T12:15:05Z

+ * SPDX-License-Identifier: MIT
+ ******************************************************************************/
+
+package org.eclipse.digitaltwin.basyx.aasdigitaltwinregistry.component.controllerAdvice;


Please name the package digitaltwinregistry in a consistent way

Suggested change

package org.eclipse.digitaltwin.basyx.aasdigitaltwinregistry.component.controllerAdvice;

package org.eclipse.digitaltwin.basyx.digitaltwinregistry.component.controllerAdvice;

Refactored the package

aaronzi · 2025-09-19T12:15:25Z

          path: basyx.submodelregistry/basyx.submodelregistry-service-release-log-mem/src/main/docker
        - name: submodel-registry-log-mongodb
          path: basyx.submodelregistry/basyx.submodelregistry-service-release-log-mongodb/src/main/docker
+        - name: aas-digitaltwinregistry


Suggested change

- name: aas-digitaltwinregistry

- name: digitaltwinregistry

aaronzi · 2025-09-19T12:15:35Z

          path: basyx.submodelregistry/basyx.submodelregistry-service-release-log-mem/src/main/docker
        - name: submodel-registry-log-mongodb
          path: basyx.submodelregistry/basyx.submodelregistry-service-release-log-mongodb/src/main/docker
+        - name: aas-digitaltwinregistry


Suggested change

- name: aas-digitaltwinregistry

- name: digitaltwinregistry

aaronzi · 2025-09-19T12:15:48Z

@@ -0,0 +1,173 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors


Suggested change

* Copyright (C) 2024 the Eclipse BaSyx Authors

* Copyright (C) 2025 the Eclipse BaSyx Authors

aaronzi · 2025-09-19T12:17:04Z

Please revert cosmetic changes and version changes

aaronzi · 2025-09-19T12:26:00Z

+@ConditionalOnProperty(name = "discoveryintegration.enabled", havingValue = "true", matchIfMissing = false)
+public class DiscoveryIntegrationAasRegistryConfiguration {
+
+	@Value("${discoveryintegration.baseUrl:#{null}}")


Suggested change

@Value("${discoveryintegration.baseUrl:#{null}}")

@Value("${basyx.aasregistry.feature.discoveryintegration:#{null}}")

aaronzi · 2025-09-19T12:26:50Z

+
+@Component
+@Slf4j
+@ConditionalOnProperty(name = "discoveryintegration.enabled", havingValue = "true", matchIfMissing = false)


Suggested change

@ConditionalOnProperty(name = "discoveryintegration.enabled", havingValue = "true", matchIfMissing = false)

@ConditionalOnProperty(name = "basyx.aasregistry.feature.discoveryintegration.enabled", havingValue = "true", matchIfMissing = false)

aaronzi · 2025-09-19T12:27:16Z

+@ConditionalOnProperty(name = "discoveryintegration.enabled", havingValue = "true", matchIfMissing = false)
+public class DiscoveryIntegrationAasRegistryFeature implements AasRegistryStorageFeature {
+
+	@Value("${discoveryintegration.baseUrl:#{null}}")


Suggested change

@Value("${discoveryintegration.baseUrl:#{null}}")

@Value("${basyx.aasregistry.feature.discoveryintegration:#{null}}")

aaronzi · 2025-09-19T12:30:47Z

+    <properties>
+        <java.version>17</java.version>
+        <maven.compiler.source>${java.version}</maven.compiler.source>
+        <maven.compiler.target>${java.version}</maven.compiler.target>
+        <skipTests>false</skipTests>
+        <maven.test.skip>false</maven.test.skip>
+    </properties>


Please remove the properties. This is handled by the parent pom

aaronzi · 2025-09-19T12:32:28Z

+    <properties>
+        <java.version>17</java.version>
+        <maven.compiler.source>${java.version}</maven.compiler.source>
+        <maven.compiler.target>${java.version}</maven.compiler.target>
+    </properties>


Please remove the properties

FaheemBhatti · 2025-09-22T22:51:04Z

@aaronzi
Thanks for the feedback. I have implemented most of the changes you asked for, but you asked for adding the DTR dependency to all the registry features. Just for my understanding --> What benefit will this bring? Will it also not create a circular reference?

aaronzi · 2025-09-23T06:20:00Z

Thanks for addressing my remarks :)

I meant the discovery integration feature should be added to all the AAS Registry variations, not the DTR. Sorry for the misunderstanding.

FaheemBhatti · 2025-09-23T22:22:18Z

@aaronzi
While testing the feature, I noticed that the encoding is handled at the service layer, so I made a small adjustment accordingly.

Regarding the discovery integration for all AAS registry variations, could you clarify whether this refers to extending support for both the MongoDB and InMemory solutions (already been handled and tested), or if it involves creating a separate configuration within each module? Sorry for being dumb here, I am not getting this completely.

aaronzi · 2025-09-24T10:27:33Z

the AAS Registry essentially has 4 components that all should have this feature:

The discovery integration feature has to be made available to all of those components via their respective POMs

…very feature in aas registry variations

aaronzi · 2025-10-14T13:20:29Z

Hi @FaheemBhatti thanks for your changes. I think the discovery integration dependency is still missing in those two packages:

faheem and others added 12 commits September 10, 2025 00:20

DTR initial commit

1fc983b

feature printer addition

a957cd8

custom documentation

d26858f

adding SPDX-License-Identifier to the new added files

bd1ea30

review suggested changes from Arno

322f005

UT's

536e9ee

feature aas digital twin registry

df4edc9

feature digital twin registry

c71b94f

log level from TRACE --> INFO

9019393

Merge branch 'main' into feature-impr/digital-twin-registry

18cb042

merge failure resolve

edf654a

update parent pom to revert not needed changes

dc9c695

muhammadumairsabir approved these changes Sep 17, 2025

View reviewed changes

aaronzi requested changes Sep 19, 2025

View reviewed changes

faheem added 7 commits September 22, 2025 23:45

refactoring acc to the requested changes

3fcb341

docs updation

c0887a3

revert cosmetic changes on parent pom

44ca62d

remove db details

017da72

remove circular reference

c61e2ea

removing circular ref

e5eb15e

cosmetic changes revert

0294630

improve log statement in the DiscoveryIntegrationAasRegistrytest class

c883574

exclusion optimization and discovery behaviour adjust acc to actual

58ab66c

faheem added 3 commits September 24, 2025 13:26

resolve test failures in the discovery feature integration, add disco…

5eccbe5

…very feature in aas registry variations

dtr module to InMemory from MongoDB to test workflows

3ca5865

updating the registry poms

23112eb

pom updatin

e983206

faheem added 3 commits October 14, 2025 16:14

pom updation

d1820ff

removing potential dependecies causing bean pollution

5a85b3a

test properties for the aas registry digital twin feature

9f53b63

aaronzi merged commit 9a45918 into eclipse-basyx:main Oct 14, 2025
45 of 46 checks passed

krah034 mentioned this pull request Nov 11, 2025

Add BaSyx Digital Twin Registry factory-x-contributions/async-aas-helm#89

Merged

	package org.eclipse.digitaltwin.basyx.aasdigitaltwinregistry.component.controllerAdvice;
	package org.eclipse.digitaltwin.basyx.digitaltwinregistry.component.controllerAdvice;

		@@ -0,0 +1,173 @@
		/*******************************************************************************
		* Copyright (C) 2024 the Eclipse BaSyx Authors

	* Copyright (C) 2024 the Eclipse BaSyx Authors
	* Copyright (C) 2025 the Eclipse BaSyx Authors

	@Value("${discoveryintegration.baseUrl:#{null}}")
	@Value("${basyx.aasregistry.feature.discoveryintegration:#{null}}")

	@ConditionalOnProperty(name = "discoveryintegration.enabled", havingValue = "true", matchIfMissing = false)
	@ConditionalOnProperty(name = "basyx.aasregistry.feature.discoveryintegration.enabled", havingValue = "true", matchIfMissing = false)

Conversation

FaheemBhatti commented Sep 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Changes

Related Issue

BaSyx Configuration for Testing

Base Configuration (application.yml)

Uh oh!

aaronzi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FaheemBhatti commented Sep 22, 2025

Uh oh!

aaronzi commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FaheemBhatti commented Sep 23, 2025

Uh oh!

aaronzi commented Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aaronzi commented Oct 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

FaheemBhatti commented Sep 17, 2025 •

edited

Loading

Base Configuration (`application.yml`)

aaronzi commented Sep 23, 2025 •

edited

Loading

aaronzi commented Sep 24, 2025 •

edited

Loading