io.vertx.core.net

## Interface KeyCertOptions

- All Known Implementing Classes:
    JksOptions, KeyStoreOptions, KeyStoreOptionsBase, PemKeyCertOptions, PfxOptions

      public interface KeyCertOptions

  Key/cert configuration options.
  Author:
    Julien Viet

- - ### Method Summary

    All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `KeyCertOptions` | `copy()`
    `KeyManagerFactory` | `getKeyManagerFactory(Vertx vertx)` Create and return the key manager factory for these options.
    `default java.util.function.Function<String,KeyManagerFactory>` | `keyManagerFactoryMapper(Vertx vertx)` Returns a function that maps SNI server names to `KeyManagerFactory` instance.
    `default java.util.function.Function<String,X509KeyManager>` | `keyManagerMapper(Vertx vertx)` Deprecated. instead use `keyManagerFactoryMapper(Vertx)`
    `static KeyCertOptions` | `wrap(KeyManagerFactory keyManagerFactory)` Returns a `KeyCertOptions` from the provided `KeyManagerFactory`
    `static KeyCertOptions` | `wrap(X509KeyManager keyManager)` Returns a `KeyCertOptions` from the provided `X509KeyManager`

- - ### Method Detail

    - #### copy

          KeyCertOptions copy()

      Returns:
        a copy of these options

    - #### getKeyManagerFactory

          KeyManagerFactory getKeyManagerFactory(Vertx vertx)
                                          throws Exception

      Create and return the key manager factory for these options.

      The returned key manager factory should be already initialized and ready to use.

      Parameters:
        `vertx` - the vertx instance
      Returns:
        the key manager factory
      Throws:
        `Exception`

    - #### keyManagerMapper

          @Deprecated
          default java.util.function.Function<String,X509KeyManager> keyManagerMapper(Vertx vertx)
                                                                                           throws Exception

      Deprecated. instead use `keyManagerFactoryMapper(Vertx)`
      Returns a function that maps SNI server names to `X509KeyManager` instance. The returned `X509KeyManager` must satisfies these rules:
      - `X509KeyManager.getPrivateKey(String)` returns the private key for the indicated server name, the `alias` parameter will be `null`.
      - `X509KeyManager.getCertificateChain(String)` returns the certificate chain for the indicated server name, the `alias` parameter will be `null`.
      The mapper is only used when the server has SNI enabled and the client indicated a server name.

      The returned function may return `null` in which case the default key manager provided by `getKeyManagerFactory(Vertx)` will be used.

      Throws:
        `Exception`

    - #### keyManagerFactoryMapper

          default java.util.function.Function<String,KeyManagerFactory> keyManagerFactoryMapper(Vertx vertx)
                                                                                         throws Exception

      Returns a function that maps SNI server names to `KeyManagerFactory` instance. The returned `KeyManagerFactory` must satisfies these rules:
      - The store private key must match the indicated server name for a null alias.
      - The store certificate chain must match the indicated server name for a null alias.
      The mapper is only used when the server has SNI enabled and the client indicated a server name.

      The returned function may return `null` in which case the default key manager provided by `getKeyManagerFactory(Vertx)` will be used.

      Throws:
        `Exception`

    - #### wrap

          static KeyCertOptions wrap(X509KeyManager keyManager)

      Returns a `KeyCertOptions` from the provided `X509KeyManager`
      Parameters:
        `keyManager` - the keyManager instance
      Returns:
        the `KeyCertOptions`

    - #### wrap

          static KeyCertOptions wrap(KeyManagerFactory keyManagerFactory)

      Returns a `KeyCertOptions` from the provided `KeyManagerFactory`
      Parameters:
        `keyManagerFactory` - the keyManagerFactory instance
      Returns:
        the `KeyCertOptions`

Copyright © 2023 Eclipse. All rights reserved.