Class OpenSslServerContext

java.lang.Object

io.netty.handler.ssl.SslContext

io.netty.handler.ssl.ReferenceCountedOpenSslContext

io.netty.handler.ssl.OpenSslContext

io.netty.handler.ssl.OpenSslServerContext

All Implemented Interfaces:

ReferenceCounted

public final class OpenSslServerContext
extends OpenSslContext

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

This class will use a finalizer to ensure native resources are automatically cleaned up. To avoid finalizers and manually release the native memory see ReferenceCountedOpenSslServerContext.

Field Summary

Fields inherited from class ReferenceCountedOpenSslContext

ctx, VERIFY_DEPTH

Constructor Summary

Constructors

Constructor	Description
OpenSslServerContext(File certChainFile, File keyFile)	Deprecated. use SslContextBuilder
OpenSslServerContext(File certChainFile, File keyFile, String keyPassword)	Deprecated. use SslContextBuilder
OpenSslServerContext(File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder
OpenSslServerContext(File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder
OpenSslServerContext(File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, Iterable<String> nextProtocols, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder
OpenSslServerContext(File certChainFile, File keyFile, String keyPassword, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, ApplicationProtocolConfig config, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder
OpenSslServerContext(File certChainFile, File keyFile, String keyPassword, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig config, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder
OpenSslServerContext(File certChainFile, File keyFile, String keyPassword, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, OpenSslApplicationProtocolNegotiator apn, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder}
OpenSslServerContext(File certChainFile, File keyFile, String keyPassword, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, OpenSslApplicationProtocolNegotiator apn, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder
OpenSslServerContext(File trustCertCollectionFile, TrustManagerFactory trustManagerFactory, File keyCertChainFile, File keyFile, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig config, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder
OpenSslServerContext(File trustCertCollectionFile, TrustManagerFactory trustManagerFactory, File keyCertChainFile, File keyFile, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, OpenSslApplicationProtocolNegotiator apn, long sessionCacheSize, long sessionTimeout)	Deprecated. use SslContextBuilder

Method Summary

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

Methods inherited from class OpenSslContext

finalize

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

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

Methods inherited from class Object

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

Constructor Details

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File certChainFile,
 File keyFile)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

Throws:

SSLException

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File certChainFile,
 File keyFile,
 String keyPassword)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

Throws:

SSLException

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File certChainFile,
 File keyFile,
 String keyPassword,
 Iterable<String> ciphers,
 ApplicationProtocolConfig apn,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

apn - Provides a means to configure parameters related to application protocol negotiation.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File certChainFile,
 File keyFile,
 String keyPassword,
 Iterable<String> ciphers,
 Iterable<String> nextProtocols,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File certChainFile,
 File keyFile,
 String keyPassword,
 TrustManagerFactory trustManagerFactory,
 Iterable<String> ciphers,
 ApplicationProtocolConfig config,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

config - Application protocol config.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File certChainFile,
 File keyFile,
 String keyPassword,
 TrustManagerFactory trustManagerFactory,
 Iterable<String> ciphers,
 OpenSslApplicationProtocolNegotiator apn,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

apn - Application protocol negotiator.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File certChainFile,
 File keyFile,
 String keyPassword,
 Iterable<String> ciphers,
 CipherSuiteFilter cipherFilter,
 ApplicationProtocolConfig apn,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

cipherFilter - a filter to apply over the supplied list of ciphers

apn - Provides a means to configure parameters related to application protocol negotiation.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File trustCertCollectionFile,
 TrustManagerFactory trustManagerFactory,
 File keyCertChainFile,
 File keyFile,
 String keyPassword,
 KeyManagerFactory keyManagerFactory,
 Iterable<String> ciphers,
 CipherSuiteFilter cipherFilter,
 ApplicationProtocolConfig config,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

trustCertCollectionFile - an X.509 certificate collection file in PEM format. This provides the certificate collection used for mutual authentication. null to use the system default

trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from clients. null to use the default or the results of parsing trustCertCollectionFile.

keyCertChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

keyManagerFactory - the KeyManagerFactory that provides the KeyManagers that is used to encrypt data being sent to clients. null to use the default or the results of parsing keyCertChainFile and keyFile.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

cipherFilter - a filter to apply over the supplied list of ciphers Only required if provider is SslProvider.JDK

config - Provides a means to configure parameters related to application protocol negotiation.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File certChainFile,
 File keyFile,
 String keyPassword,
 TrustManagerFactory trustManagerFactory,
 Iterable<String> ciphers,
 CipherSuiteFilter cipherFilter,
 ApplicationProtocolConfig config,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

cipherFilter - a filter to apply over the supplied list of ciphers

config - Application protocol config.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File certChainFile,
 File keyFile,
 String keyPassword,
 TrustManagerFactory trustManagerFactory,
 Iterable<String> ciphers,
 CipherSuiteFilter cipherFilter,
 OpenSslApplicationProtocolNegotiator apn,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder}

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

cipherFilter - a filter to apply over the supplied list of ciphers

apn - Application protocol negotiator.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

OpenSslServerContext

@Deprecated
public OpenSslServerContext(File trustCertCollectionFile,
 TrustManagerFactory trustManagerFactory,
 File keyCertChainFile,
 File keyFile,
 String keyPassword,
 KeyManagerFactory keyManagerFactory,
 Iterable<String> ciphers,
 CipherSuiteFilter cipherFilter,
 OpenSslApplicationProtocolNegotiator apn,
 long sessionCacheSize,
 long sessionTimeout)
                     throws SSLException

Deprecated.

use SslContextBuilder

Creates a new instance.

Parameters:

trustCertCollectionFile - an X.509 certificate collection file in PEM format. This provides the certificate collection used for mutual authentication. null to use the system default

trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from clients. null to use the default or the results of parsing trustCertCollectionFile.

keyCertChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

keyManagerFactory - the KeyManagerFactory that provides the KeyManagers that is used to encrypt data being sent to clients. null to use the default or the results of parsing keyCertChainFile and keyFile.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

cipherFilter - a filter to apply over the supplied list of ciphers Only required if provider is SslProvider.JDK

apn - Application Protocol Negotiator object

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

SSLException

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