Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion server/app/interfaces/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import io
import itertools
import json
from typing import Any, Callable, Dict, Iterable, Iterator, List, Optional, Tuple, Type, TypeVar, Union
from typing import Any, Callable, Dict, Iterable, Iterator, List, Optional, Protocol, Tuple, Type, TypeVar, Union, runtime_checkable

import werkzeug.exceptions
import werkzeug.routing
Expand Down Expand Up @@ -295,6 +295,24 @@ def http_exception_to_response(
return response_type(result, status=exception.code, headers=headers)


@runtime_checkable
class QueryableObjectStore(Protocol):
"""Structural protocol for object stores that support AASQL querying.

Implement ``query(aasql_body, return_var)`` to advertise query support.
No explicit inheritance required — duck-typing via ``isinstance`` works at runtime.
"""

def query(self, aasql_body: str, return_var: str) -> List[dict]:
"""Execute an AASQL query and return matching serialized AAS objects.

:param aasql_body: raw AASQL JSON string
:param return_var: Cypher return variable name (``"sm"`` or ``"aas"``)
:return: list of serialized AAS/Submodel dicts
"""
...


class ObjectStoreWSGIApp(BaseWSGIApp):
object_store: AbstractObjectStore

Expand Down
38 changes: 36 additions & 2 deletions server/app/interfaces/repository.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,16 @@

from app.interfaces.base import PagingMetadata
from app.util.converters import IdentifierToBase64URLConverter, IdShortPathConverter, base64url_decode
from .base import ObjectStoreWSGIApp, APIResponse, is_stripped_request, HTTPApiDecoder, T
from .base import ObjectStoreWSGIApp, APIResponse, is_stripped_request, HTTPApiDecoder, QueryableObjectStore, T
from app.model import ServiceSpecificationProfileEnum, ServiceDescription

SUPPORTED_PROFILES: ServiceDescription = ServiceDescription([
ServiceSpecificationProfileEnum.AAS_REPOSITORY_FULL,
ServiceSpecificationProfileEnum.SUBMODEL_REPOSITORY_FULL,
ServiceSpecificationProfileEnum.AAS_REPOSITORY_READ,
ServiceSpecificationProfileEnum.SUBMODEL_REPOSITORY_READ,
# ServiceSpecificationProfileEnum.AAS_REPOSITORY_QUERY,
# ServiceSpecificationProfileEnum.SUBMODEL_REPOSITORY_QUERY,
])


Expand All @@ -49,6 +51,8 @@ def __init__(
Submount(
base_path,
[
Rule("/query/shells", methods=["POST"], endpoint=self.query_shells),
Rule("/query/submodels", methods=["POST"], endpoint=self.query_submodels),
Rule("/serialization", methods=["GET"], endpoint=self.not_implemented),
Rule("/description", methods=["GET"], endpoint=self.get_description),
Rule("/shells", methods=["GET"], endpoint=self.get_aas_all),
Expand Down Expand Up @@ -517,12 +521,42 @@ def _get_submodel_submodel_elements_id_short_path(self, url_args: Dict) -> model
def _get_concept_description(self, url_args):
return self._get_obj_ts(url_args["concept_id"], model.ConceptDescription)

def query_submodels(self, request: Request, url_args: Dict, **_kwargs) -> Response:
if not isinstance(self.object_store, QueryableObjectStore):
raise werkzeug.exceptions.NotImplemented("The current store does not support AASQL queries")
try:
results = self.object_store.query(request.get_data(as_text=True), "sm")
except (json.JSONDecodeError, ValueError) as e:
raise BadRequest(f"Invalid AASQL query: {e}") from e
return Response(
json.dumps({"paging_metadata": {"resultType": "Submodel"}, "result": results}),
content_type="application/json",
)

def query_shells(self, request: Request, url_args: Dict, **_kwargs) -> Response:
if not isinstance(self.object_store, QueryableObjectStore):
raise werkzeug.exceptions.NotImplemented("The current store does not support AASQL queries")
try:
results = self.object_store.query(request.get_data(as_text=True), "aas")
except (json.JSONDecodeError, ValueError) as e:
raise BadRequest(f"Invalid AASQL query: {e}") from e
return Response(
json.dumps({"paging_metadata": {"resultType": "AssetAdministrationShell"}, "result": results}),
content_type="application/json",
)

# ------ all not implemented ROUTES -------
def not_implemented(self, request: Request, url_args: Dict, **_kwargs) -> Response:
raise werkzeug.exceptions.NotImplemented("This route is not implemented!")

def get_description(self, request: Request, url_args: Dict, response_t: Type[APIResponse], **_kwargs) -> Response:
return response_t(SUPPORTED_PROFILES.to_dict())
profiles = SUPPORTED_PROFILES.to_dict()
if isinstance(self.object_store, QueryableObjectStore):
profiles["profiles"].extend([
ServiceSpecificationProfileEnum.AAS_REPOSITORY_QUERY.value,
ServiceSpecificationProfileEnum.SUBMODEL_REPOSITORY_QUERY.value,
])
return response_t(profiles)

# ------ AAS REPO ROUTES -------
def get_aas_all(self, request: Request, url_args: Dict, response_t: Type[APIResponse], **_kwargs) -> Response:
Expand Down
44 changes: 25 additions & 19 deletions server/app/model/provider.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import json
from pathlib import Path
from typing import IO, Dict, Iterable, Iterator, Union

from basyx.aas import model
from basyx.aas.model import provider as sdk_provider

import app.adapter as adapter
from app.model import descriptor

PathOrIO = Union[Path, IO]
Expand Down Expand Up @@ -51,29 +51,35 @@ def __iter__(self) -> Iterator[_DESCRIPTOR_TYPE]:
return iter(self._backend.values())


_DESCRIPTOR_KEY_TO_CLS = (
("assetAdministrationShellDescriptors", descriptor.AssetAdministrationShellDescriptor),
("submodelDescriptors", descriptor.SubmodelDescriptor),
)


def load_directory(directory: Union[Path, str]) -> DictDescriptorStore:
"""
Create a new :class:`~basyx.aas.model.provider.DictIdentifiableStore` and use it to load Asset Administration Shell
and Submodel files in ``AASX``, ``JSON`` and ``XML`` format from a given directory into memory. Additionally, load
all embedded supplementary files into a new :class:`~basyx.aas.adapter.aasx.DictSupplementaryFileContainer`.

:param directory: :class:`~pathlib.Path` or ``str`` pointing to the directory containing all Asset Administration
Shell and Submodel files to load
:return: Tuple consisting of a :class:`~basyx.aas.model.provider.DictIdentifiableStore` and a
:class:`~basyx.aas.adapter.aasx.DictSupplementaryFileContainer` containing all loaded data
"""
Load AAS/Submodel descriptor JSON files from a directory into a :class:`DictDescriptorStore`.

dict_descriptor_store: DictDescriptorStore = DictDescriptorStore()
:param directory: Path to the directory containing JSON descriptor files
:return: Populated :class:`DictDescriptorStore`
"""
from app.adapter import ServerAASFromJsonDecoder

store = DictDescriptorStore()
directory = Path(directory)

for file in directory.iterdir():
if not file.is_file():
if not file.is_file() or file.suffix.lower() != ".json":
continue

suffix = file.suffix.lower()
if suffix == ".json":
with open(file) as f:
adapter.read_server_aas_json_file_into(dict_descriptor_store, f)

return dict_descriptor_store
with open(file) as f:
data = json.load(f, cls=ServerAASFromJsonDecoder)
for key, cls in _DESCRIPTOR_KEY_TO_CLS:
for item in data.get(key, []):
if isinstance(item, cls):
try:
store.add(item)
except KeyError:
pass

return store
27 changes: 19 additions & 8 deletions server/app/model/service_specification.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@
class ServiceSpecificationProfileEnum(str, enum.Enum):
"""
Enumeration of all standardized Service Specification Profiles
from the AAS Part 2 API Specification (IDTA-01002-3-1).
from the AAS Part 2 API Specification (IDTA-01002-3-1-2).
Each profile is uniquely identified by its semantic URI.

Reference: https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.1.2/
http-rest-api/service-specifications-and-profiles.html
"""

# --- Asset Administration Shell (AAS) ---
Expand All @@ -15,8 +18,8 @@ class ServiceSpecificationProfileEnum(str, enum.Enum):

# --- Submodel ---
SUBMODEL_FULL = "https://admin-shell.io/aas/API/3/1/SubmodelServiceSpecification/SSP-001"
SUBMODEL_VALUE = "https://admin-shell.io/aas/API/3/1/SubmodelServiceSpecification/SSP-002"
SUBMODEL_READ = "https://admin-shell.io/aas/API/3/1/SubmodelServiceSpecification/SSP-003"
SUBMODEL_READ = "https://admin-shell.io/aas/API/3/1/SubmodelServiceSpecification/SSP-002"
SUBMODEL_VALUE = "https://admin-shell.io/aas/API/3/1/SubmodelServiceSpecification/SSP-003"

# --- AASX File Server ---
AASX_FILESERVER_FULL = "https://admin-shell.io/aas/API/3/1/AasxFileServerServiceSpecification/SSP-001"
Expand All @@ -28,32 +31,40 @@ class ServiceSpecificationProfileEnum(str, enum.Enum):
"https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRegistryServiceSpecification/SSP-002"
AAS_REGISTRY_BULK = \
"https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRegistryServiceSpecification/SSP-003"
AAS_REGISTRY_QUERY = \
"https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRegistryServiceSpecification/SSP-004"
AAS_REGISTRY_MINIMAL_READ = \
"https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRegistryServiceSpecification/SSP-005"

# --- Submodel Registry ---
SUBMODEL_REGISTRY_FULL = "https://admin-shell.io/aas/API/3/1/SubmodelRegistryServiceSpecification/SSP-001"
SUBMODEL_REGISTRY_READ = "https://admin-shell.io/aas/API/3/1/SubmodelRegistryServiceSpecification/SSP-002"
SUBMODEL_REGISTRY_BULK = "https://admin-shell.io/aas/API/3/1/SubmodelRegistryServiceSpecification/SSP-003"
SUBMODEL_REGISTRY_QUERY = "https://admin-shell.io/aas/API/3/1/SubmodelRegistryServiceSpecification/SSP-004"

# --- AAS Repository ---
AAS_REPOSITORY_FULL = \
"https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRepositoryServiceSpecification/SSP-001"
AAS_REPOSITORY_READ = \
"https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRepositoryServiceSpecification/SSP-002"
AAS_REPOSITORY_BULK = \
AAS_REPOSITORY_QUERY = \
"https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRepositoryServiceSpecification/SSP-003"

# --- Submodel Repository ---
SUBMODEL_REPOSITORY_FULL = "https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-001"
SUBMODEL_REPOSITORY_READ = "https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-002"
SUBMODEL_REPOSITORY_BULK = "https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-003"
SUBMODEL_REPOSITORY_TEMPLATE = \
"https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-003"
SUBMODEL_REPOSITORY_TEMPLATE_READ = \
"https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-004"
SUBMODEL_REPOSITORY_QUERY = \
"https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-005"

# --- Concept Description Repository ---
CONCEPT_DESCRIPTION_REPOSITORY_FULL = \
"https://admin-shell.io/aas/API/3/1/ConceptDescriptionRepositoryServiceSpecification/SSP-001"
CONCEPT_DESCRIPTION_REPOSITORY_READ = \
CONCEPT_DESCRIPTION_REPOSITORY_QUERY = \
"https://admin-shell.io/aas/API/3/1/ConceptDescriptionRepositoryServiceSpecification/SSP-002"
CONCEPT_DESCRIPTION_REPOSITORY_BULK = \
"https://admin-shell.io/aas/API/3/1/ConceptDescriptionRepositoryServiceSpecification/SSP-003"

# --- Discovery ---
DISCOVERY_FULL = "https://admin-shell.io/aas/API/3/1/DiscoveryServiceSpecification/SSP-001"
Expand Down
Loading