Top Description Constructors Methods
io.vertx.core.net

public Class JksOptions

extends KeyStoreOptionsBase
Class Inheritance
Annotations
@DataObject
@JsonGen
publicConverter:false
Imports
io.vertx.codegen.annotations.DataObject, io.vertx.codegen.json.annotations.JsonGen, io.vertx.core.buffer.Buffer, io.vertx.core.json.JsonObject
Key or trust store options configuring private key and/or certificates based on Java Keystore files.
Authors
Julien Viet, Tim Fox

Constructor Summary

AccessConstructor and Description
public
JksOptions()

Default constructor

public
JksOptions(JksOptions
the options to copy
other)

Copy constructor

public
JksOptions(JsonObject
the JSON
json)
References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

Create options from JSON

Method Summary

Modifier and TypeMethod and Description
public JksOptions
copy()

Implements abstract io.vertx.core.net.KeyStoreOptionsBase.copy.

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

public JksOptions
setAlias(String alias)

Overrides io.vertx.core.net.KeyStoreOptionsBase.setAlias.

Set the alias for a server certificate when the keystore has more than one.

public JksOptions
setAliasPassword(String aliasPassword)

Overrides io.vertx.core.net.KeyStoreOptionsBase.setAliasPassword.

Set the password for the server certificate designated by getAlias().

public JksOptions
setPassword(String
the password
password)

Overrides io.vertx.core.net.KeyStoreOptionsBase.setPassword.

Set the password for the key store

public JksOptions
setPath(String
the path
path)

Overrides io.vertx.core.net.KeyStoreOptionsBase.setPath.

Set the path to the key store

public JksOptions

Returns:

a reference to this, so the API can be used fluently
setValue(Buffer
the key store as a buffer
value)

Overrides io.vertx.core.net.KeyStoreOptionsBase.setValue.

References Deprecated Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

Set the key store as a buffer

public JsonObject

Returns:

the JSON
toJson()
References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

Convert to JSON

Inherited from io.vertx.core.net.KeyStoreOptionsBase:
equalsgetAliasgetAliasPasswordgetHelpergetKeyManagerFactorygetPasswordgetPathgetProvidergetTrustManagerFactorygetTypegetValuekeyManagerFactoryMapperkeyManagerMapperloadKeyStoresetProvidersetTypetrustManagerMapper

Constructor Detail

JksOptionsback to summary
public JksOptions()

Default constructor

JksOptionsback to summary
public JksOptions(JksOptions other)

Copy constructor

Parameters
other:JksOptions

the options to copy

JksOptionsback to summary
public JksOptions(JsonObject json)

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Create options from JSON

Parameters
json:JsonObject

the JSON

Method Detail

copyback to summary
public JksOptions copy()

Implements abstract io.vertx.core.net.KeyStoreOptionsBase.copy.

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

Returns:JksOptions

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

a copy of these options

Annotations
@Override
setAliasback to summary
public JksOptions setAlias(String alias)

Overrides io.vertx.core.net.KeyStoreOptionsBase.setAlias.

Doc from io.vertx.core.net.KeyStoreOptionsBase.setAlias.

Set the alias for a server certificate when the keystore has more than one.

Returns:JksOptions

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

Annotations
@Override
setAliasPasswordback to summary
public JksOptions setAliasPassword(String aliasPassword)

Overrides io.vertx.core.net.KeyStoreOptionsBase.setAliasPassword.

Doc from io.vertx.core.net.KeyStoreOptionsBase.setAliasPassword.

Set the password for the server certificate designated by getAlias().

Returns:JksOptions

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

Annotations
@Override
setPasswordback to summary
public JksOptions setPassword(String password)

Overrides io.vertx.core.net.KeyStoreOptionsBase.setPassword.

Doc from io.vertx.core.net.KeyStoreOptionsBase.setPassword.

Set the password for the key store

Parameters
password:String

the password

Returns:JksOptions

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

Annotations
@Override
setPathback to summary
public JksOptions setPath(String path)

Overrides io.vertx.core.net.KeyStoreOptionsBase.setPath.

Doc from io.vertx.core.net.KeyStoreOptionsBase.setPath.

Set the path to the key store

Parameters
path:String

the path

Returns:JksOptions

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

Annotations
@Override
setValueback to summary
public JksOptions setValue(Buffer value)

Overrides io.vertx.core.net.KeyStoreOptionsBase.setValue.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Set the key store as a buffer

Parameters
value:Buffer

the key store as a buffer

Returns:JksOptions

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

Annotations
@Override
toJsonback to summary
public JsonObject toJson()

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Convert to JSON

Returns:JsonObject

the JSON