Class ReferenceCountedOpenSslServerContext

java.lang.Object

io.netty.handler.ssl.SslContext

io.netty.handler.ssl.ReferenceCountedOpenSslContext

io.netty.handler.ssl.ReferenceCountedOpenSslServerContext

All Implemented Interfaces:

ReferenceCounted

public final class ReferenceCountedOpenSslServerContext
extends ReferenceCountedOpenSslContext

A server-side SslContext which uses OpenSSL's SSL/TLS implementation.

Instances of this class must be released or else native memory will leak!

Instances of this class must not be released before any ReferenceCountedOpenSslEngine which depends upon the instance of this class is released. Otherwise if any method of ReferenceCountedOpenSslEngine is called which uses this class's JNI resources the JVM may crash.

Field Summary

Fields inherited from class ReferenceCountedOpenSslContext

ctx, VERIFY_DEPTH

Modifier and Type	Field	Description
protected long	ctx	The OpenSSL SSL_CTX object.
protected static final int	VERIFY_DEPTH

Method Summary

Modifier and Type	Method	Description
OpenSslServerSessionContext	sessionContext()	Returns the SSLSessionContext object held by this context.

Methods inherited from class ReferenceCountedOpenSslContext

applicationProtocolNegotiator, certificates, chooseTrustManager, chooseX509KeyManager, cipherSuites, context, getBioNonApplicationBufferSize, getRejectRemoteInitiatedRenegotiation, isClient, newEngine, newEngine, newHandler, newHandler, newHandler, newHandler, refCnt, release, release, retain, retain, setBioNonApplicationBufferSize, setPrivateKeyMethod, setRejectRemoteInitiatedRenegotiation, setTicketKeys, setUseTasks, sslCtxPointer, stats, touch, touch

