diff --git a/ci/docker-compose.yml b/ci/docker-compose.yml index 681c1c0bb..4cc177c8f 100644 --- a/ci/docker-compose.yml +++ b/ci/docker-compose.yml @@ -98,7 +98,7 @@ services: keycloak: build: - context: ./../examples/keycloak + context: ./../examples/BaSyxSecured/keycloak volumes: - ./:/opt/jboss/keycloak/imports ports: diff --git a/examples/BaSyxMinimal/README.md b/examples/BaSyxMinimal/README.md new file mode 100644 index 000000000..fc2e72bbe --- /dev/null +++ b/examples/BaSyxMinimal/README.md @@ -0,0 +1,19 @@ +# BaSyx Infrastructure Setup + +After executing + +```bash +docker-compose up -d +``` + +the following components are started: +* AAS Repository (http://localhost:8081/shells) +* Submodel Repository (http://localhost:8081/submodels) +* ConceptDescription Repository (http://localhost:8081/concept-descriptions) +* AAS Registry (http://localhost:8082/shell-descriptors) +* Submodel Registry (http://localhost:8083/submodel-descriptors) +* AAS Discovery (http://localhost:8084/lookup/shells) +* AAS Web UI (http://localhost:3000) + +By leveraging the registry integration features of AAS Repository and Submodel Repository, the preconfigured AAS Environment serializations are loaded and automatically registered. + diff --git a/examples/RegisterAAS.png b/examples/BaSyxMinimal/RegisterAAS.png similarity index 100% rename from examples/RegisterAAS.png rename to examples/BaSyxMinimal/RegisterAAS.png diff --git a/examples/aas-discovery.properties b/examples/BaSyxMinimal/aas-discovery.properties similarity index 100% rename from examples/aas-discovery.properties rename to examples/BaSyxMinimal/aas-discovery.properties diff --git a/examples/aas-env.properties b/examples/BaSyxMinimal/aas-env.properties similarity index 100% rename from examples/aas-env.properties rename to examples/BaSyxMinimal/aas-env.properties diff --git a/examples/aas-registry.yml b/examples/BaSyxMinimal/aas-registry.yml similarity index 100% rename from examples/aas-registry.yml rename to examples/BaSyxMinimal/aas-registry.yml diff --git a/examples/aas/ExampleV3.aasx b/examples/BaSyxMinimal/aas/ExampleV3.aasx similarity index 100% rename from examples/aas/ExampleV3.aasx rename to examples/BaSyxMinimal/aas/ExampleV3.aasx diff --git a/examples/aas/test_demo_full_example.xml b/examples/BaSyxMinimal/aas/test_demo_full_example.xml similarity index 100% rename from examples/aas/test_demo_full_example.xml rename to examples/BaSyxMinimal/aas/test_demo_full_example.xml diff --git a/examples/cd-repo.properties b/examples/BaSyxMinimal/cd-repo.properties similarity index 100% rename from examples/cd-repo.properties rename to examples/BaSyxMinimal/cd-repo.properties diff --git a/examples/docker-compose-cd-repo.yml b/examples/BaSyxMinimal/docker-compose-cd-repo.yml similarity index 100% rename from examples/docker-compose-cd-repo.yml rename to examples/BaSyxMinimal/docker-compose-cd-repo.yml diff --git a/examples/docker-compose.yml b/examples/BaSyxMinimal/docker-compose.yml similarity index 100% rename from examples/docker-compose.yml rename to examples/BaSyxMinimal/docker-compose.yml diff --git a/examples/mosquitto/mosquitto.conf b/examples/BaSyxMinimal/mosquitto/mosquitto.conf similarity index 100% rename from examples/mosquitto/mosquitto.conf rename to examples/BaSyxMinimal/mosquitto/mosquitto.conf diff --git a/examples/sm-registry.yml b/examples/BaSyxMinimal/sm-registry.yml similarity index 100% rename from examples/sm-registry.yml rename to examples/BaSyxMinimal/sm-registry.yml diff --git a/examples/BaSyxOperationDelegation/AASWebGUI.png b/examples/BaSyxOperationDelegation/AASWebGUI.png new file mode 100644 index 000000000..82002ff82 Binary files /dev/null and b/examples/BaSyxOperationDelegation/AASWebGUI.png differ diff --git a/examples/BaSyxOperationDelegation/README.md b/examples/BaSyxOperationDelegation/README.md new file mode 100644 index 000000000..ef4bd7afb --- /dev/null +++ b/examples/BaSyxOperationDelegation/README.md @@ -0,0 +1,22 @@ +# BaSyx Operation Delegation Example Setup +To run the example containers, you need to have Docker installed on your device. + +## How to start the example containers +1. Open a terminal in this folder +2. Run the following command to start the BaSyx containers: +``` +docker-compose up -d +``` + +## Access the BaSyx containers +- AAS Environment: [http://localhost:8081](http://localhost:8081) +- AAS Registry: [http://localhost:8082](http://localhost:8082) +- Submodel Registry: [http://localhost:8083](http://localhost:8083) +- AAS Web GUI: [http://localhost:3000](http://localhost:3000) +- Delegated Operation Service [http://localhost:8087](http://localhost:8087) + +## How to use +1. Open the AAS Web GUI +![Screenshot of the AAS Web GUI showcasing the Operation](AASWebGUI.png) +2. Open the Operation +3. Enter a value and execute \ No newline at end of file diff --git a/examples/BaSyxOperationDelegation/aas/operationDelegationAAS.json b/examples/BaSyxOperationDelegation/aas/operationDelegationAAS.json new file mode 100644 index 000000000..25a553aad --- /dev/null +++ b/examples/BaSyxOperationDelegation/aas/operationDelegationAAS.json @@ -0,0 +1,83 @@ +{ + "assetAdministrationShells": [ + { + "idShort": "delegationAAS", + "displayName": [ + { + "language": "en", + "text": "Example Operation Delegation AAS" + } + ], + "id": "https://example.com/ids/sm/3232_7030_6042_8042", + "assetInformation": { + "assetKind": "Instance", + "globalAssetId": "https://example.com/ids/asset/4122_7030_6042_5649" + }, + "submodels": [ + { + "type": "ModelReference", + "keys": [ + { + "type": "Submodel", + "value": "https://example.com/ids/sm/3232_7030_6042_2542" + } + ] + } + ], + "modelType": "AssetAdministrationShell" + } + ], + "submodels": [ + { + "idShort": "delegationSubmodel", + "displayName": [ + { + "language": "en", + "text": "Example Operation Delegation Submodel" + } + ], + "id": "https://example.com/ids/sm/3232_7030_6042_2542", + "kind": "Instance", + "submodelElements": [ + { + "idShort": "exampleOperation", + "displayName": [ + { + "language": "en", + "text": "Example Operation" + } + ], + "qualifiers": [ + { + "kind": "ConceptQualifier", + "type": "invocationDelegation", + "valueType": "xs:string", + "value": "http://example-operation-service:8080/operation-invocation" + } + ], + "inputVariables": [ + { + "value": { + "idShort": "input", + "valueType": "xs:int", + "modelType": "Property" + } + } + ], + "outputVariables": [ + { + "value": { + "idShort": "result", + "valueType": "xs:int", + "modelType": "Property" + } + } + ], + "modelType": "Operation" + } + ], + "modelType": "Submodel" + } + ], + "conceptDescriptions": [] +} \ No newline at end of file diff --git a/examples/BaSyxOperationDelegation/basyx/aas-env.properties b/examples/BaSyxOperationDelegation/basyx/aas-env.properties new file mode 100644 index 000000000..3d3d08d9d --- /dev/null +++ b/examples/BaSyxOperationDelegation/basyx/aas-env.properties @@ -0,0 +1,8 @@ +server.port=8081 +basyx.backend=InMemory +basyx.environment=file:aas +basyx.cors.allowed-origins=* +basyx.cors.allowed-methods=GET,POST,PATCH,DELETE,PUT,OPTIONS,HEAD +basyx.aasrepository.feature.registryintegration=http://aas-registry:8080 +basyx.submodelrepository.feature.registryintegration=http://sm-registry:8080 +basyx.externalurl=http://localhost:8081 diff --git a/examples/BaSyxOperationDelegation/basyx/aas-registry.yml b/examples/BaSyxOperationDelegation/basyx/aas-registry.yml new file mode 100644 index 000000000..4fac8db3a --- /dev/null +++ b/examples/BaSyxOperationDelegation/basyx/aas-registry.yml @@ -0,0 +1,4 @@ +basyx: + cors: + allowed-origins: '*' + allowed-methods: GET,POST,PATCH,DELETE,PUT,OPTIONS,HEAD diff --git a/examples/BaSyxOperationDelegation/basyx/sm-registry.yml b/examples/BaSyxOperationDelegation/basyx/sm-registry.yml new file mode 100644 index 000000000..4fac8db3a --- /dev/null +++ b/examples/BaSyxOperationDelegation/basyx/sm-registry.yml @@ -0,0 +1,4 @@ +basyx: + cors: + allowed-origins: '*' + allowed-methods: GET,POST,PATCH,DELETE,PUT,OPTIONS,HEAD diff --git a/examples/BaSyxOperationDelegation/docker-compose.yml b/examples/BaSyxOperationDelegation/docker-compose.yml new file mode 100644 index 000000000..61212e17d --- /dev/null +++ b/examples/BaSyxOperationDelegation/docker-compose.yml @@ -0,0 +1,55 @@ +version: '3' +services: + aas-env: + image: eclipsebasyx/aas-environment:2.0.0-milestone-02 + container_name: aas-env + volumes: + - ./aas:/application/aas + - ./basyx/aas-env.properties:/application/application.properties + ports: + - '8081:8081' + restart: always + depends_on: + aas-registry: + condition: service_healthy + sm-registry: + condition: service_healthy + aas-registry: + image: eclipsebasyx/aas-registry-log-mem:2.0.0-milestone-02 + container_name: aas-registry + ports: + - '8082:8080' + volumes: + - ./basyx/aas-registry.yml:/workspace/config/application.yml + restart: always + sm-registry: + image: eclipsebasyx/submodel-registry-log-mem:2.0.0-milestone-02 + container_name: sm-registry + ports: + - '8083:8080' + volumes: + - ./basyx/sm-registry.yml:/workspace/config/application.yml + restart: always + aas-web-ui: + image: eclipsebasyx/aas-gui:v2-240515 + container_name: aas-ui + ports: + - '3000:3000' + environment: + AAS_REGISTRY_PATH: http://localhost:8082/shell-descriptors + SUBMODEL_REGISTRY_PATH: http://localhost:8083/submodel-descriptors + AAS_REPO_PATH: http://localhost:8081/shells + SUBMODEL_REPO_PATH: http://localhost:8081/submodels + CD_REPO_PATH: http://localhost:8081/concept-descriptions + restart: always + depends_on: + aas-env: + condition: service_healthy + example-operation-service: + build: + context: ./exampleOperationService + dockerfile: Dockerfile + container_name: example-operation + ports: + - '8087:8080' + restart: always diff --git a/examples/BaSyxOperationDelegation/exampleOperationService/Dockerfile b/examples/BaSyxOperationDelegation/exampleOperationService/Dockerfile new file mode 100644 index 000000000..0fdf815fa --- /dev/null +++ b/examples/BaSyxOperationDelegation/exampleOperationService/Dockerfile @@ -0,0 +1,18 @@ +# Stage 1: Build Stage +FROM maven:3.8.1-openjdk-17 AS build +WORKDIR /app +# Kopiere die pom.xml und lade die Abhängigkeiten herunter +COPY pom.xml . +RUN mvn dependency:go-offline +# Kopiere den restlichen Quellcode +COPY src src +# Baue das Projekt +RUN mvn clean package -DskipTests + +# Stage 2: Runtime Stage +FROM openjdk:17 +WORKDIR /app +COPY --from=build /app/target/*.jar app.jar +EXPOSE 8080 +# Starte die Anwendung +ENTRYPOINT ["java", "-jar", "app.jar"] diff --git a/examples/BaSyxOperationDelegation/exampleOperationService/HELP.md b/examples/BaSyxOperationDelegation/exampleOperationService/HELP.md new file mode 100644 index 000000000..6ed8cfcd8 --- /dev/null +++ b/examples/BaSyxOperationDelegation/exampleOperationService/HELP.md @@ -0,0 +1,19 @@ +# Getting Started + +### Reference Documentation +For further reference, please consider the following sections: + +* [Official Apache Maven documentation](https://maven.apache.org/guides/index.html) +* [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/3.2.4/maven-plugin/reference/html/) +* [Create an OCI image](https://docs.spring.io/spring-boot/docs/3.2.4/maven-plugin/reference/html/#build-image) +* [Spring Web](https://docs.spring.io/spring-boot/docs/3.2.4/reference/htmlsingle/index.html#web) +* [Spring Boot Actuator](https://docs.spring.io/spring-boot/docs/3.2.4/reference/htmlsingle/index.html#actuator) + +### Guides +The following guides illustrate how to use some features concretely: + +* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/) +* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/) +* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/) +* [Building a RESTful Web Service with Spring Boot Actuator](https://spring.io/guides/gs/actuator-service/) + diff --git a/examples/BaSyxOperationDelegation/exampleOperationService/mvnw b/examples/BaSyxOperationDelegation/exampleOperationService/mvnw new file mode 100644 index 000000000..66df28542 --- /dev/null +++ b/examples/BaSyxOperationDelegation/exampleOperationService/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/examples/BaSyxOperationDelegation/exampleOperationService/mvnw.cmd b/examples/BaSyxOperationDelegation/exampleOperationService/mvnw.cmd new file mode 100644 index 000000000..95ba6f54a --- /dev/null +++ b/examples/BaSyxOperationDelegation/exampleOperationService/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM https://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/examples/BaSyxOperationDelegation/exampleOperationService/pom.xml b/examples/BaSyxOperationDelegation/exampleOperationService/pom.xml new file mode 100644 index 000000000..7477f53a2 --- /dev/null +++ b/examples/BaSyxOperationDelegation/exampleOperationService/pom.xml @@ -0,0 +1,66 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.2.4 + + + org.eclipse.digitaltwin.basyx + exampleOperationService + 0.0.1-SNAPSHOT + examples.operationdelegation + BaSyx Operation Delegation Example + + 17 + 1.0.1 + + + + org.springframework.boot + spring-boot-starter-actuator + + + org.springframework.boot + spring-boot-starter-web + + + + org.springframework.boot + spring-boot-starter-test + test + + + + org.eclipse.digitaltwin.aas4j + aas4j-model + ${aas4j-version} + + + org.slf4j + slf4j-simple + + + + + + org.eclipse.digitaltwin.basyx + basyx.submodelrepository-client + 2.0.0-milestone-02 + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + diff --git a/examples/BaSyxOperationDelegation/exampleOperationService/src/main/java/org/eclipse/digitaltwin/basyx/examples/operationdelegation/Application.java b/examples/BaSyxOperationDelegation/exampleOperationService/src/main/java/org/eclipse/digitaltwin/basyx/examples/operationdelegation/Application.java new file mode 100644 index 000000000..66bb80757 --- /dev/null +++ b/examples/BaSyxOperationDelegation/exampleOperationService/src/main/java/org/eclipse/digitaltwin/basyx/examples/operationdelegation/Application.java @@ -0,0 +1,38 @@ +/******************************************************************************* + * Copyright (C) 2024 the Eclipse BaSyx Authors + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + * SPDX-License-Identifier: MIT + ******************************************************************************/ + +package org.eclipse.digitaltwin.basyx.examples.operationdelegation; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application{ + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } + +} diff --git a/examples/BaSyxOperationDelegation/exampleOperationService/src/main/java/org/eclipse/digitaltwin/basyx/examples/operationdelegation/configuration/OperationConfiguration.java b/examples/BaSyxOperationDelegation/exampleOperationService/src/main/java/org/eclipse/digitaltwin/basyx/examples/operationdelegation/configuration/OperationConfiguration.java new file mode 100644 index 000000000..f7eca70e7 --- /dev/null +++ b/examples/BaSyxOperationDelegation/exampleOperationService/src/main/java/org/eclipse/digitaltwin/basyx/examples/operationdelegation/configuration/OperationConfiguration.java @@ -0,0 +1,45 @@ +/******************************************************************************* + * Copyright (C) 2024 the Eclipse BaSyx Authors + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + * SPDX-License-Identifier: MIT + ******************************************************************************/ + +package org.eclipse.digitaltwin.basyx.examples.operationdelegation.configuration; + +import java.util.Arrays; + +import org.eclipse.digitaltwin.basyx.http.Aas4JHTTPSerializationExtension; +import org.eclipse.digitaltwin.basyx.http.BaSyxHTTPConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import com.fasterxml.jackson.databind.ObjectMapper; + +@Configuration +public class OperationConfiguration { + + @Bean + public ObjectMapper getMapper() { + return new BaSyxHTTPConfiguration().jackson2ObjectMapperBuilder(Arrays.asList(new Aas4JHTTPSerializationExtension())).build(); + } + +} diff --git a/examples/BaSyxOperationDelegation/exampleOperationService/src/main/java/org/eclipse/digitaltwin/basyx/examples/operationdelegation/controller/OperationController.java b/examples/BaSyxOperationDelegation/exampleOperationService/src/main/java/org/eclipse/digitaltwin/basyx/examples/operationdelegation/controller/OperationController.java new file mode 100644 index 000000000..d6b0e2256 --- /dev/null +++ b/examples/BaSyxOperationDelegation/exampleOperationService/src/main/java/org/eclipse/digitaltwin/basyx/examples/operationdelegation/controller/OperationController.java @@ -0,0 +1,57 @@ +/******************************************************************************* + * Copyright (C) 2024 the Eclipse BaSyx Authors + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + * SPDX-License-Identifier: MIT + ******************************************************************************/ + +package org.eclipse.digitaltwin.basyx.examples.operationdelegation.controller; + +import org.eclipse.digitaltwin.aas4j.v3.model.OperationVariable; +import org.eclipse.digitaltwin.aas4j.v3.model.Property; +import org.eclipse.digitaltwin.aas4j.v3.model.impl.DefaultOperationVariable; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RestController; + +@RestController +public class OperationController { + + @PostMapping("/operation-invocation") + public ResponseEntity invokeOperation(@RequestBody OperationVariable[] requestData) { + + return new ResponseEntity(square(requestData), HttpStatus.OK); + } + + private OperationVariable[] square(OperationVariable[] input){ + OperationVariable[] output = new OperationVariable[input.length]; + Property property = (Property) input[0].getValue(); + Integer val = Integer.valueOf(property.getValue()); + int squared = val * val; + property.setValue(Integer.toString(squared)); + property.setIdShort("result"); + output[0] = new DefaultOperationVariable.Builder().value(property).build(); + return output; + } + +} \ No newline at end of file diff --git a/examples/BaSyxOperationDelegation/exampleOperationService/src/main/resources/application.properties b/examples/BaSyxOperationDelegation/exampleOperationService/src/main/resources/application.properties new file mode 100644 index 000000000..4bafbda2e --- /dev/null +++ b/examples/BaSyxOperationDelegation/exampleOperationService/src/main/resources/application.properties @@ -0,0 +1,2 @@ +server.port=8080 +spring.application.name=examples.operationdelegation diff --git a/examples/keycloak/BaSyx-realm.json b/examples/BaSyxSecured/keycloak/BaSyx-realm.json similarity index 100% rename from examples/keycloak/BaSyx-realm.json rename to examples/BaSyxSecured/keycloak/BaSyx-realm.json diff --git a/examples/keycloak/Dockerfile b/examples/BaSyxSecured/keycloak/Dockerfile similarity index 100% rename from examples/keycloak/Dockerfile rename to examples/BaSyxSecured/keycloak/Dockerfile diff --git a/examples/README.md b/examples/README.md index 24178e9b4..a143b5c04 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,31 +1,14 @@ -# BaSyx V2 Examples -This folder contains example configurations and docker compose files for setting up the BaSyx V2 infrastructure. - - -## Standalone Submodel -For definining standalone submodels, see [Submodel Service](../basyx.submodelservice) - -## Infrastructure Example - -After executing - -```bash -docker-compose up -d -``` - -the following components are started: -* AAS Repository (http://localhost:8081/shells) -* Submodel Repository (http://localhost:8081/submodels) -* ConceptDescription Repository (http://localhost:8081/concept-descriptions) -* AAS Registry (http://localhost:8082/shell-descriptors) -* Submodel Registry (http://localhost:8083/submodel-descriptors) -* AAS Discovery (http://localhost:8084/lookup/shells) -* AAS Web UI (http://localhost:3000) - -By leveraging the registry integration features of AAS Repository and Submodel Repository, the preconfigured AAS Environment serializations are loaded and automatically registered. - -## BaSyx with NGINX -See the separate [NGINX example](BaSyxNGINX) for a comprehensive setup leveraging NGINX. - -## BaSyx Time Series Data Example -See the separate [Time Series example](https://github.com/eclipse-basyx/basyx-applications/tree/main/aas-gui/examples/TimeSeriesData) for a comprehensive setup leveraging InfluxDB. +# BaSyx V2 Examples +This folder contains example configurations and docker compose files for setting up the BaSyx V2 infrastructure. + +## Standalone Submodel +For definining standalone submodels, see [Submodel Service](../basyx.submodelservice) + +## BaSyx with NGINX +See the separate [NGINX example](BaSyxNGINX) for a comprehensive setup leveraging NGINX. + +## BaSyx Time Series Data Example +See the separate [Time Series example](https://github.com/eclipse-basyx/basyx-applications/tree/main/aas-gui/examples/TimeSeriesData) for a comprehensive setup leveraging InfluxDB. + +## BaSyx Operation Delegation Example +See the separate [Operation Delegation Example](BaSyxOperationDelegation) for a comprehensive setup leveraging Operation Delegation. \ No newline at end of file