update to API specification v3.0

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/registry/core/AasRepository.java

@@ -19,6 +19,7 @@
 import de.fraunhofer.iosb.ilt.faaast.service.model.descriptor.AssetAdministrationShellDescriptor;
 import de.fraunhofer.iosb.ilt.faaast.service.model.descriptor.SubmodelDescriptor;
 import java.util.List;
+import org.eclipse.digitaltwin.aas4j.v3.model.AssetKind;
 
 
 /**
@@ -34,6 +35,16 @@ public interface AasRepository {
     public List<AssetAdministrationShellDescriptor> getAASs();
 
 
+    /**
+     * Retrieves a list of all registered Asset Administration Shells which meet the given conditions.
+     *
+     * @param assetType The desired Asset Type.
+     * @param assetKind The desired Asset Kind.
+     * @return The list of all registered Asset Administration Shells.
+     */
+    public List<AssetAdministrationShellDescriptor> getAASs(String assetType, AssetKind assetKind);
+
+
     /**
      * Retrieves the Asset Administration Shell with the given ID.
      *

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/registry/core/AbstractAasRepository.java

@@ -32,6 +32,12 @@ public abstract class AbstractAasRepository implements AasRepository {
     protected AbstractAasRepository() {}
 
 
+    @Override
+    public List<AssetAdministrationShellDescriptor> getAASs() {
+        return getAASs(null, null);
+    }
+
+
     /**
      * Creates a new {@link ResourceNotFoundException} for the AAS.
      *
@@ -96,8 +102,7 @@ protected static ResourceNotFoundException buildSubmodelNotFoundInAASException(S
      */
     protected static void ensureDescriptorId(AssetAdministrationShellDescriptor descriptor) {
         Ensure.requireNonNull(descriptor, "descriptor must be non-null");
-        Ensure.requireNonNull(descriptor.getIdentification(), "descriptor.identification must be non-null");
-        Ensure.requireNonNull(descriptor.getIdentification().getIdentifier(), "descriptor id must be non-null");
+        Ensure.requireNonNull(descriptor.getId(), "descriptor id must be non-null");
     }
 
 