Modifier and Type	Method	Description
ApplicationProtocolNegotiator	applicationProtocolNegotiator()	Returns the object responsible for negotiating application layer protocols for the TLS NPN/ALPN extensions.
protected static X509Certificate[]	certificates(byte[][] chain)
protected static X509TrustManager	chooseTrustManager(TrustManager[] managers)	Deprecated. This method is kept for API backwards compatibility.
protected static X509KeyManager	chooseX509KeyManager(KeyManager[] kms)
final List<String>	cipherSuites()	Returns the list of enabled cipher suites, in the order of preference.
final long	context()	Deprecated. this method is considered unsafe as the returned pointer may be released later.
int	getBioNonApplicationBufferSize()	Returns the size of the buffer used by the BIO for non-application based writes
boolean	getRejectRemoteInitiatedRenegotiation()	Deprecated.
final boolean	isClient()	Returns the true if and only if this context is for client-side.
final SSLEngine	newEngine(ByteBufAllocator alloc)	Returns a new server-side SSLEngine with the current configuration.
final SSLEngine	newEngine(ByteBufAllocator alloc, String peerHost, int peerPort)	Creates a new SSLEngine using advisory peer information.
protected final SslHandler	newHandler(ByteBufAllocator alloc, boolean startTls)	Create a new SslHandler.
protected SslHandler	newHandler(ByteBufAllocator alloc, boolean startTls, Executor executor)	Create a new SslHandler.
protected final SslHandler	newHandler(ByteBufAllocator alloc, String peerHost, int peerPort, boolean startTls)	Create a new SslHandler.
protected SslHandler	newHandler(ByteBufAllocator alloc, String peerHost, int peerPort, boolean startTls, Executor executor)
final int	refCnt()	Returns the reference count of this object.
final boolean	release()	Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
final boolean	release(int decrement)	Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
final ReferenceCounted	retain()	Increases the reference count by 1.
final ReferenceCounted	retain(int increment)	Increases the reference count by the specified increment.
void	setBioNonApplicationBufferSize(int bioNonApplicationBufferSize)	Set the size of the buffer used by the BIO for non-application based writes (e.g. handshake, renegotiation, etc...).
final void	setPrivateKeyMethod(OpenSslPrivateKeyMethod method)	Deprecated. use SslContextBuilder.option(SslContextOption, Object) with OpenSslContextOption.PRIVATE_KEY_METHOD.
void	setRejectRemoteInitiatedRenegotiation(boolean rejectRemoteInitiatedRenegotiation)	Deprecated.
final void	setTicketKeys(byte[] keys)	Deprecated. use OpenSslSessionContext.setTicketKeys(byte[])
final void	setUseTasks(boolean useTasks)	Deprecated. use SslContextBuilder.option(SslContextOption, Object) with OpenSslContextOption.USE_TASKS.
final long	sslCtxPointer()	Deprecated. this method is considered unsafe as the returned pointer may be released later.
final OpenSslSessionStats	stats()	Deprecated. use invalid @link {@link #sessionContext#stats() }
final ReferenceCounted	touch()	Records the current access location of this object for debugging purposes.
final ReferenceCounted	touch(Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class SslContext

attributes, buildKeyManagerFactory, buildKeyStore, buildTrustManagerFactory, buildTrustManagerFactory, buildTrustManagerFactory, defaultClientProvider, defaultServerProvider, generateKeySpec, isServer, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newHandler, newHandler, newHandler, newHandler, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, nextProtocols, sessionCacheSize, sessionTimeout, toPrivateKey, toPrivateKey, toX509Certificates, toX509Certificates

Modifier and Type	Method	Description
final AttributeMap	attributes()	Returns the AttributeMap that belongs to this SslContext .
protected static KeyManagerFactory	buildKeyManagerFactory(X509Certificate[] certChainFile, String keyAlgorithm, PrivateKey key, String keyPassword, KeyManagerFactory kmf, String keyStore)
protected static KeyStore	buildKeyStore(X509Certificate[] certChain, PrivateKey key, char[] keyPasswordChars, String keyStoreType)	Generates a new KeyStore.
protected static TrustManagerFactory	buildTrustManagerFactory(File certChainFile, TrustManagerFactory trustManagerFactory)	Deprecated.
protected static TrustManagerFactory	buildTrustManagerFactory(File certChainFile, TrustManagerFactory trustManagerFactory, String keyType)	Build a TrustManagerFactory from a certificate chain file.
protected static TrustManagerFactory	buildTrustManagerFactory(X509Certificate[] certCollection, TrustManagerFactory trustManagerFactory, String keyStoreType)
static SslProvider	defaultClientProvider()	Returns the default client-side implementation provider currently in use.
static SslProvider	defaultServerProvider()	Returns the default server-side implementation provider currently in use.
protected static PKCS8EncodedKeySpec	generateKeySpec(char[] password, byte[] key)	Deprecated.
final boolean	isServer()	Returns true if and only if this context is for server-side.
static SslContext	newClientContext()	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(SslProvider provider)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(SslProvider provider, File certChainFile)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(SslProvider provider, File certChainFile, TrustManagerFactory trustManagerFactory)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(SslProvider provider, File trustCertCollectionFile, TrustManagerFactory trustManagerFactory, File keyCertChainFile, File keyFile, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(SslProvider provider, File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(SslProvider provider, File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(SslProvider provider, TrustManagerFactory trustManagerFactory)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(File certChainFile)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(File certChainFile, TrustManagerFactory trustManagerFactory)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
static SslContext	newClientContext(TrustManagerFactory trustManagerFactory)	Deprecated. Replaced by SslContextBuilder
final SslHandler	newHandler(ByteBufAllocator alloc)	Create a new SslHandler.
final SslHandler	newHandler(ByteBufAllocator alloc, String peerHost, int peerPort)	Creates a new SslHandler
SslHandler	newHandler(ByteBufAllocator alloc, String peerHost, int peerPort, Executor delegatedTaskExecutor)	Creates a new SslHandler with advisory peer information.
SslHandler	newHandler(ByteBufAllocator alloc, Executor delegatedTaskExecutor)	Creates a new SslHandler.
static SslContext	newServerContext(SslProvider provider, File certChainFile, File keyFile)	Deprecated. Replaced by SslContextBuilder
static SslContext	newServerContext(SslProvider provider, File certChainFile, File keyFile, String keyPassword)	Deprecated. Replaced by SslContextBuilder
static SslContext	newServerContext(SslProvider provider, File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
static SslContext	newServerContext(SslProvider provider, File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
static SslContext	newServerContext(SslProvider provider, File certChainFile, File keyFile, String keyPassword, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
static SslContext	newServerContext(SslProvider provider, File trustCertCollectionFile, TrustManagerFactory trustManagerFactory, File keyCertChainFile, File keyFile, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
static SslContext	newServerContext(File certChainFile, File keyFile)	Deprecated. Replaced by SslContextBuilder
static SslContext	newServerContext(File certChainFile, File keyFile, String keyPassword)	Deprecated. Replaced by SslContextBuilder
static SslContext	newServerContext(File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
static SslContext	newServerContext(File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)	Deprecated. Replaced by SslContextBuilder
final List<String>	nextProtocols()	Deprecated. Use SslContext.applicationProtocolNegotiator() instead.
long	sessionCacheSize()	Returns the size of the cache used for storing SSL session objects.
long	sessionTimeout()	Returns the timeout for the cached SSL session objects, in seconds.
protected static PrivateKey	toPrivateKey(File keyFile, String keyPassword)
protected static PrivateKey	toPrivateKey(InputStream keyInputStream, String keyPassword)
protected static X509Certificate[]	toX509Certificates(File file)
protected static X509Certificate[]	toX509Certificates(InputStream in)

Methods inherited from class Object

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

Method Details

sessionContext

public OpenSslServerSessionContext sessionContext()

Description copied from class: SslContext

Returns the SSLSessionContext object held by this context.

Specified by:

sessionContext in class ReferenceCountedOpenSslContext