Package io.quarkus.tls

Interface TlsConfiguration

All Known Implementing Classes:
BaseTlsConfiguration, VertxCertificateHolder
public interface TlsConfiguration
The transport layer security configuration.

  • Method Details

    • from

      static Optional<TlsConfiguration> from(TlsConfigurationRegistry registry, Optional<String> name)

    • getKeyStore

      KeyStore getKeyStore()
      Returns the key store.
      Returns:
      the key store if configured.

    • getKeyStoreOptions

      io.vertx.core.net.KeyCertOptions getKeyStoreOptions()
      Returns the key store options.
      Returns:
      the key store options if configured.

    • getTrustStore

      KeyStore getTrustStore()
      Returns the trust store.
      Returns:
      the trust store if configured.

    • getTrustStoreOptions

      io.vertx.core.net.TrustOptions getTrustStoreOptions()
      Returns the trust store options.
      Returns:
      the trust store options if configured.

    • getSSLOptions

      io.vertx.core.net.SSLOptions getSSLOptions()
      Returns the (Vert.x) SSL options.
      Returns:
      the SSLOptions, null if not configured.

    • createSSLContext

      SSLContext createSSLContext() throws Exception
      Creates and returns the SSL Context.
      Returns:
      the SSLContext, null if not configured.
      Throws:
      Exception - if the SSL Context cannot be created.

    • isTrustAll

      default boolean isTrustAll()
      Returns whether the trust store is configured to trust all certificates.
      Returns:
      true if the trust store is configured to trust all certificates, false otherwise.

    • getHostnameVerificationAlgorithm

      Optional<String> getHostnameVerificationAlgorithm()
      Returns the hostname verification algorithm for this configuration. "NONE" means no hostname verification.
      Returns:
      the hostname verification algorithm.

    • usesSni

      boolean usesSni()
      Returns whether the key store is configured to use SNI. When SNI is used, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate.
      Returns:
      true if the key store is configured to use SNI, false otherwise.

    • reload

      boolean reload()
      Reloads the configuration. It usually means reloading the key store and trust store, especially when they are files.
      Returns:
      true if the configuration has been reloaded, false otherwise.

    • getName

      default String getName()
      Returns the name which was associated with this configuration

      Note: Although this was made default in order to not break deep integrations, it is strongly recommended that the method be implemented.