Constructor Detail

• ExecutionEnvironmentBuilder

  public ExecutionEnvironmentBuilder()

  Instantiates this builder

Method Detail

• addDependencyJar

  public ExecutionEnvironmentBuilder addDependencyJar​(java.lang.String jarFilePath)

  Adds a JAR that contains DigitalTwin class definitions, MessageProcessor definitions, Message definitions, or other dependencies.

  Parameters:

  jarFilePath - the string path to a JAR that will be added to the ExecutionEnvironment

  Returns:

  this builder

• addDigitalTwin

  public <T extends DigitalTwinBase,​V> ExecutionEnvironmentBuilder addDigitalTwin​(java.lang.String digitalTwinModel,
                                                                                        MessageProcessor<T,​V> digitalTwinMessageProcessor,
                                                                                        java.lang.Class<T> dtType,
                                                                                        java.lang.Class<V> valueClass)
                                                                                 throws ExecutionEnvironmentException

  Adds a digital twin model to this ExecutionEnvironment

  Type Parameters:

  T - the type of the DigitalTwinBase

  V - the type of the message processed by the digital twin

  Parameters:

  digitalTwinModel - the model of this DigitalTwin

  digitalTwinMessageProcessor - the MessageProcessor for this digital twin

  dtType - the class type for the digital twin

  valueClass - the class type for the messages sent to the digital twin

  Returns:

  this builder

  Throws:

  ExecutionEnvironmentException - thrown if an error occurs while adding a digital twin to this ExecutionEnvironmentBuilder

• addDigitalTwin

  public <T extends DigitalTwinBase,​V> ExecutionEnvironmentBuilder addDigitalTwin​(java.lang.String digitalTwinModel,
                                                                                        MessageProcessor<T,​V> digitalTwinMessageProcessor,
                                                                                        SimulationProcessor<T> digitalTwinSimulationProcessor,
                                                                                        java.lang.Class<T> dtType,
                                                                                        java.lang.Class<V> valueClass)
                                                                                 throws ExecutionEnvironmentException

  Adds a digital twin model to this ExecutionEnvironment

  Type Parameters:

  T - the type of the DigitalTwinBase

  V - the type of the message processed by the digital twin

  Parameters:

  digitalTwinModel - the model of this DigitalTwin

  digitalTwinMessageProcessor - the MessageProcessor for this digital twin

  digitalTwinSimulationProcessor - the ModelProcessor for this digital twin

  dtType - the class type for the digital twin

  valueClass - the class type for the messages sent to the digital twin

  Returns:

  this builder

  Throws:

  ExecutionEnvironmentException - thrown if an error occurs while adding a digital twin to this ExecutionEnvironmentBuilder

• addAlertProvider

  public ExecutionEnvironmentBuilder addAlertProvider​(AlertProviderConfiguration configuration)
                                               throws ExecutionEnvironmentException

  Add an AlertProvider to this execution environment

  Parameters:

  configuration - the alert provider's configuration

  Returns:

  this builder

  Throws:

  ExecutionEnvironmentException - thrown if an error occurs while adding the alert provider to this ExecutionEnvironmentBuilder

• addAzureDigitalTwinPersistence

  public ExecutionEnvironmentBuilder addAzureDigitalTwinPersistence​(java.lang.String digitalTwinModel,
                                                                    java.lang.String azureDigitalTwinModelName)
                                                             throws ExecutionEnvironmentException

  Throws:

  ExecutionEnvironmentException

• addSqlitePersistence

  public ExecutionEnvironmentBuilder addSqlitePersistence​(java.lang.String digitalTwinModel)
                                                   throws ExecutionEnvironmentException

  Throws:

  ExecutionEnvironmentException

• addSqlServerPersistence

  public ExecutionEnvironmentBuilder addSqlServerPersistence​(java.lang.String digitalTwinModel)
                                                      throws ExecutionEnvironmentException

  Throws:

  ExecutionEnvironmentException

• addDynamoDbPersistence

  public ExecutionEnvironmentBuilder addDynamoDbPersistence​(java.lang.String digitalTwinModel)
                                                     throws ExecutionEnvironmentException

  Throws:

  ExecutionEnvironmentException

• addDefaultPersistence

  public ExecutionEnvironmentBuilder addDefaultPersistence​(java.lang.String digitalTwinModel)
                                                    throws ExecutionEnvironmentException

  Throws:

  ExecutionEnvironmentException

• build

  public ExecutionEnvironment build()
                             throws ExecutionEnvironmentException

  Initializes the ExecutionEnvironment and hosts all attached digital twins.

  Returns:

  the instantiated ExecutionEnvironment

  Throws:

  ExecutionEnvironmentException - if an error occurs while instantiating the ExecutionEnvironment