Implement external data service for primary data and results

build.gradle

@@ -67,6 +67,11 @@ repositories {
 }
 
 dependencies {
+  constraints {
+    implementation( 'com.fasterxml.jackson.core:jackson-databind:2.16.0+' ){
+      because "[CVE-2020-25649] CWE-611: Improper Restriction of XML External Entity Reference ('XXE')"
+    }
+  }
 
   // ie³ internal repository
   implementation('com.github.ie3-institute:PowerSystemUtils:2.2.1') {
@@ -95,6 +100,12 @@ dependencies {
     exclude group: 'edu.ie3'
   }
 
+  implementation('com.github.ie3-institute:simosaik') {
+    exclude group: 'org.apache.logging.log4j'
+    exclude group: 'org.slf4j'
+    exclude group: 'edu.ie3'
+  }
+
   /* logging */
   implementation "com.typesafe.scala-logging:scala-logging_${scalaVersion}:3.9.5" // pekko scala logging
   implementation "ch.qos.logback:logback-classic:1.5.6"

docs/uml/main/ExtPrimaryResultSimulationClasses.puml

@@ -0,0 +1,166 @@
+@startuml
+'https://plantuml.com/class-diagram
+skinparam linetype ortho
+
+package simple-ext-simulation {
+    class ExtLink
+    class SimpleExtSimulation {
+        - ExtPrimaryDataSimulation extPrimaryDataSimulation
+        - ExtResultDataSimulation extResultDataSimulation
+    }
+    class SimplePrimaryDataFactory
+
+    class SimpleResultDataFactory
+
+    SimplePrimaryDataFactory --> SimpleExtSimulation
+    SimpleResultDataFactory --> SimpleExtSimulation
+}
+
+package simona-api {
+
+    interface ExtData
+
+    class ExtPrimaryData {
+        - ActorRef dataService
+        - ActorRef extSimAdapter
+        - PrimaryDataFactory factory
+        - List<UUID> primaryDataAssets
+        ---
+        + void providePrimaryData(Long tick, Map<String, Object> primaryData)
+        + void sendExtMsg(PrimaryDataMessageFromExt msg)
+    }
+    ExtPrimaryData --|> ExtData
+
+    class ExtResultData {
+        - ActorRef dataService
+        - ActorRef dataServiceActivation
+        - ActorRef extSimAdapter
+        - ResultDataFactory factory
+        - List<UUID> resultDataAssets
+        ---
+        + List<ResultEntity> requestResults(long tick)
+        + Map<String, Object> requestResultObjects(long tick)
+        ~ Map<String, Object> convertResultsList(List<ResultEntity> results)
+    }
+    ExtResultData --|> ExtData
+
+    ' MIDDLE PART
+    class ExtEvData
+    ExtEvData --|> ExtData
+
+    interface ExtDataSimulation
+
+    class ExtPrimaryDataSimulation {
+        - List<UUID> primaryDataAssets
+        - PrimaryDataFactory primaryDataFactory
+        - ExtPrimaryData extPrimaryData
+        ---
+        + void setExtPrimaryData(ExtPrimaryData extPrimaryData)
+    }
+    ExtPrimaryDataSimulation --|> ExtDataSimulation
+
+    class ExtResultDataSimulation {
+        - List<UUID> resultDataAssets
+        - ResultDataFactory resultDataFactory
+        - ExtResultData extResultData
+        ---
+        + void setExtResultData(ExtResultData extResultData)
+    }
+    ExtResultDataSimulation --|> ExtDataSimulation
+
+    interface PrimaryDataFactory {
+        Value convert(Object entity)
+    }
+    PrimaryDataFactory --> ExtPrimaryDataSimulation
+
+    interface ResultDataFactory {
+        Object convert(ResultEntity entity)
+    }
+    ResultDataFactory --> ExtResultDataSimulation
+
+    SimplePrimaryDataFactory --|> PrimaryDataFactory
+    SimpleResultDataFactory --|> ResultDataFactory
+
+    class ExtSimAdapterData {
+        ~ LinkedBlockingQueue<ExtTrigger> receiveTriggerQueue
+        - Map<Integer, ActorRef> extSimAdapters
+        + void queueExtMsg(ExtTrigger trigger)
+        + void send(ExtTriggerResponse msg)
+    }
+
+
+    abstract class ExtSimulation {
+        - ExtSimAdapterData data
+        + void setup(ExtSimAdapterData data, List<ExtData> adapters)
+        + void run()
+        # Optional<Long> doActivity(long tick, int phase)
+        # {abstract} Optional<Long> initialize()
+        # {abstract} Optional<Long> doPreActivity(long tick)
+        # {abstract} Optional<Long> doPostActivity(long tick)
+    }
+
+    SimpleExtSimulation --|> ExtSimulation
+
+    interface ExtEvSimulation {
+        + void setExtEvData(ExtEvData evData)
+    }
+
+    ExtEvSimulation --|> ExtDataSimulation
+
+    interface DataMessageFromExt
+    interface PrimaryDataMessageFromExt
+    interface ResultDataMessageFromExt
+    interface EvDataMessageFromExt
+    PrimaryDataMessageFromExt --|> DataMessageFromExt
+    ResultDataMessageFromExt --|> DataMessageFromExt
+    EvDataMessageFromExt --|> DataMessageFromExt
+
+    class ProvidePrimaryData {
+        - long tick
+        - Map<UUID, Value> primaryData
+    }
+    ProvidePrimaryData --|> PrimaryDataMessageFromExt
+
+    class RequestResultEntities {
+        - long tick
+    }
+    RequestResultEntities --|> ResultDataMessageFromExt
+
+
+    interface DataResponseMessageToExt
+    interface ResultDataResponseMessageToExt
+    interface EvDataResponseMessageToExt
+
+    ResultDataResponseMessageToExt --|> DataResponseMessageToExt
+    EvDataResponseMessageToExt --|> DataResponseMessageToExt
+    class ProvideResultEntities {
+        + List<ResultEntity> results
+    }
+    ProvideResultEntities --|> ResultDataResponseMessageToExt
+
+    ExtSimAdapterData --> ExtSimulation
+
+    interface ExtLinkInterface {
+        ExtSimulation getExtSimulation()
+        List<ExtDataSimulation> getExtDataSimulation()
+    }
+    ExtLink --|> ExtLinkInterface
+
+    class ScheduleDataServiceMessage
+}
+
+package simona {
+    class ExtPrimaryDataService
+
+    ExtPrimaryData --> ExtPrimaryDataService
+
+    class ExtResultDataProvider
+
+    ExtResultData --> ExtResultDataProvider
+
+    class ExtSimAdapter
+
+    ExtSimAdapterData --> ExtSimAdapter
+}
+
+@enduml

docs/uml/main/ExtSimulationAndAPIClasses.puml

@@ -0,0 +1,133 @@
+@startuml
+'https://plantuml.com/class-diagram
+skinparam linetype ortho
+
+package simona-api {
+
+    interface DataMessageFromExt
+    interface PrimaryDataMessageFromExt
+    interface EvDataMessageFromExt
+
+    PrimaryDataMessageFromExt --> DataMessageFromExt
+    EvDataMessageFromExt --> DataMessageFromExt
+    ResultDataMessageFromExt --> DataMessageFromExt
+
+    class ProvidePrimaryData {
+        + long tick
+        + Map<UUID, Value> primaryData
+    }
+
+    ProvidePrimaryData --> PrimaryDataMessageFromExt
+
+    class ProvideArrivingEvs {
+        + Map<UUID, List<EvModel>> arrivals)
+    }
+
+    class RequestCurrentPrices
+    class RequestDepartingEvs
+    class RequestEvcsFreeLots
+
+    ProvideArrivingEvs --> EvDataMessageFromExt
+    RequestCurrentPrices --> EvDataMessageFromExt
+    RequestDepartingEvs --> EvDataMessageFromExt
+    RequestEvcsFreeLots --> EvDataMessageFromExt
+
+    class RequestResultEntities {
+        + Long tick
+    }
+
+    RequestResultEntities --> ResultDataMessageFromExt
+
+    interface DataResponseMessageToExt
+    interface ResultDataResponseMessageToExt
+    interface EvDataResponseMessageToExt
+
+    ResultDataResponseMessageToExt --> DataResponseMessageToExt
+    EvDataResponseMessageToExt --> DataResponseMessageToExt
+
+    class ProvideResultEntities {
+        + List<ResultEntity> results
+    }
+
+    ProvideResultEntities --> ResultDataResponseMessageToExt
+
+    class ProvideCurrentPrices
+
+    class ProvideDepartingEvs
+
+    class ProvideEvcsFreeLots
+    ProvideCurrentPrices --> EvDataResponseMessageToExt
+    ProvideDepartingEvs --> EvDataResponseMessageToExt
+    ProvideEvcsFreeLots --> EvDataResponseMessageToExt
+
+    interface ExtData
+
+    class ExtEvData
+    class ExtPrimaryData {
+        PrimaryDataFactory primaryDataFactory
+    }
+    class ExtResultData
+
+    ExtEvData --> ExtData
+    ExtPrimaryData --> ExtData
+    ExtResultData --> ExtData
+
+
+
+    interface PrimaryDataFactory {
+        + Value convert(Object entity)
+    }
+    PrimaryDataFactory -- ExtPrimaryData
+
+    interface ResultDataFactory {
+        + Object convert(ResultEntity entity)
+    }
+    ResultDataFactory -- ExtResultData
+
+    interface ExtDataSimulation
+    interface ExtResultDataSimulation
+    interface ExtPrimaryDataSimulation
+    interface ExtEvDataSimulation
+
+    ExtPrimaryDataSimulation --> ExtDataSimulation
+    ExtResultDataSimulation --> ExtDataSimulation
+    ExtEvDataSimulation --> ExtDataSimulation
+
+    abstract class ExtSimulation {
+        - ExtSimAdapterData data
+
+        # Optional<Long> initialize()
+        # Optional<Long> doActivity(long tick)
+    }
+}
+
+package simona {
+    class SimonaSim
+
+    class SimScheduler
+
+    class SimonaStandaloneSetup
+
+    class ExtSimLoader
+
+    class ExtSimAdapter
+
+    class ExtResultDataProvider
+    ExtResultDataProvider -- ExtResultData
+
+    class ExtPrimaryDataService
+    ExtPrimaryDataService -- ExtPrimaryData
+
+    SimScheduler -- SimonaSim
+    SimonaSim *- SimonaStandaloneSetup
+    SimonaStandaloneSetup *- ExtSimLoader
+
+    ExtSimAdapter -- SimScheduler
+    ExtPrimaryDataService -- SimScheduler
+
+    SimonaService <|- ExtPrimaryDataService
+
+    ExtSimAdapterData <--- ExtSimAdapter
+}
+
+@enduml