Package org.eclipse.hono.config

Interface GenericOptions

public interface GenericOptions
Generic configuration options shared by clients and server components.

  • Method Details

    • pathSeparator

      @WithDefault("/") String pathSeparator()
      Gets the character separating the segments of target addresses.
      Returns:
      The separator.

    • trustStorePath

      Optional<String> trustStorePath()
      Gets the path to the key store to load certificates of trusted CAs from.
      Returns:
      The absolute path.

    • trustStorePassword

      Optional<String> trustStorePassword()
      Gets the password for accessing the key store containing the certificates of trusted CAs.
      Returns:
      The password.

    • keyStorePath

      Optional<String> keyStorePath()
      Gets the absolute path to the key store containing the private key and certificate chain that will be used for authentication to peers.
      Returns:
      The path.

    • keyStorePassword

      Optional<String> keyStorePassword()
      Gets the password for the key store containing the private key and certificate chain that should be used for authentication to peers.
      Returns:
      The password.

    • certPath

      Optional<String> certPath()
      Gets the absolute path to the PEM file containing the X.509 certificate chain for the RSA private key that should be used for authentication to peers.
      Returns:
      The path or null if no path has been set.

    • keyPath

      Optional<String> keyPath()
      Gets the absolute path to the PEM file containing the RSA private key that will be used for authentication to peers.
      Returns:
      The path or null if no path has been set.

    • trustStoreFormat

      Optional<FileFormat> trustStoreFormat()
      Get the specified format of the trust store.
      Returns:
      The format or null if auto-detection should be tried.

    • keyFormat

      Optional<FileFormat> keyFormat()
      Get the specified format of the key files.
      Returns:
      The format or null if auto-detection should be tried.

    • secureProtocols

      @WithDefault("TLSv1.2,TLSv1.3") List<String> secureProtocols()
      Gets the secure protocols that are enabled for TLS connections.

      By default, only TLSv1.2 and TLSv1.3 are enabled. Please refer to the vert.x documentation for a list of supported values.

      Returns:
      The enabled protocols in order of preference.

    • supportedCipherSuites

      Optional<List<String>> supportedCipherSuites()
      Gets the names of the cipher suites that may be used in TLS connections.

      An empty list indicates that all cipher suites supported by the JVM can be used. This is also the default.

      Please refer to JSSE Cipher Suite Names for a list of supported cipher suite names.

      Returns:
      The supported cipher suites in order of preference.