Adds documentation to *.property files
Change-Id: I456698102f0e3f59db84190bbd1cc6377bf70e2d
Signed-off-by: Daniel Espen <Daniel.Espen@iese.fraunhofer.de>
diff --git a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/aas.properties b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/aas.properties
index 82a0083..491bb34 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/aas.properties
+++ b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/aas.properties
@@ -1,5 +1,35 @@
+# #############################
+# AAS Server configuration file
+# #############################
+
+# #############################
+# Backend
+# #############################
+# Specifies the backend that loads the AAS and Submodels
+
+# InMemory - does not persist AAS or submodels
aas.backend=InMemory
+
+# MongoDB - persists data within a MongoDB
+# See connection configuration in mongodb.properties
+# aas.backend=MongoDB
+
+# #############################
+# Source
+# #############################
+# Possible to load an AAS Environment from a file
+
aas.source=
-# Example for loading an .aasx file and registering the AAS:
-#registry.path=http://localhost:4000/registry/
-#aas.source=aasx/01_Festo.aasx
\ No newline at end of file
+
+# Other examples (Currently supported: *.xml & *.aasx):
+# aas.source=aasx/myAAS.aasx
+# aas.source=aasx/myAAS.xml
+# Or when encapsulated in the docker volume for this container:
+# aas.source=/usr/share/config/myAAS.aasx
+
+# #############################
+# Registry
+# #############################
+# If specified, can directly registers the AAS that has been loaded from the source file
+
+# registry.path=http://localhost:4000/registry/
\ No newline at end of file
diff --git a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/context.properties b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/context.properties
index bd80d1d..65f2a94 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/context.properties
+++ b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/context.properties
@@ -1,3 +1,24 @@
+# ###############################
+# HTTP Context configuration file
+# ###############################
+
+# ###############################
+# Context Path
+# ###############################
+# Specifies the subpath in the url for this server context
+
contextPath=/aasServer
+
+# ###############################
+# Hostname
+# ###############################
+# Specifies the hostname for this server context
+
contextHostname=localhost
+
+# ###############################
+# Port
+# ###############################
+# Specifies the port for this server context
+
contextPort=4001
\ No newline at end of file
diff --git a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/mongodb.properties b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/mongodb.properties
index 30acebe..db799fa 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/mongodb.properties
+++ b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/mongodb.properties
@@ -1,14 +1,39 @@
-# ##############################################################
-# Directory configuration file
-# ##############################################################
+# #############################
+# MongoDB Backend configuration
+# #############################
+# #############################
+# Username
+# #############################
+# The username for connecting to the MongoDB
-# ##############################################################
-# MongoDB database configuration
+dbuser=admin
-dbuser = admin
-dbname = admin
-dbconnectionstring = mongodb://localhost:27017/
-dbcollectionRegistry = registry
-dbcollectionAAS = assetadministrationshells
-dbcollectionSubmodels = submodels
\ No newline at end of file
+# #############################
+# Database Name
+# #############################
+# The database in the MongoDB that hold the data
+
+dbname=admin
+
+# #############################
+# Connection String
+# #############################
+# MongoDB connection string for connecting to the MongoDB endpoint
+
+dbconnectionstring=mongodb://localhost:27017/
+
+# #############################
+# AAS collections
+# #############################
+# Collection names that are used for storing the AAS and Submodels
+
+dbcollectionAAS=assetadministrationshells
+dbcollectionSubmodels=submodels
+
+# #############################
+# Registry Collections
+# #############################
+# Collection name that is used for storing registry data
+
+dbcollectionRegistry=registry
diff --git a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/test/resources/.env b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/test/resources/.env
index 077762c..5eab39f 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/test/resources/.env
+++ b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/test/resources/.env
@@ -1,5 +1,38 @@
+# ##################
+# Docker Environment
+# ##################
+
+# ##################
+# Host Port
+# ##################
+# Specifies the port for the Docker HOST the container port is mapped to
+
BASYX_HOST_PORT=8082
+
+# ##################
+# Container Port
+# ##################
+# Specifies the port for the Docker CONTAINER that is be mapped for the host
+
BASYX_CONTAINER_PORT=4001
+
+# ##################
+# Image Name
+# ##################
+# The image of the image that is build for this component
+
BASYX_IMAGE_NAME=basys/aas-server
-BASYX_CONTAINER_NAME=aas
-BASYX_IMAGE_TAG=0.1.0-SNAPSHOT
\ No newline at end of file
+
+# ##################
+# Image Tag
+# ##################
+# The image tag of the image that is build for this component
+
+BASYX_IMAGE_TAG=0.1.0-SNAPSHOT
+
+# ##################
+# Container Name
+# ##################
+# The name of the container used for the default environment
+
+BASYX_CONTAINER_NAME=aas
\ No newline at end of file
diff --git a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/test/resources/dockerMongodb.properties b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/test/resources/dockerMongodb.properties
index f91b7d4..46099a0 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/test/resources/dockerMongodb.properties
+++ b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/test/resources/dockerMongodb.properties
@@ -1,14 +1,41 @@
-# ##############################################################
-# Directory configuration file
-# ##############################################################
+# #############################
+# MongoDB Backend configuration
+# #############################
+# #############################
+# Username
+# #############################
+# The username for connecting to the MongoDB
-# ##############################################################
-# MongoDB database configuration
+dbuser=admin
-dbuser = admin
-dbname = admin
-dbconnectionstring = mongodb://mongodb:27017/
-dbcollectionRegistry = registry
-dbcollectionAAS = assetadministrationshells
-dbcollectionSubmodels = submodels
\ No newline at end of file
+# #############################
+# Database Name
+# #############################
+# The database in the MongoDB that hold the data
+
+dbname=admin
+
+# #############################
+# Connection String
+# #############################
+# MongoDB connection string for connecting to the MongoDB endpoint
+# Here it is not localhost, because the container has to address the mongodb
+# container in the default docker environment used in this component
+
+dbconnectionstring=mongodb://mongodb:27017/
+
+# #############################
+# AAS collections
+# #############################
+# Collection names that are used for storing the AAS and Submodels
+
+dbcollectionAAS=assetadministrationshells
+dbcollectionSubmodels=submodels
+
+# #############################
+# Registry Collections
+# #############################
+# Collection name that is used for storing registry data
+
+dbcollectionRegistry=registry
diff --git a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/context.properties b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/context.properties
index 7e933a3..9ff1ad2 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/context.properties
+++ b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/context.properties
@@ -1,3 +1,24 @@
+# ###############################
+# HTTP Context configuration file
+# ###############################
+
+# ###############################
+# Context Path
+# ###############################
+# Specifies the subpath in the url for this server context
+
contextPath=/registry
+
+# ###############################
+# Hostname
+# ###############################
+# Specifies the hostname for this server context
+
contextHostname=localhost
+
+# ###############################
+# Port
+# ###############################
+# Specifies the port for this server context
+
contextPort=4000
\ No newline at end of file
diff --git a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/mongodb.properties b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/mongodb.properties
index 279374c..4977754 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/mongodb.properties
+++ b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/mongodb.properties
@@ -1,12 +1,39 @@
-# ##############################################################
-# Directory configuration file
-# ##############################################################
+# #############################
+# MongoDB Backend configuration
+# #############################
+# #############################
+# Username
+# #############################
+# The username for connecting to the MongoDB
-# ##############################################################
-# MongoDB database configuration
+dbuser=admin
-dbuser = admin
-dbname = admin
-dbconnectionstring = mongodb://localhost:27017/
-dbcollectionRegistry = registry
\ No newline at end of file
+# #############################
+# Database Name
+# #############################
+# The database in the MongoDB that hold the data
+
+dbname=admin
+
+# #############################
+# Connection String
+# #############################
+# MongoDB connection string for connecting to the MongoDB endpoint
+
+dbconnectionstring=mongodb://localhost:27017/
+
+# #############################
+# Registry Collections
+# #############################
+# Collection name that is used for storing registry data
+
+dbcollectionRegistry=registry
+
+# #############################
+# AAS collections
+# #############################
+# Collection names that are used for storing the AAS and Submodels
+
+# dbcollectionAAS=assetadministrationshells
+# dbcollectionSubmodels=submodels
\ No newline at end of file
diff --git a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/registry.properties b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/registry.properties
index f50cc25..f0657a6 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/registry.properties
+++ b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/registry.properties
@@ -1 +1,19 @@
-registry.backend=InMemory
\ No newline at end of file
+# ###########################
+# Registry configuration file
+# ###########################
+
+# ###########################
+# Backend
+# ###########################
+# Specifies the backend that loads the AAS and Submodels
+
+# InMemory - does not persist AAS or submodels
+registry.backend=InMemory
+
+# MongoDB - persists data within a MongoDB
+# See connection configuration in mongodb.properties
+# registry.backend=MongoDB
+
+# SQL - persists data within an SQL database
+# See connection configuration in sql.properties
+# registry.backend=SQL
diff --git a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/sql.properties b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/sql.properties
index 638f973..5199325 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/sql.properties
+++ b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/resources/sql.properties
@@ -1,9 +1,36 @@
-# ##############################################################
-# SQL database configuration
+# ###############################
+# SQL database configuration file
+# ###############################
-dbuser = postgres
-dbpass = admin
-dburl = //localhost:5432/basyx-directory?
+# ###############################
+# Credentials
+# ###############################
+# Specifies the credentials for connecting to the SQL database
-sqlDriver = org.postgresql.Driver
-sqlPrefix = jdbc:postgresql:
+dbuser=postgres
+dbpass=admin
+
+# ###############################
+# Database URL
+# ###############################
+# The direct SQL database url for connection
+
+dburl=//localhost:5432/basyx-directory?
+
+# ###############################
+# SQL driver information
+# ###############################
+# Java Driver and connection prefix for using the driver
+
+sqlDriver=org.postgresql.Driver
+sqlPrefix=jdbc:postgresql:
+
+
+# ###############################
+# Microsoft SQL Server Example
+# ###############################
+# dburl=//localhost:1234;databaseName=mydb
+# sqlDriver=com.microsoft.sqlserver.jdbc.SQLServerDriver
+# sqlPrefix=jdbc:sqlserver:
+
+
diff --git a/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/.env b/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/.env
index 11c83fa..8cf4e4d 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/.env
+++ b/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/.env
@@ -1,5 +1,39 @@
+# ##################
+# Docker Environment
+# ##################
+
+# ##################
+# Host Port
+# ##################
+# Specifies the port for the Docker HOST the container port is mapped to
+
BASYX_HOST_PORT=8082
+
+# ##################
+# Container Port
+# ##################
+# Specifies the port for the Docker CONTAINER that is be mapped for the host
+
BASYX_CONTAINER_PORT=4000
+
+# ##################
+# Image Name
+# ##################
+# The image of the image that is build for this component
+
BASYX_IMAGE_NAME=basyx/registry
+
+# ##################
+# Image Tag
+# ##################
+# The image tag of the image that is build for this component
+
+BASYX_IMAGE_TAG=0.1.0-SNAPSHOT
+
+# ##################
+# Container Name
+# ##################
+# The name of the container used for the default environment
+
BASYX_CONTAINER_NAME=registry
-BASYX_IMAGE_TAG=0.1.0-SNAPSHOT
\ No newline at end of file
+
diff --git a/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/dockerMongodb.properties b/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/dockerMongodb.properties
index 3a0b8fe..1388718 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/dockerMongodb.properties
+++ b/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/dockerMongodb.properties
@@ -1,12 +1,41 @@
-# ##############################################################
-# Directory configuration file
-# ##############################################################
+# #############################
+# MongoDB Backend configuration
+# #############################
+# #############################
+# Username
+# #############################
+# The username for connecting to the MongoDB
-# ##############################################################
-# MongoDB database configuration
+dbuser=admin
-dbuser = admin
-dbname = admin
-dbconnectionstring = mongodb://mongodb:27017/
-dbcollectionRegistry = registry
\ No newline at end of file
+# #############################
+# Database Name
+# #############################
+# The database in the MongoDB that hold the data
+
+dbname=admin
+
+# #############################
+# Connection String
+# #############################
+# MongoDB connection string for connecting to the MongoDB endpoint
+# Here it is not localhost, because the container has to address the mongodb
+# container in the default docker environment used in this component
+
+dbconnectionstring=mongodb://mongodb:27017/
+
+# #############################
+# Registry Collections
+# #############################
+# Collection name that is used for storing registry data
+
+dbcollectionRegistry=registry
+
+# #############################
+# AAS collections
+# #############################
+# Collection names that are used for storing the AAS and Submodels
+
+# dbcollectionAAS=assetadministrationshells
+# dbcollectionSubmodels=submodels
\ No newline at end of file
diff --git a/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/dockerSQL.properties b/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/dockerSQL.properties
index f96fb32..3871d94 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/dockerSQL.properties
+++ b/components/basys.components/basyx.components.docker/basyx.components.registry/src/test/resources/dockerSQL.properties
@@ -1,9 +1,37 @@
-# ##############################################################
-# SQL database configuration
+# ###############################
+# SQL database configuration file
+# ###############################
-dbuser = postgres
-dbpass = admin
-dburl = //postgres:5432/basyx-directory?
+# ###############################
+# Credentials
+# ###############################
+# Specifies the credentials for connecting to the SQL database
-sqlDriver = org.postgresql.Driver
-sqlPrefix = jdbc:postgresql:
+dbuser=postgres
+dbpass=admin
+
+# ###############################
+# Database URL
+# ###############################
+# The direct SQL database url for connection
+# Here it is not localhost, because the container has to address the postgreSQL
+# container in the default docker environment used in this component
+
+dburl=//postgres:5432/basyx-directory?
+
+# ###############################
+# SQL driver information
+# ###############################
+# Java Driver and connection prefix for using the driver
+
+sqlDriver=org.postgresql.Driver
+sqlPrefix=jdbc:postgresql:
+
+
+# ###############################
+# Microsoft SQL Server Example
+# ###############################
+# dburl=//localhost:1234;databaseName=mydb
+# sqlDriver=com.microsoft.sqlserver.jdbc.SQLServerDriver
+# sqlPrefix=jdbc:sqlserver:
+
diff --git a/examples/basys.examples/src/main/resources/CloudEdgeDeploymentScenarioAASContext.properties b/examples/basys.examples/src/main/resources/CloudEdgeDeploymentScenarioAASContext.properties
index 1201930..7151423 100644
--- a/examples/basys.examples/src/main/resources/CloudEdgeDeploymentScenarioAASContext.properties
+++ b/examples/basys.examples/src/main/resources/CloudEdgeDeploymentScenarioAASContext.properties
@@ -1,3 +1,24 @@
+# ###############################
+# HTTP Context configuration file
+# ###############################
+
+# ###############################
+# Context Path
+# ###############################
+# Specifies the subpath in the url for this server context
+
contextPath=/cloud
+
+# ###############################
+# Hostname
+# ###############################
+# Specifies the hostname for this server context
+
contextHostname=localhost
-contextPort=8081
\ No newline at end of file
+
+# ###############################
+# Port
+# ###############################
+# Specifies the port for this server context
+
+contextPort=8081
diff --git a/examples/basys.examples/src/main/resources/RegistryContext.properties b/examples/basys.examples/src/main/resources/RegistryContext.properties
index 7e933a3..c0c55e1 100644
--- a/examples/basys.examples/src/main/resources/RegistryContext.properties
+++ b/examples/basys.examples/src/main/resources/RegistryContext.properties
@@ -1,3 +1,24 @@
+# ###############################
+# HTTP Context configuration file
+# ###############################
+
+# ###############################
+# Context Path
+# ###############################
+# Specifies the subpath in the url for this server context
+
contextPath=/registry
+
+# ###############################
+# Hostname
+# ###############################
+# Specifies the hostname for this server context
+
contextHostname=localhost
-contextPort=4000
\ No newline at end of file
+
+# ###############################
+# Port
+# ###############################
+# Specifies the port for this server context
+
+contextPort=4000
diff --git a/examples/basys.examples/src/test/resources/registry.properties b/examples/basys.examples/src/test/resources/registry.properties
index 60e38d9..1cdb398 100644
--- a/examples/basys.examples/src/test/resources/registry.properties
+++ b/examples/basys.examples/src/test/resources/registry.properties
@@ -1,43 +1,35 @@
-# ##############################################################
-# Directory configuration file
-# ##############################################################
+# ###############################
+# SQL database configuration file
+# ###############################
+
+# ###############################
+# Credentials
+# ###############################
+# Specifies the credentials for connecting to the SQL database
+
+dbuser=postgres
+dbpass=admin
+
+# ###############################
+# Database URL
+# ###############################
+# The direct SQL database url for connection
+
+dburl=//localhost:5432/basyx-directory?
+
+# ###############################
+# SQL driver information
+# ###############################
+# Java Driver and connection prefix for using the driver
+
+sqlDriver=org.postgresql.Driver
+sqlPrefix=jdbc:postgresql:
+# ###############################
+# Microsoft SQL Server Example
+# ###############################
+# dburl=//localhost:1234;databaseName=mydb
+# sqlDriver=com.microsoft.sqlserver.jdbc.SQLServerDriver
+# sqlPrefix=jdbc:sqlserver:
-
-# ##############################################################
-# Directory server configuration
-
-
-# URL and type of uplink server. Forward all requests that we cannot satisfy here to uplink
-# - URL of uplink directory server
-# - Type of uplink server. Currently supported is BASYS (BaSys registry API) or DNS (DNS server processing legalBody tag)
-cfg.uplink =
-cfg.uplink.type = DNS
-
-
-# Downlink servers, forward matching URI patterns to downlink servers
-# - Match all subunits that end with "is.iese", including "is.iese"
-cfg.downlink.is.pattern = is.iese
-cfg.downlink.is.directory = http://wherever1
-
-# - Match all subunits that end with "pm.iese", including "pm.iese"
-cfg.downlink.pm.pattern = pm.iese
-cfg.downlink.pm.directory = http://wherever2
-
-# - Match all subunits that end with ".es.iese", but not "es.iese"
-cfg.downlink.es.pattern = .es.iese
-cfg.downlink.es.directory = http://wherever3
-
-
-
-
-# ##############################################################
-# SQL database configuration
-
-dbuser = postgres
-dbpass = admin
-dburl = //localhost/basyx-directory?
-
-sqlDriver = org.postgresql.Driver
-sqlPrefix = jdbc:postgresql:
