Class AwsSigv4HandshakeTransformer

  • All Implemented Interfaces:
    AutoCloseable, Consumer<software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs>

    public class AwsSigv4HandshakeTransformer
    extends software.amazon.awssdk.crt.CrtResource
    implements Consumer<software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs>
    A websocket handshake transformer that adds a sigv4 signature for the handshake to the request. Required in order to connect to Aws IoT via websockets using sigv4 authentication.
    • Nested Class Summary

      • Nested classes/interfaces inherited from class software.amazon.awssdk.crt.CrtResource

        software.amazon.awssdk.crt.CrtResource.ResourceInstance
    • Constructor Summary

      Constructors 
      Constructor Description
      AwsSigv4HandshakeTransformer​(software.amazon.awssdk.crt.auth.signing.AwsSigningConfig signingConfig)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void accept​(software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs handshakeArgs)
      Modifies the handshake request to include its sigv4 signature
      • Methods inherited from class software.amazon.awssdk.crt.CrtResource

        addRef, addReferenceTo, close, collectNativeResource, collectNativeResources, decRef, getNativeHandle, getResourceLogDescription, isNull, logNativeResources, logNativeResources, removeReferenceTo, setDescription, waitForNoResources
    • Constructor Detail

      • AwsSigv4HandshakeTransformer

        public AwsSigv4HandshakeTransformer​(software.amazon.awssdk.crt.auth.signing.AwsSigningConfig signingConfig)
        Parameters:
        signingConfig - sigv4 configuration for the signing process
    • Method Detail

      • accept

        public void accept​(software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs handshakeArgs)
        Modifies the handshake request to include its sigv4 signature
        Specified by:
        accept in interface Consumer<software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs>
        Parameters:
        handshakeArgs - handshake transformation completion object