Top Description Fields Constructors Methods
io.vertx.core.net

pack-priv Class KeyManagerFactoryOptions

extends Object
implements KeyCertOptions
Class Inheritance
All Implemented Interfaces
io.vertx.core.net.KeyCertOptions
Imports
io.vertx.core.Vertx, javax.net.ssl.KeyManagerFactory, .X509KeyManager, java.util.function.Function

Key options configuring private key based on KeyManagerFactory or X509KeyManager.
InputStream keyStoreStream = ...;
KeyStore keyStore = KeyStore.getInstance("JKS");
keyStore.load(keyStoreStream, "keystore-password".toCharArray());

KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm());
keyManagerFactory.init(keyStore, "key-password".toCharArray());

HttpServerOptions options = HttpServerOptions.httpServerOptions();
options.setKeyCertOptions(new KeyManagerFactoryOptions(keyManagerFactory));

// or with a KeyManager

X509KeyManager keyManager = (X509KeyManager) keyManagerFactory.getKeyManagers()[0]
options.setKeyCertOptions(new KeyManagerFactoryOptions(keyManager));
As this class is not available because it is part of the internal api the proper usage would be:
// with a KeyManager
options.setKeyCertOptions(KeyCertOptions.wrap(keyManager));

// with a KeyManagerFactory
options.setKeyCertOptions(KeyCertOptions.wrap(keyManagerFactory));
Author
Hakan Altindag

Field Summary

Modifier and TypeField and Description
private final KeyManagerFactory

Constructor Summary

AccessConstructor and Description
pack-priv
pack-priv
private

Method Summary

Modifier and TypeMethod and Description
public KeyCertOptions
public KeyManagerFactory
getKeyManagerFactory(Vertx
the vertx instance
vertx
)

Implements io.vertx.core.net.KeyCertOptions.getKeyManagerFactory.

Create and return the key manager factory for these options.

public Function<String, X509KeyManager>
keyManagerMapper(Vertx vertx)

Overrides default io.vertx.core.net.KeyCertOptions.keyManagerMapper.

Returns a function that maps SNI server names to X509KeyManager instance.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

keyManagerFactoryback to summary
private final KeyManagerFactory keyManagerFactory

Constructor Detail

KeyManagerFactoryOptionsback to summary
pack-priv KeyManagerFactoryOptions(KeyManagerFactory keyManagerFactory)
KeyManagerFactoryOptionsback to summary
pack-priv KeyManagerFactoryOptions(X509KeyManager keyManager)
KeyManagerFactoryOptionsback to summary
private KeyManagerFactoryOptions(KeyManagerFactoryOptions other)

Method Detail

copyback to summary
public KeyCertOptions copy()

Implements io.vertx.core.net.KeyCertOptions.copy.

Returns:KeyCertOptions

Doc from io.vertx.core.net.KeyCertOptions.copy.

a copy of these options

Annotations
@Override
getKeyManagerFactoryback to summary
public KeyManagerFactory getKeyManagerFactory(Vertx vertx)

Implements io.vertx.core.net.KeyCertOptions.getKeyManagerFactory.

Doc from io.vertx.core.net.KeyCertOptions.getKeyManagerFactory.

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

Annotations
@Override
keyManagerMapperback to summary
public Function<String, X509KeyManager> keyManagerMapper(Vertx vertx)

Overrides default io.vertx.core.net.KeyCertOptions.keyManagerMapper.

Doc from io.vertx.core.net.KeyCertOptions.keyManagerMapper.

Returns a function that maps SNI server names to X509KeyManager instance. The returned X509KeyManager must satisfies these rules:

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
@Override