@@ -109,8 +114,7 @@ protected static void ensureDescriptorId(AssetAdministrationShellDescriptor desc
      */
     protected static void ensureDescriptorId(SubmodelDescriptor descriptor) {
         Ensure.requireNonNull(descriptor, "descriptor must be non-null");
-        Ensure.requireNonNull(descriptor.getIdentification(), "descriptor.identification must be non-null");
-        Ensure.requireNonNull(descriptor.getIdentification().getIdentifier(), "descriptor id must be non-null");
+        Ensure.requireNonNull(descriptor.getId(), "descriptor id must be non-null");
     }
 
 
@@ -145,11 +149,9 @@ protected static void ensureSubmodelId(String submodelId) {
      */
     protected static Optional<SubmodelDescriptor> getSubmodelInternal(List<SubmodelDescriptor> submodels, String submodelId) {
         return submodels.stream()
-                .filter(x -> Objects.nonNull(x.getIdentification())
-                        && Objects.nonNull(x.getIdentification().getIdentifier())
-                        && Objects.equals(x.getIdentification().getIdentifier(), submodelId))
+                .filter(x -> Objects.nonNull(x.getId())
+                        && Objects.equals(x.getId(), submodelId))
                 .findAny();
-
     }
 
 }

core/src/test/java/de/fraunhofer/iosb/ilt/faaast/registry/core/AbstractAasRepositoryTest.java

@@ -21,18 +21,17 @@
 import de.fraunhofer.iosb.ilt.faaast.service.model.descriptor.impl.DefaultEndpoint;
 import de.fraunhofer.iosb.ilt.faaast.service.model.descriptor.impl.DefaultProtocolInformation;
 import de.fraunhofer.iosb.ilt.faaast.service.model.descriptor.impl.DefaultSubmodelDescriptor;
-import io.adminshell.aas.v3.model.IdentifierType;
-import io.adminshell.aas.v3.model.KeyElements;
-import io.adminshell.aas.v3.model.KeyType;
-import io.adminshell.aas.v3.model.LangString;
-import io.adminshell.aas.v3.model.impl.DefaultAdministrativeInformation;
-import io.adminshell.aas.v3.model.impl.DefaultIdentifier;
-import io.adminshell.aas.v3.model.impl.DefaultIdentifierKeyValuePair;
-import io.adminshell.aas.v3.model.impl.DefaultKey;
-import io.adminshell.aas.v3.model.impl.DefaultReference;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import org.eclipse.digitaltwin.aas4j.v3.model.KeyTypes;
+import org.eclipse.digitaltwin.aas4j.v3.model.ReferenceTypes;
+import org.eclipse.digitaltwin.aas4j.v3.model.impl.DefaultAdministrativeInformation;
+import org.eclipse.digitaltwin.aas4j.v3.model.impl.DefaultKey;
+import org.eclipse.digitaltwin.aas4j.v3.model.impl.DefaultLangStringNameType;
+import org.eclipse.digitaltwin.aas4j.v3.model.impl.DefaultLangStringTextType;
+import org.eclipse.digitaltwin.aas4j.v3.model.impl.DefaultReference;
+import org.eclipse.digitaltwin.aas4j.v3.model.impl.DefaultSpecificAssetId;
 import org.junit.After;
 import org.junit.Assert;
 import org.junit.Test;
@@ -51,18 +50,15 @@ public void clearDatastore() {}
     protected DefaultSubmodelDescriptor getSubmodel() {
         return DefaultSubmodelDescriptor.builder()
                 .idShort("Submodel2")
-                .identification(new DefaultIdentifier.Builder()
-                        .idType(IdentifierType.CUSTOM)
-                        .identifier("TestSubmodel2")
-                        .build())
-                .description(new LangString("some submodel", "en-US"))
-                .displayName(new LangString("Submodel 2 Name", "de-DE"))
+                .id("TestSubmodel2")
+                .description(new DefaultLangStringTextType.Builder().text("some submodel").language("en-US").build())
+                .displayName(new DefaultLangStringNameType.Builder().text("Submodel 2 Name").language("de-DE").build())
                 .semanticId(new DefaultReference.Builder()
-                        .key(new DefaultKey.Builder()
-                                .idType(KeyType.IRI)
-                                .type(KeyElements.SUBMODEL)
+                        .keys(new DefaultKey.Builder()
+                                .type(KeyTypes.SUBMODEL)
                                 .value("http://example.org/smTest2")
                                 .build())
+                        .type(ReferenceTypes.EXTERNAL_REFERENCE)
                         .build())
                 .administration(new DefaultAdministrativeInformation.Builder()
                         .revision("1")
@@ -71,7 +67,7 @@ protected DefaultSubmodelDescriptor getSubmodel() {
                 .endpoint(DefaultEndpoint.builder()
                         .interfaceInformation("http")
                         .protocolInformation(DefaultProtocolInformation.builder()
-                                .endpointAddress("localhost:8080/factory1/submodel2")
+                                .href("localhost:8080/factory1/submodel2")
                                 .endpointProtocol("http")
                                 .build())
                         .build())
@@ -82,64 +78,52 @@ protected DefaultSubmodelDescriptor getSubmodel() {
     protected AssetAdministrationShellDescriptor getAASWithSubmodel() {
         AssetAdministrationShellDescriptor aas = DefaultAssetAdministrationShellDescriptor.builder()
                 .idShort("Test1")
-                .identification(new DefaultIdentifier.Builder()
-                        .idType(IdentifierType.CUSTOM)
-                        .identifier("TestAAS1")
-                        .build())
-                .description(new LangString("some aas", "en-US"))
-                .displayName(new LangString("Test 1 AAS", "en-US"))
+                .id("TestAAS1")
+                .description(new DefaultLangStringTextType.Builder().text("some aas").language("en-US").build())
+                .displayName(new DefaultLangStringNameType.Builder().text("Test 1 AAS").language("en-US").build())
                 .administration(new DefaultAdministrativeInformation.Builder()
                         .revision("1")
                         .version("1.1")
                         .build())
-                .specificAssetIds(new ArrayList<>(Arrays.asList(new DefaultIdentifierKeyValuePair.Builder()
+                .specificAssetIds(new ArrayList<>(Arrays.asList(new DefaultSpecificAssetId.Builder()
+                        .name("TestKey")
+                        .value("ValueTest")
                         .externalSubjectId(new DefaultReference.Builder()
-                                .key(new DefaultKey.Builder()
-                                        .idType(KeyType.IRI)
-                                        .type(KeyElements.ASSET)
+                                .keys(new DefaultKey.Builder()
+                                        .type(KeyTypes.GLOBAL_REFERENCE)
                                         .value("http://example.org/aasTest1")
                                         .build())
+                                .type(ReferenceTypes.EXTERNAL_REFERENCE)
                                 .build())
                         .semanticId(new DefaultReference.Builder()
-                                .key(new DefaultKey.Builder()
-                                        .idType(KeyType.IRI)
-                                        .type(KeyElements.ASSET)
+                                .keys(new DefaultKey.Builder()
+                                        .type(KeyTypes.GLOBAL_REFERENCE)
                                         .value("http://example.org/aasTest1")
                                         .build())
+                                .type(ReferenceTypes.EXTERNAL_REFERENCE)
                                 .build())
-                        .key("TestKey")
-                        .value("ValueTest")
                         .build())))
-                .globalAssetId(new DefaultReference.Builder()
-                        .key(new DefaultKey.Builder()
-                                .idType(KeyType.IRI)
-                                .type(KeyElements.ASSET)
-                                .value("http://example.org/aasTest1")
-                                .build())
-                        .build())
+                .globalAssetId("http://example.org/aasTest1")
                 .endpoint(DefaultEndpoint.builder()
                         .interfaceInformation("http")
                         .protocolInformation(DefaultProtocolInformation.builder()
-                                .endpointAddress("localhost:8080/factory1")
+                                .href("localhost:8080/factory1")
                                 .endpointProtocol("http")
                                 .build())
                         .build())
                 .build();
         List<SubmodelDescriptor> submodels = new ArrayList<>();
         submodels.add(DefaultSubmodelDescriptor.builder()
                 .idShort("Submodel1")
-                .identification(new DefaultIdentifier.Builder()
-                        .idType(IdentifierType.CUSTOM)
-                        .identifier("TestSubmodel1")
-                        .build())
-                .description(new LangString("some submodel", "en-US"))
-                .displayName(new LangString("Submodel 1 Name", "en-US"))
+                .id("TestSubmodel1")
+                .description(new DefaultLangStringTextType.Builder().text("some submodel").language("en-US").build())
+                .displayName(new DefaultLangStringNameType.Builder().text("Submodel 1 Name").language("en-US").build())
                 .semanticId(new DefaultReference.Builder()
-                        .key(new DefaultKey.Builder()
-                                .idType(KeyType.IRI)
-                                .type(KeyElements.SUBMODEL)
+                        .keys(new DefaultKey.Builder()
+                                .type(KeyTypes.SUBMODEL)
                                 .value("http://example.org/smTest1")
                                 .build())
+                        .type(ReferenceTypes.EXTERNAL_REFERENCE)
                         .build())
                 .administration(new DefaultAdministrativeInformation.Builder()
                         .revision("1")
@@ -148,7 +132,7 @@ protected AssetAdministrationShellDescriptor getAASWithSubmodel() {
                 .endpoint(DefaultEndpoint.builder()
                         .interfaceInformation("http")
                         .protocolInformation(DefaultProtocolInformation.builder()
-                                .endpointAddress("localhost:8080/factory1/submodel")
+                                .href("localhost:8080/factory1/submodel")
                                 .endpointProtocol("http")
                                 .build())
                         .build())
@@ -189,7 +173,7 @@ public void updateAAS() throws Exception {
         aas.setIdShort("NewIdShort");
         aas.getSubmodels().get(0).setIdShort("NewSubmodelIdShort");
         repository.update(aasId, aas);
-        aas = repository.getAAS(aas.getIdentification().getIdentifier());
+        aas = repository.getAAS(aas.getId());
         Assert.assertEquals("NewIdShort", aas.getIdShort());
         Assert.assertEquals("NewSubmodelIdShort", aas.getSubmodels().get(0).getIdShort());
     }
@@ -217,8 +201,8 @@ public void createSubmodelToAAS() throws Exception {
         SubmodelDescriptor submodel = getSubmodel();
         AssetAdministrationShellDescriptor aas = getAASWithSubmodel();
         repository.create(aas);
-        repository.addSubmodel(aas.getIdentification().getIdentifier(), submodel);
-        compareSubmodel(submodel, repository.getSubmodel(aas.getIdentification().getIdentifier(), submodel.getIdentification().getIdentifier()));
+        repository.addSubmodel(aas.getId(), submodel);
+        compareSubmodel(submodel, repository.getSubmodel(aas.getId(), submodel.getId()));
     }
 
 
@@ -227,7 +211,7 @@ public void listAllSubmodels() throws Exception {
         repository.create(getAASWithSubmodel());
         repository.addSubmodel(getSubmodel());
         List<SubmodelDescriptor> submodels = repository.getSubmodels();
-        Assert.assertEquals(2, submodels.size());
+        Assert.assertEquals(1, submodels.size());
     }
 
 
@@ -238,9 +222,10 @@ public void findStandAloneSubmodelById() throws Exception {
         repository.create(getAASWithSubmodel());
         repository.addSubmodel(submodel);
 
-        SubmodelDescriptor findSubmodel = repository.getSubmodel(aas.getSubmodels().get(0).getIdentification().getIdentifier());
-        Assert.assertNotNull(findSubmodel);
-        findSubmodel = repository.getSubmodel(submodel.getIdentification().getIdentifier());
+        SubmodelDescriptor findSubmodel;
+        // Ensure, submodel of the AAS is not registered
+        Assert.assertThrows(ResourceNotFoundException.class, () -> repository.getSubmodel(aas.getSubmodels().get(0).getId()));
+        findSubmodel = repository.getSubmodel(submodel.getId());
         Assert.assertNotNull(findSubmodel);
     }
 
@@ -250,9 +235,9 @@ public void findAASSubmodelById() throws Exception {
         AssetAdministrationShellDescriptor aas = getAASWithSubmodel();
         SubmodelDescriptor submodel = getSubmodel();
         repository.create(getAASWithSubmodel());
-        repository.addSubmodel(aas.getIdentification().getIdentifier(), submodel);
+        repository.addSubmodel(aas.getId(), submodel);
 
-        SubmodelDescriptor findSubmodel = repository.getSubmodel(aas.getIdentification().getIdentifier(), submodel.getIdentification().getIdentifier());
+        SubmodelDescriptor findSubmodel = repository.getSubmodel(aas.getId(), submodel.getId());
         Assert.assertNotNull(findSubmodel);
     }
 
@@ -261,10 +246,10 @@ public void findAASSubmodelById() throws Exception {
     public void deleteStandAloneSubmodel() throws Exception {
         SubmodelDescriptor submodel = getSubmodel();
         repository.addSubmodel(submodel);
-        compareSubmodel(submodel, repository.getSubmodel(submodel.getIdentification().getIdentifier()));
+        compareSubmodel(submodel, repository.getSubmodel(submodel.getId()));
 
-        repository.deleteSubmodel(submodel.getIdentification().getIdentifier());
-        Assert.assertThrows(ResourceNotFoundException.class, () -> repository.getSubmodel(submodel.getIdentification().getIdentifier()));
+        repository.deleteSubmodel(submodel.getId());
+        Assert.assertThrows(ResourceNotFoundException.class, () -> repository.getSubmodel(submodel.getId()));
     }
 
 
@@ -273,12 +258,12 @@ public void deleteAASSubmodel() throws Exception {
         SubmodelDescriptor submodel = getSubmodel();
         AssetAdministrationShellDescriptor aas = getAASWithSubmodel();
         repository.create(aas);
-        repository.addSubmodel(aas.getIdentification().getIdentifier(), submodel);
-        compareSubmodel(submodel, repository.getSubmodel(aas.getIdentification().getIdentifier(), submodel.getIdentification().getIdentifier()));
+        repository.addSubmodel(aas.getId(), submodel);
+        compareSubmodel(submodel, repository.getSubmodel(aas.getId(), submodel.getId()));
 
-        repository.deleteSubmodel(aas.getIdentification().getIdentifier(), submodel.getIdentification().getIdentifier());
+        repository.deleteSubmodel(aas.getId(), submodel.getId());
 
-        Assert.assertThrows(ResourceNotFoundException.class, () -> repository.getSubmodel(aas.getIdentification().getIdentifier(), submodel.getIdentification().getIdentifier()));
+        Assert.assertThrows(ResourceNotFoundException.class, () -> repository.getSubmodel(aas.getId(), submodel.getId()));
     }
 
 

docs/source/index.md

@@ -1,14 +1,14 @@
 # FA³ST Registry
 ![FA³ST Logo Light](./images/Fa3st-Registry_positiv.png "FA³ST Registry Logo")
 
-The **F**raunhofer **A**dvanced **A**sset **A**dministration **S**hell **T**ools (**FA³ST**) Registry implements the Registry for the [Asset Administration Shell (AAS) specification by Plattform Industrie 4.0](https://www.plattform-i40.de/SiteGlobals/IP/Forms/Listen/Downloads/EN/Downloads_Formular.html?cl2Categories_TechnologieAnwendungsbereich_name=Verwaltungsschale) and provides an easy-to-use Registry for AAS.
+The **F**raunhofer **A**dvanced **A**sset **A**dministration **S**hell **T**ools (**FA³ST**) Registry implements the Registry for the [Asset Administration Shell (AAS) specification by IDTA](https://industrialdigitaltwin.org/content-hub/downloads) and provides an easy-to-use Registry for AAS.
 
 The FA³ST Registry contains two separate Registry instances: An AAS Registry for Asset Administration Shell (AAS) Descriptors, and a Submodel Registry for Submodel Descriptors. These Registry instances are strictly separated, i.e. when an AAS with Submodels is registered in the AAS Registry, the Submodels of this AAS won't be registered in the Submodel Registry. If you want these Submodels to be registered in the Submodel Registry, you must register them in the Submodel Registry separately.
 
 ## Implemented AAS Specification
 | Specification | Version |
 |:--| -- |
-| Details of the Asset Administration Shell - Part 2<br />Interoperability at Runtime – Exchanging Information via Application Programming Interfaces | Version 1.0RC02<br />([specification](https://www.plattform-i40.de/IP/Redaktion/EN/Downloads/Publikation/Details_of_the_Asset_Administration_Shell_Part2_V1.pdf))<br />([swagger](https://app.swaggerhub.com/apis/Plattform_i40/Entire-API-Collection/V1.0RC02)) |
+| Details of the Asset Administration Shell - Part 2<br />Application Programming Interfaces | Version 3.0<br />([specification](https://industrialdigitaltwin.org/wp-content/uploads/2023/06/IDTA-01002-3-0_SpecificationAssetAdministrationShell_Part2_API_.pdf))<br />([swagger](https://app.swaggerhub.com/apis/Plattform_i40/Entire-API-Collection/V3.0.1)) |
 
 ## Features
 

persistence/jpa/pom.xml

@@ -45,7 +45,7 @@
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>org.hibernate</groupId>
+            <groupId>org.hibernate.orm</groupId>
             <artifactId>hibernate-core</artifactId>
             <version>${hibernate.version}</version>
         </dependency>