Package cool.mqtt.hooks

Interface SecurityParams

public interface SecurityParams
A wrapper of the parameters used to support the setting up of encrypted connections between the MQTT.Cool server and the target MQTT broker.

  • Method Summary

    Modifier and Type Method Description
    char[] getKeystorePassword()
    The password for the JKS keystore.
    java.nio.file.Path getKeystorePath()
    The absolute path to the JKS keystore, which contains the client certificate and the private key to be used in the case the target MQTT broker requires client authentication.
    char[] getPrivateKeyPassword()
    The password for the private key stored into the JSK keystore.
    java.lang.String getSecurityProtocol()
    The standard name of the security protocol to be used, as specified in the Java Cryptography Architecture Standard Algorithm Name.
    char[] getTruststorePassword()
    The password for the JKS truststore.
    java.nio.file.Path getTruststorePath()
    The absolute path to the JKS truststore, which contains the MQTT broker certificate to trust.

  • Method Details

    • getSecurityProtocol

      java.lang.String getSecurityProtocol()
      The standard name of the security protocol to be used, as specified in the Java Cryptography Architecture Standard Algorithm Name.

      If either null or empty string is returned, the TLSv1.2 protocol will be used.

      Returns:
      the standard name of the security protocol, or null or empty string for the default value

    • getTruststorePath

      java.nio.file.Path getTruststorePath()
      The absolute path to the JKS truststore, which contains the MQTT broker certificate to trust.

      If null is returned, a default truststore will be determined according to the JSSE Reference Guide.

      Returns:
      the absolute path to the JKS truststore, or null

    • getTruststorePassword

      char[] getTruststorePassword()
      The password for the JKS truststore.

      The password will be used only if a truststore is provided by getTruststorePath().

      Returns:
      the password for the JSK truststore

    • getKeystorePath

      java.nio.file.Path getKeystorePath()
      The absolute path to the JKS keystore, which contains the client certificate and the private key to be used in the case the target MQTT broker requires client authentication.

      If null is returned, a default keystore will be determined according to the JSSE Reference Guide.

      Returns:
      the absolute path to the JKS keystore, or null

    • getKeystorePassword

      char[] getKeystorePassword()
      The password for the JKS keystore.

      The password will be used only if a keystore is provided by getKeystorePath().

      Returns:
      the password for the JKS keystore

    • getPrivateKeyPassword

      char[] getPrivateKeyPassword()
      The password for the private key stored into the JSK keystore.

      The password will be used only if a keystore is provided by getKeystorePath().

      Returns:
      the password for the private key stored into the JSK keystore, or null