Added LMOS Protocol and moved messages

Author: Robert Winkler

kotlin-wot-binding-http/build.gradle.kts

@@ -15,6 +15,7 @@ dependencies {
     implementation("io.ktor:ktor-server-content-negotiation")
     implementation("io.ktor:ktor-client-content-negotiation")
     implementation("io.ktor:ktor-serialization-jackson")
+    implementation("io.ktor:ktor-server-metrics-micrometer")
     implementation("io.ktor:ktor-server-auto-head-response")
     testImplementation("io.ktor:ktor-server-test-host")
     testImplementation("ch.qos.logback:logback-classic:1.5.12")

kotlin-wot-binding-http/src/main/kotlin/http/HttpProtocolClient.kt

@@ -100,10 +100,13 @@ class HttpProtocolClient(
     private suspend fun resolveRequestToContent(form: Form, method: HttpMethod, content: Content? = null): Content {
         return try {
             val response: HttpResponse = client.request(form.href) {
+                headers {
+                    append(HttpHeaders.Accept, form.contentType)
+                }
                 this.method = method
                 content?.let {
                     headers {
-                        append(HttpHeaders.ContentType, it.type ?: ContentType.Application.Json.toString())
+                        append(HttpHeaders.ContentType, it.type )
                     }
                     setBody(it.body)
                 }

kotlin-wot-binding-http/src/main/kotlin/http/HttpProtocolServer.kt

@@ -22,6 +22,7 @@ import io.ktor.http.*
 import io.ktor.serialization.jackson.*
 import io.ktor.server.application.*
 import io.ktor.server.engine.*
+import io.ktor.server.metrics.micrometer.*
 import io.ktor.server.netty.*
 import io.ktor.server.plugins.contentnegotiation.*
 import io.ktor.server.plugins.statuspages.*
@@ -30,6 +31,9 @@ import io.ktor.server.response.*
 import io.ktor.server.routing.*
 import io.ktor.util.reflect.*
 import io.ktor.utils.io.*
+import io.micrometer.core.instrument.binder.jvm.JvmGcMetrics
+import io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics
+import io.micrometer.core.instrument.binder.system.ProcessorMetrics
 import org.slf4j.LoggerFactory
 import kotlin.collections.set
 
@@ -204,6 +208,13 @@ fun Application.setupRouting(servient: Servient) {
             throw cause // re-throw if you want it to be logged
         }
     }
+    install(MicrometerMetrics) {
+        meterBinders = listOf(
+            JvmMemoryMetrics(),
+            JvmGcMetrics(),
+            ProcessorMetrics()
+        )
+    }
     setupJackson()
     routing {
         route("/") {

kotlin-wot-binding-websocket/build.gradle.kts

@@ -4,6 +4,7 @@ plugins {
 
 dependencies {
     api(project(":kotlin-wot"))
+    api(project(":kotlin-wot-lmos-protocol"))
     implementation("org.slf4j:slf4j-api")
     implementation("io.ktor:ktor-server-netty")
     implementation("io.ktor:ktor-server-websockets")
@@ -14,6 +15,7 @@ dependencies {
     implementation("io.ktor:ktor-client-logging")
     implementation("io.ktor:ktor-server-call-logging")
     implementation("io.ktor:ktor-serialization-jackson")
+    implementation("io.ktor:ktor-server-metrics-micrometer")
     testImplementation("io.ktor:ktor-server-test-host")
     testImplementation(project(":kotlin-wot-binding-http"))
     testImplementation("ch.qos.logback:logback-classic:1.5.12")

kotlin-wot-binding-websocket/src/main/kotlin/websocket/WebSocketProtocolServer.kt

@@ -3,6 +3,8 @@ package ai.ancf.lmos.wot.binding.websocket
 import ai.ancf.lmos.wot.JsonMapper
 import ai.ancf.lmos.wot.Servient
 import ai.ancf.lmos.wot.content.ContentManager
+import ai.ancf.lmos.wot.protocol.LMOSContext
+import ai.ancf.lmos.wot.protocol.LMOS_PROTOCOL_NAME
 import ai.ancf.lmos.wot.thing.ExposedThing
 import ai.ancf.lmos.wot.thing.ThingDescription
 import ai.ancf.lmos.wot.thing.form.Form
@@ -18,16 +20,22 @@ import io.ktor.http.*
 import io.ktor.serialization.jackson.*
 import io.ktor.server.application.*
 import io.ktor.server.engine.*
+import io.ktor.server.metrics.micrometer.*
 import io.ktor.server.netty.*
 import io.ktor.server.plugins.calllogging.*
 import io.ktor.server.plugins.contentnegotiation.*
 import io.ktor.server.routing.*
 import io.ktor.server.websocket.*
 import io.ktor.util.reflect.*
 import io.ktor.websocket.*
+import io.micrometer.core.instrument.binder.jvm.JvmGcMetrics
+import io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics
+import io.micrometer.core.instrument.binder.system.ProcessorMetrics
 import org.slf4j.LoggerFactory
 import java.util.*
 
+private const val SUB_PROTOCOL_MEDIA_TYPE = "application/json"
+
 class WebSocketProtocolServer(
     private val wait: Boolean = false,
     private val bindHost: String = "0.0.0.0",
@@ -95,9 +103,9 @@ class WebSocketProtocolServer(
             // Create a single form that includes all operations and the subprotocol
             val form = Form(
                 href = href,
-                contentType = "application/json",
+                contentType = SUB_PROTOCOL_MEDIA_TYPE,
                 op = operations,
-                subprotocol = "webthingprotocol"
+                subprotocol = LMOS_PROTOCOL_NAME
             )
 
             property.forms += form
@@ -113,14 +121,14 @@ class WebSocketProtocolServer(
             // Create a form for invoking the action
             val form = Form(
                 href = href,
-                contentType = "application/json",
+                contentType = SUB_PROTOCOL_MEDIA_TYPE,
                 op = listOf(Operation.INVOKE_ACTION), // Operation type specific to actions
-                subprotocol = "webthingprotocol" // Specific subprotocol for actions
+                subprotocol = LMOS_PROTOCOL_NAME // Specific subprotocol for actions
             )
 
             // Add the form to the action's forms
             action.forms += form
-            log.debug("Assign '{}' with subprotocol '{}' to Action '{}'", href, "webthingprotocol", name)
+            log.debug("Assign '{}' with subprotocol '{}' to Action '{}'", href, LMOS_PROTOCOL_NAME, name)
         }
     }
 
@@ -132,14 +140,14 @@ class WebSocketProtocolServer(
             // Create a form for subscribing to the event
             val form = Form(
                 href = href,
-                contentType = "application/json",
-                subprotocol = "webthingprotocol",
+                contentType = SUB_PROTOCOL_MEDIA_TYPE,
+                subprotocol = LMOS_PROTOCOL_NAME,
                 op = listOf(Operation.SUBSCRIBE_EVENT, Operation.UNSUBSCRIBE_EVENT) // Operation type specific to events
             )
 
             // Add the form to the event's forms
             event.forms += form
-            log.debug("Assign '{}' with subprotocol '{}' to Event '{}'", href, "webthingprotocol", name)
+            log.debug("Assign '{}' with subprotocol '{}' to Event '{}'", href, LMOS_PROTOCOL_NAME, name)
         }
     }
 }
@@ -159,6 +167,13 @@ fun Application.setupRoutingWithWebSockets(servient: Servient) {
             configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
         }
     }
+    install(MicrometerMetrics) {
+        meterBinders = listOf(
+            JvmMemoryMetrics(),
+            JvmGcMetrics(),
+            ProcessorMetrics()
+        )
+    }
     install(WebSockets) {
         contentConverter = JacksonWebsocketContentConverter(JsonMapper.instance)
     }
@@ -438,94 +453,94 @@ private fun createUnsupportedMessageType(thingId: String, correlationId : String
     return ErrorMessage(
         thingId = thingId,
         correlationId = correlationId,
-        type = "https://w3c.github.io/web-thing-protocol/errors#unsupported-message-type",
+        type = "${LMOSContext.url}/errors#unsupported-message-type",
         title = "Unsupported Message Type",
         status = "400",
         detail = "Unsupported message type",
-        instance = "https://mythingserver.com/errors/${UUID.randomUUID()}"
+        instance = "${LMOSContext.url}/errors/${UUID.randomUUID()}"
     )
 }
 
 private fun createPropertyIsReadOnly(thingId: String, correlationId : String, propertyName: String?): ErrorMessage {
     return ErrorMessage(
         thingId = thingId,
         correlationId = correlationId,
-        type = "https://w3c.github.io/web-thing-protocol/errors#operation-not-allowed",
+        type = "${LMOSContext.url}/errors#operation-not-allowed",
         title = "Property Read-Only",
         status = "405",
         detail = "Property '$propertyName' is read-only.",
-        instance = "https://mythingserver.com/errors/${UUID.randomUUID()}"
+        instance = "${LMOSContext.url}/errors/${UUID.randomUUID()}"
     )
 }
 
 private fun createPropertyIsWriteOnly(thingId: String, correlationId : String, propertyName: String?): ErrorMessage {
     return ErrorMessage(
         thingId = thingId,
         correlationId = correlationId,
-        type = "https://w3c.github.io/web-thing-protocol/errors#operation-not-allowed",
+        type = "${LMOSContext.url}/errors#operation-not-allowed",
         title = "Property is write-only",
         status = "405",
         detail = "Property '$propertyName' is write-only.",
-        instance = "https://mythingserver.com/errors/${UUID.randomUUID()}"
+        instance = "${LMOSContext.url}/errors/${UUID.randomUUID()}"
     )
 }
 
 private fun createThingNotFound(thingId: String, correlationId : String): ErrorMessage {
     return ErrorMessage(
         thingId = thingId,
         correlationId = correlationId,
-        type = "https://w3c.github.io/web-thing-protocol/errors#not-found",
+        type = "${LMOSContext.url}/errors#not-found",
         title = "Thing Not Found",
         status = "404",
         detail = "Thing with ID '$thingId' not found.",
-        instance = "https://mythingserver.com/errors/${UUID.randomUUID()}"
+        instance = "${LMOSContext.url}/errors/${UUID.randomUUID()}"
     )
 }
 
 private fun createInternalServerError(thingId: String, correlationId : String, exceptionMessage: String?): ErrorMessage {
     return ErrorMessage(
         thingId = thingId,
         correlationId = correlationId,
-        type = "https://w3c.github.io/web-thing-protocol/errors#internal-server-error",
+        type = "${LMOSContext.url}/errors#internal-server-error",
         title = "Internal Server Error",
         status = "500",
-        detail = "Error reading property: $exceptionMessage",
-        instance = "https://mythingserver.com/errors/${UUID.randomUUID()}"
+        detail = "Internal Server Error: $exceptionMessage",
+        instance = "${LMOSContext.url}/errors/${UUID.randomUUID()}"
     )
 }
 
 private fun createPropertyNotFound(thingId: String, correlationId : String, propertyName: String?): ErrorMessage {
     return ErrorMessage(
         thingId = thingId,
         correlationId = correlationId,
-        type = "https://w3c.github.io/web-thing-protocol/errors#not-found",
+        type = "${LMOSContext.url}/errors#not-found",
         title = "Property Not Found",
         status = "404",
         detail = "Property '$propertyName' not found.",
-        instance = "https://mythingserver.com/errors/${UUID.randomUUID()}"
+        instance = "${LMOSContext.url}/errors/${UUID.randomUUID()}"
     )
 }
 
 private fun createEventNotFound(thingId: String, correlationId : String, eventName: String?): ErrorMessage {
     return ErrorMessage(
         thingId = thingId,
         correlationId = correlationId,
-        type = "https://w3c.github.io/web-thing-protocol/errors#not-found",
+        type = "${LMOSContext.url}/errors#not-found",
         title = "Event Not Found",
         status = "404",
         detail = "Event '$eventName' not found.",
-        instance = "https://mythingserver.com/errors/${UUID.randomUUID()}"
+        instance = "${LMOSContext.url}/errors/${UUID.randomUUID()}"
     )
 }
 
 private fun createActionNotFound(thingId: String, correlationId : String, actionName: String?): ErrorMessage {
     return ErrorMessage(
         thingId = thingId,
         correlationId = correlationId,
-        type = "https://w3c.github.io/web-thing-protocol/errors#not-found",
+        type = "${LMOSContext.url}/errors#not-found",
         title = "Action Not Found",
         status = "404",
         detail = "Action '$actionName' not found.",
-        instance = "https://mythingserver.com/errors/${UUID.randomUUID()}"
+        instance = "${LMOSContext.url}/errors/${UUID.randomUUID()}"
     )
 }

kotlin-wot-integration-tests/build.gradle.kts

@@ -9,6 +9,7 @@ dependencies {
     api(project(":kotlin-wot-binding-websocket"))
     api(project(":kotlin-wot-binding-mqtt"))
     api(project(":kotlin-wot-spring-boot-starter"))
+    api(project(":kotlin-wot-lmos-protocol"))
     implementation("ai.ancf.lmos:arc-azure-client:0.111.0")
     api("ai.ancf.lmos:arc-spring-boot-starter:0.111.0")
 

kotlin-wot-integration-tests/src/main/kotlin/integration/AgentApplication.kt

@@ -0,0 +1,14 @@
+package ai.ancf.lmos.wot.integration
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.boot.runApplication
+
+
+fun main(args: Array<String>) {
+    runApplication<AgentApplication>(*args)
+}
+
+@SpringBootApplication
+class AgentApplication {
+
+}