Greengrass IPC update including MQTT 5 models (#412)

Author: MikeDombo

sdk/greengrass/event-stream-rpc-client/src/main/java/software/amazon/awssdk/eventstreamrpc/EventStreamRPCConnection.java

@@ -34,12 +34,12 @@ enum Phase {
             CONNECTED,
             CLOSING
         };
-
+        
         Phase connectionPhase;
         ClientConnection connection;
         Throwable closeReason;
         boolean onConnectCalled;
-
+        
         protected ConnectionState(Phase phase, ClientConnection connection) {
             this.connectionPhase = phase;
             this.connection = connection;
@@ -75,7 +75,7 @@ protected String getVersionString() {
 
     /**
      * Connects to the event stream RPC server asynchronously
-     *
+     * 
      * @return A future that completes when connected
      */
     public CompletableFuture<Void> connect(final LifecycleHandler lifecycleHandler) {
@@ -156,7 +156,7 @@ protected void onProtocolMessage(List<Header> headers, byte[] payload, MessageTy
                                     LOGGER.warning("AccessDenied to event stream RPC server");
                                     connectionState.connectionPhase = ConnectionState.Phase.CLOSING;
                                     connectionState.connection.closeConnection(0);
-
+                                    
                                     final AccessDeniedException ade = new AccessDeniedException("Connection access denied to event stream RPC server");
                                     if (!initialConnectFuture.isDone()) {
                                         initialConnectFuture.completeExceptionally(ade);
@@ -179,7 +179,7 @@ protected void onProtocolMessage(List<Header> headers, byte[] payload, MessageTy
                             disconnect();
                         } else if (MessageType.ProtocolError.equals(messageType) || MessageType.ServerError.equals(messageType)) {
                             LOGGER.severe("Received " + messageType.name() + ": " + CRT.awsErrorName(CRT.awsLastError()));
-                            connectionState.closeReason = EventStreamError.create(headers, payload, messageType);
+                            connectionState.closeReason = EventStreamError.create(headers, payload, messageType);                            
                             doOnError(lifecycleHandler, connectionState.closeReason);
                             disconnect();
                         } else {
@@ -222,7 +222,7 @@ protected void onConnectionClosed(int errorCode) {
     /**
      * Creates a new stream with the given continuation handler.
      * Trhows an exception if not connected
-     *
+     * 
      * @param continuationHandler The continuation handler to use
      * @return A new ClientConnectionContinuation containing the new stream.
      */
@@ -375,7 +375,7 @@ public interface LifecycleHandler {
           * Do nothing on ping by default. Inform handler of ping data
          *
          * TODO: Could use boolean return here as a hint on whether a pong reply should be sent?
-         *
+         * 
           * @param headers The ping headers
           * @param payload The ping payload
           */

sdk/greengrass/event-stream-rpc-model/src/main/java/software/amazon/awssdk/eventstreamrpc/DeserializationException.java

@@ -1,7 +1,5 @@
 package software.amazon.awssdk.eventstreamrpc;
 
-import java.util.Arrays;
-
 /**
  * Thrown when a deserialization exception occurs
  */
@@ -20,14 +18,6 @@ public DeserializationException(Object lexicalData) {
      * @param cause The reason the data could not be deserialized
      */
     public DeserializationException(Object lexicalData, Throwable cause) {
-        super("Could not deserialize data: [" + stringify(lexicalData) + "]", cause);
-    }
-
-    private static String stringify(Object lexicalData) {
-        if (lexicalData instanceof byte[]) {
-            return Arrays.toString((byte[]) lexicalData);
-        }
-
-        return lexicalData.toString();
+        super("Could not deserialize data: [" + lexicalData.toString() + "]", cause);
     }
 }

sdk/greengrass/greengrass-client/src/event-stream-rpc-java/model/software/amazon/awssdk/aws/greengrass/GreengrassCoreIPCServiceModel.java

@@ -78,6 +78,7 @@
 import software.amazon.awssdk.aws.greengrass.model.MetricUnitType;
 import software.amazon.awssdk.aws.greengrass.model.PauseComponentRequest;
 import software.amazon.awssdk.aws.greengrass.model.PauseComponentResponse;
+import software.amazon.awssdk.aws.greengrass.model.PayloadFormat;
 import software.amazon.awssdk.aws.greengrass.model.PostComponentUpdateEvent;
 import software.amazon.awssdk.aws.greengrass.model.PreComponentUpdateEvent;
 import software.amazon.awssdk.aws.greengrass.model.PublishMessage;
@@ -124,6 +125,7 @@
 import software.amazon.awssdk.aws.greengrass.model.UpdateStateResponse;
 import software.amazon.awssdk.aws.greengrass.model.UpdateThingShadowRequest;
 import software.amazon.awssdk.aws.greengrass.model.UpdateThingShadowResponse;
+import software.amazon.awssdk.aws.greengrass.model.UserProperty;
 import software.amazon.awssdk.aws.greengrass.model.ValidateAuthorizationTokenRequest;
 import software.amazon.awssdk.aws.greengrass.model.ValidateAuthorizationTokenResponse;
 import software.amazon.awssdk.aws.greengrass.model.ValidateConfigurationUpdateEvent;
@@ -408,6 +410,7 @@ public class GreengrassCoreIPCServiceModel extends EventStreamRPCServiceModel {
     SERVICE_OBJECT_MODEL_MAP.put(MetricUnitType.APPLICATION_MODEL_TYPE, MetricUnitType.class);
     SERVICE_OBJECT_MODEL_MAP.put(PauseComponentRequest.APPLICATION_MODEL_TYPE, PauseComponentRequest.class);
     SERVICE_OBJECT_MODEL_MAP.put(PauseComponentResponse.APPLICATION_MODEL_TYPE, PauseComponentResponse.class);
+    SERVICE_OBJECT_MODEL_MAP.put(PayloadFormat.APPLICATION_MODEL_TYPE, PayloadFormat.class);
     SERVICE_OBJECT_MODEL_MAP.put(PostComponentUpdateEvent.APPLICATION_MODEL_TYPE, PostComponentUpdateEvent.class);
     SERVICE_OBJECT_MODEL_MAP.put(PreComponentUpdateEvent.APPLICATION_MODEL_TYPE, PreComponentUpdateEvent.class);
     SERVICE_OBJECT_MODEL_MAP.put(PublishMessage.APPLICATION_MODEL_TYPE, PublishMessage.class);
@@ -454,6 +457,7 @@ public class GreengrassCoreIPCServiceModel extends EventStreamRPCServiceModel {
     SERVICE_OBJECT_MODEL_MAP.put(UpdateStateResponse.APPLICATION_MODEL_TYPE, UpdateStateResponse.class);
     SERVICE_OBJECT_MODEL_MAP.put(UpdateThingShadowRequest.APPLICATION_MODEL_TYPE, UpdateThingShadowRequest.class);
     SERVICE_OBJECT_MODEL_MAP.put(UpdateThingShadowResponse.APPLICATION_MODEL_TYPE, UpdateThingShadowResponse.class);
+    SERVICE_OBJECT_MODEL_MAP.put(UserProperty.APPLICATION_MODEL_TYPE, UserProperty.class);
     SERVICE_OBJECT_MODEL_MAP.put(ValidateAuthorizationTokenRequest.APPLICATION_MODEL_TYPE, ValidateAuthorizationTokenRequest.class);
     SERVICE_OBJECT_MODEL_MAP.put(ValidateAuthorizationTokenResponse.APPLICATION_MODEL_TYPE, ValidateAuthorizationTokenResponse.class);
     SERVICE_OBJECT_MODEL_MAP.put(ValidateConfigurationUpdateEvent.APPLICATION_MODEL_TYPE, ValidateConfigurationUpdateEvent.class);

sdk/greengrass/greengrass-client/src/event-stream-rpc-java/model/software/amazon/awssdk/aws/greengrass/model/AuthorizeClientDeviceActionRequest.java

@@ -53,50 +53,77 @@ public AuthorizeClientDeviceActionRequest() {
     this.resource = Optional.empty();
   }
 
+  /**
+   * The session token for the client device from GetClientDeviceAuthToken.
+   */
   public String getClientDeviceAuthToken() {
     if (clientDeviceAuthToken.isPresent()) {
       return clientDeviceAuthToken.get();
     }
     return null;
   }
 
+  /**
+   * The session token for the client device from GetClientDeviceAuthToken.
+   */
   public void setClientDeviceAuthToken(final String clientDeviceAuthToken) {
     this.clientDeviceAuthToken = Optional.ofNullable(clientDeviceAuthToken);
   }
 
+  /**
+   * The session token for the client device from GetClientDeviceAuthToken.
+   */
   public AuthorizeClientDeviceActionRequest withClientDeviceAuthToken(
       final String clientDeviceAuthToken) {
     setClientDeviceAuthToken(clientDeviceAuthToken);
     return this;
   }
 
+  /**
+   * The operation to authorize.
+   */
   public String getOperation() {
     if (operation.isPresent()) {
       return operation.get();
     }
     return null;
   }
 
+  /**
+   * The operation to authorize.
+   */
   public void setOperation(final String operation) {
     this.operation = Optional.ofNullable(operation);
   }
 
+  /**
+   * The operation to authorize.
+   */
   public AuthorizeClientDeviceActionRequest withOperation(final String operation) {
     setOperation(operation);
     return this;
   }
 
+  /**
+   * The resource the client device performs the operation on.
+   */
   public String getResource() {
     if (resource.isPresent()) {
       return resource.get();
     }
     return null;
   }
 
+  /**
+   * The resource the client device performs the operation on.
+   */
   public void setResource(final String resource) {
     this.resource = Optional.ofNullable(resource);
   }
 
+  /**
+   * The resource the client device performs the operation on.
+   */
   public AuthorizeClientDeviceActionRequest withResource(final String resource) {
     setResource(resource);
     return this;

sdk/greengrass/greengrass-client/src/event-stream-rpc-java/model/software/amazon/awssdk/aws/greengrass/model/AuthorizeClientDeviceActionResponse.java

@@ -40,17 +40,26 @@ public AuthorizeClientDeviceActionResponse() {
     this.isAuthorized = Optional.empty();
   }
 
+  /**
+   * Whether the client device is authorized to perform the operation on the resource.
+   */
   public Boolean isIsAuthorized() {
     if (isAuthorized.isPresent()) {
       return isAuthorized.get();
     }
     return null;
   }
 
+  /**
+   * Whether the client device is authorized to perform the operation on the resource.
+   */
   public void setIsAuthorized(final Boolean isAuthorized) {
     this.isAuthorized = Optional.ofNullable(isAuthorized);
   }
 
+  /**
+   * Whether the client device is authorized to perform the operation on the resource.
+   */
   public AuthorizeClientDeviceActionResponse withIsAuthorized(final Boolean isAuthorized) {
     setIsAuthorized(isAuthorized);
     return this;

sdk/greengrass/greengrass-client/src/event-stream-rpc-java/model/software/amazon/awssdk/aws/greengrass/model/BinaryMessage.java

@@ -47,24 +47,33 @@ public BinaryMessage() {
     this.context = Optional.empty();
   }
 
+  /**
+   * The binary message as a blob.
+   */
   public byte[] getMessage() {
     if (message.isPresent()) {
       return message.get();
     }
     return null;
   }
 
+  /**
+   * The binary message as a blob.
+   */
   public void setMessage(final byte[] message) {
     this.message = Optional.ofNullable(message);
   }
 
+  /**
+   * The binary message as a blob.
+   */
   public BinaryMessage withMessage(final byte[] message) {
     setMessage(message);
     return this;
   }
 
   /**
-   * The context is ignored if used in PublishMessage.
+   * The context of the message, such as the topic where the message was published.
    */
   public MessageContext getContext() {
     if (context.isPresent()) {
@@ -74,14 +83,14 @@ public MessageContext getContext() {
   }
 
   /**
-   * The context is ignored if used in PublishMessage.
+   * The context of the message, such as the topic where the message was published.
    */
   public void setContext(final MessageContext context) {
     this.context = Optional.ofNullable(context);
   }
 
   /**
-   * The context is ignored if used in PublishMessage.
+   * The context of the message, such as the topic where the message was published.
    */
   public BinaryMessage withContext(final MessageContext context) {
     setContext(context);

sdk/greengrass/greengrass-client/src/event-stream-rpc-java/model/software/amazon/awssdk/aws/greengrass/model/CertificateOptions.java

@@ -46,26 +46,41 @@ public CertificateType getCertificateType() {
     return null;
   }
 
+  /**
+   * The types of certificate updates to subscribe to.
+   */
   public String getCertificateTypeAsString() {
     if (certificateType.isPresent()) {
       return certificateType.get();
     }
     return null;
   }
 
+  /**
+   * The types of certificate updates to subscribe to.
+   */
   public void setCertificateType(final String certificateType) {
     this.certificateType = Optional.ofNullable(certificateType);
   }
 
+  /**
+   * The types of certificate updates to subscribe to.
+   */
   public CertificateOptions withCertificateType(final String certificateType) {
     setCertificateType(certificateType);
     return this;
   }
 
+  /**
+   * The types of certificate updates to subscribe to.
+   */
   public void setCertificateType(final CertificateType certificateType) {
     this.certificateType = Optional.ofNullable(certificateType.getValue());
   }
 
+  /**
+   * The types of certificate updates to subscribe to.
+   */
   public CertificateOptions withCertificateType(final CertificateType certificateType) {
     setCertificateType(certificateType);
     return this;