Package com.scaleoutsoftware.digitaltwin.datasource.aws

Class AwsIotEndpointBuilder

  • public class AwsIotEndpointBuilder
extends java.lang.Object

    The AwsIotEndpointBuilder is used to create an endpoint between AWS IoT Core and the digital twin's ExecutionEnvironment (Deployed Model).

    • Constructor Summary

      Constructors 
      Constructor Description
      AwsIotEndpointBuilder​(java.lang.String friendlyName, java.lang.String clientEndpoint, java.lang.String clientId, java.lang.String awsAccessKeyIdPath, java.lang.String awsSecretAccessKeyPath)
      Creates an AwsIotEndpointBuilder

    • Method Summary

      Modifier and Type Method Description
      AwsIotEndpointBuilder addJar​(java.lang.String jarFilePath)
      Used to add any third party JARs to the classpath of the aws iot endpoint.
      AwsIotEndpoint build()
      Loads the AwsIotEndpoint and establishes the registration topic listener.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AwsIotEndpointBuilder

        public AwsIotEndpointBuilder​(java.lang.String friendlyName,
                             java.lang.String clientEndpoint,
                             java.lang.String clientId,
                             java.lang.String awsAccessKeyIdPath,
                             java.lang.String awsSecretAccessKeyPath)
                      throws AwsIotEndpointException

        Creates an AwsIotEndpointBuilder

        The parameters required are identical to the AwsIotMqtt client. The distributed AWS IoT endpoint establishes multiple AwsIoTMqtt clients across the SOSS store.

        Parameters:
        friendlyName - the friendly name of the this AwsIotEndpoint
        clientEndpoint - the client endpoint -- see AWS IoT core documentation.
        clientId - the clientId -- the distributed AWS grid service will create clientIds of the format String.format('%s_%s',clientId,ipAddress)
        awsAccessKeyIdPath - the aws certificate to use
        awsSecretAccessKeyPath - the aws secret key to use
        Throws:
        AwsIotEndpointException - if the certificate/private key files cannot be found/accessed.

    • Method Detail

      • addJar

        public AwsIotEndpointBuilder addJar​(java.lang.String jarFilePath)
        Used to add any third party JARs to the classpath of the aws iot endpoint.
        Parameters:
        jarFilePath - the jar file path
        Returns:
        this builder.