io.vertx.core.net

Class KeyStoreOptions

java.lang.Object

io.vertx.core.net.KeyStoreOptions

All Implemented Interfaces:

KeyCertOptions, TrustOptions

Direct Known Subclasses:

JksOptions, PfxOptions

public class KeyStoreOptions
extends Object
implements KeyCertOptions, TrustOptions

Key or trust store options configuring private key and/or certificates based on KeyStore.

• when used as a key store, it should point to a store containing a private key and its certificate.
• when used as a trust store, it should point to a store containing a list of trusted certificates.

The store can either be loaded by Vert.x from the filesystem:

 HttpServerOptions options = HttpServerOptions.httpServerOptions();
 options.setKeyStore(new KeyStoreOptions().setType("JKS").setPath("/mykeystore.jks").setPassword("foo"));
 

Or directly provided as a buffer:

 Buffer store = vertx.fileSystem().readFileBlocking("/mykeystore.jks");
 options.setKeyStore(new JKSOptions().setType("JKS").setValue(store).setPassword("foo"));
 

You can also use specific subclasses JksOptions or PfxOptions that will set the setType(java.lang.String) for you:

 HttpServerOptions options = HttpServerOptions.httpServerOptions();
 options.setKeyStore(new JksOptions().setPath("/mykeystore.jks").setPassword("foo"));
 

Author:

Julien Viet, Tim Fox

Constructor Summary

Constructors

Constructor and Description
KeyStoreOptions() Default constructor
KeyStoreOptions(KeyStoreOptions other) Copy constructor

Method Summary

Modifier and Type	Method and Description
KeyStoreOptions	copy()
String	getPassword()
String	getPath() Get the path to the ksy store
String	getType()
Buffer	getValue() Get the key store as a buffer
KeyStoreOptions	setPassword(String password) Set the password for the key store
KeyStoreOptions	setPath(String path) Set the path to the key store
KeyStoreOptions	setType(String type)
KeyStoreOptions	setValue(Buffer value) Set the key store as a buffer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.core.net.KeyCertOptions

getKeyManagerFactory, keyManagerMapper

Methods inherited from interface io.vertx.core.net.TrustOptions

getTrustManagerFactory, trustManagerMapper

Constructor Detail

KeyStoreOptions

public KeyStoreOptions()

Default constructor

KeyStoreOptions

public KeyStoreOptions(KeyStoreOptions other)

Copy constructor

Parameters:

other - the options to copy

Method Detail

getType

public String getType()

setType

public KeyStoreOptions setType(String type)

getPassword

public String getPassword()

Returns:

the password for the key store

setPassword

public KeyStoreOptions setPassword(String password)

Set the password for the key store

Parameters:

password - the password

Returns:

a reference to this, so the API can be used fluently

getPath

public String getPath()

Get the path to the ksy store

Returns:

the path

setPath

public KeyStoreOptions setPath(String path)

Set the path to the key store

Parameters:

path - the path

Returns:

a reference to this, so the API can be used fluently

getValue

public Buffer getValue()

Get the key store as a buffer

Returns:

the key store as a buffer

setValue

public KeyStoreOptions setValue(Buffer value)

Set the key store as a buffer

Parameters:

value - the key store as a buffer

Returns:

a reference to this, so the API can be used fluently

copy

public KeyStoreOptions copy()

Specified by:

copy in interface KeyCertOptions

Specified by:

copy in interface TrustOptions

Returns:

a copy of these options