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

public Class OpenSSLEngineOptions

extends SSLEngineOptions
Class Inheritance
Annotations
@DataObject
@JsonGen
publicConverter:false
Imports
io.netty.handler.ssl.OpenSsl, .SslProvider, io.vertx.codegen.annotations.DataObject, io.vertx.codegen.json.annotations.JsonGen, io.vertx.core.json.JsonObject, io.vertx.core.spi.tls.DefaultSslContextFactory, .SslContextFactory
Configures a TCPSSLOptions to use OpenSsl.
Author
Julien Viet

Field Summary

Modifier and TypeField and Description
public static final boolean
DEFAULT_SESSION_CACHE_ENABLED

Default value of whether session cache is enabled in open SSL session server context = true

private boolean
sessionCacheEnabled

Inherited from io.vertx.core.net.SSLEngineOptions:
DEFAULT_USE_WORKER_POOL

Constructor Summary

AccessConstructor and Description
public
OpenSSLEngineOptions()

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

public
OpenSSLEngineOptions(OpenSSLEngineOptions other)

Method Summary

Modifier and TypeMethod and Description
public OpenSSLEngineOptions
copy()

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

public static boolean

Returns:

when alpn support is available via OpenSSL engine
isAlpnAvailable()

public static boolean

Returns:

when OpenSSL is available
isAvailable()

public boolean

Returns:

true if session cache is enabled
isSessionCacheEnabled()

Whether session cache is enabled in open SSL session server context

public OpenSSLEngineOptions

Returns:

a reference to this, so the API can be used fluently
setSessionCacheEnabled(boolean
true if session cache is enabled
sessionCacheEnabled)

Set whether session cache is enabled in open SSL session server context

public OpenSSLEngineOptions
setUseWorkerThread(boolean
whether to use the vertx internal worker pool for SSL blocking operations
useWorkerThread)

Overrides io.vertx.core.net.SSLEngineOptions.setUseWorkerThread.

Set the thread pool to use for SSL blocking operations.

public SslContextFactory
sslContextFactory()

Implements abstract io.vertx.core.net.SSLEngineOptions.sslContextFactory.

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

Inherited from io.vertx.core.net.SSLEngineOptions:
getUseWorkerThread

Field Detail

DEFAULT_SESSION_CACHE_ENABLEDback to summary
public static final boolean DEFAULT_SESSION_CACHE_ENABLED

Default value of whether session cache is enabled in open SSL session server context = true

sessionCacheEnabledback to summary
private boolean sessionCacheEnabled

Constructor Detail

OpenSSLEngineOptionsback to summary
public OpenSSLEngineOptions()
OpenSSLEngineOptionsback to summary
public OpenSSLEngineOptions(JsonObject json)

References Deprecated

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

See corresponding docs for further information.

OpenSSLEngineOptionsback to summary
public OpenSSLEngineOptions(OpenSSLEngineOptions other)

Method Detail

copyback to summary
public OpenSSLEngineOptions copy()

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

Annotations
@Override
isAlpnAvailableback to summary
public static boolean isAlpnAvailable()
Returns:boolean

when alpn support is available via OpenSSL engine

isAvailableback to summary
public static boolean isAvailable()
Returns:boolean

when OpenSSL is available

isSessionCacheEnabledback to summary
public boolean isSessionCacheEnabled()

Whether session cache is enabled in open SSL session server context

Returns:boolean

true if session cache is enabled

setSessionCacheEnabledback to summary
public OpenSSLEngineOptions setSessionCacheEnabled(boolean sessionCacheEnabled)

Set whether session cache is enabled in open SSL session server context

Parameters
sessionCacheEnabled:boolean

true if session cache is enabled

Returns:OpenSSLEngineOptions

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

setUseWorkerThreadback to summary
public OpenSSLEngineOptions setUseWorkerThread(boolean useWorkerThread)

Overrides io.vertx.core.net.SSLEngineOptions.setUseWorkerThread.

Doc from io.vertx.core.net.SSLEngineOptions.setUseWorkerThread.

Set the thread pool to use for SSL blocking operations.

Parameters
useWorkerThread:boolean

whether to use the vertx internal worker pool for SSL blocking operations

Returns:OpenSSLEngineOptions

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

Annotations
@Override
sslContextFactoryback to summary
public SslContextFactory sslContextFactory()

Implements abstract io.vertx.core.net.SSLEngineOptions.sslContextFactory.

Returns:SslContextFactory

Doc from io.vertx.core.net.SSLEngineOptions.sslContextFactory.

a SslContextFactory that will be used to produce the Netty SslContext

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.