Vert.x 4.5.13 · io.vertx.core.net.KeyCertOptions · APIdia, the JavaDoc alternative

Method Summary

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

Method Detail

copy	back to summary
public KeyCertOptions copy() Returns:KeyCertOptions a copy of these options

getKeyManagerFactory	back to summary
public 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:Vertx the vertx instance Returns:KeyManagerFactory the key manager factory

getKeyManagerFactory

back to summary

public 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:Vertx: the vertx instance

Returns:KeyManagerFactory

the key manager factory

keyManagerFactoryMapper back to summary

keyManagerFactoryMapper	back to summary
public default 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. Implementation Specification the default implementation converts they `keyManagerMapper(Vertx)` to a `KeyManagerFactory` Implementation Note the default implementation does not any caching, creating a `KeyManagerFactory` can be expense, implementations are encouraged to reimplement this method and cache the result

public default 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.

Implementation Specification

the default implementation converts they keyManagerMapper(Vertx) to a KeyManagerFactory

Implementation Note

the default implementation does not any caching, creating a KeyManagerFactory can be expense, implementations are encouraged to reimplement this method and cache the result

keyManagerMapper back to summary

keyManagerMapper	back to summary
public default 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. Annotations @Deprecated

public default 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.

Annotations

@Deprecated

wrap back to summary

wrap	back to summary
public static KeyCertOptions wrap(X509KeyManager keyManager) Returns a `KeyCertOptions` from the provided `X509KeyManager` Parameters keyManager:X509KeyManager the keyManager instance Returns:KeyCertOptions the `KeyCertOptions`

public static KeyCertOptions wrap(X509KeyManager keyManager)

Returns a KeyCertOptions from the provided X509KeyManager

Parameters

keyManager:X509KeyManager: the keyManager instance

Returns:KeyCertOptions

the KeyCertOptions

wrap back to summary

wrap	back to summary
public static KeyCertOptions wrap(KeyManagerFactory keyManagerFactory) Returns a `KeyCertOptions` from the provided `KeyManagerFactory` Parameters keyManagerFactory:KeyManagerFactory the keyManagerFactory instance Returns:KeyCertOptions the `KeyCertOptions`

public static KeyCertOptions wrap(KeyManagerFactory keyManagerFactory)

Returns a KeyCertOptions from the provided KeyManagerFactory

Parameters

keyManagerFactory:KeyManagerFactory: the keyManagerFactory instance

Returns:KeyCertOptions

the KeyCertOptions

public Interface KeyCertOptions

Method Summary

Method Detail