Package software.amazon.awssdk.iot

Class AwsMqtt5Sigv4HandshakeTransformer

java.lang.Object
software.amazon.awssdk.crt.CrtResource
software.amazon.awssdk.iot.AwsMqtt5Sigv4HandshakeTransformer
All Implemented Interfaces:
AutoCloseable, Consumer<software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs>
public class AwsMqtt5Sigv4HandshakeTransformer extends software.amazon.awssdk.crt.CrtResource implements Consumer<software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs>
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
    AwsMqtt5Sigv4HandshakeTransformer(software.amazon.awssdk.crt.auth.signing.AwsSigningConfig signingConfig)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    accept(software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs 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

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.util.function.Consumer

    andThen

  • Constructor Details

    • AwsMqtt5Sigv4HandshakeTransformer

      public AwsMqtt5Sigv4HandshakeTransformer(software.amazon.awssdk.crt.auth.signing.AwsSigningConfig signingConfig)
      Parameters:
      signingConfig - sigv4 configuration for the signing process

  • Method Details

    • accept

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