io.netty.handler.ssl

Class JdkSslServerContext

java.lang.Object

io.netty.handler.ssl.SslContext

io.netty.handler.ssl.JdkSslContext

io.netty.handler.ssl.JdkSslServerContext

public final class JdkSslServerContext
extends JdkSslContext

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

Constructor Summary

Constructors

Constructor and Description
JdkSslServerContext(File certChainFile, File keyFile) Creates a new instance.
JdkSslServerContext(File certChainFile, File keyFile, String keyPassword) Creates a new instance.
JdkSslServerContext(File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout) Creates a new instance.
JdkSslServerContext(File certChainFile, File keyFile, String keyPassword, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, JdkApplicationProtocolNegotiator apn, long sessionCacheSize, long sessionTimeout) Creates a new instance.
JdkSslServerContext(File trustCertChainFile, TrustManagerFactory trustManagerFactory, File keyCertChainFile, File keyFile, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout) Creates a new instance.
JdkSslServerContext(File trustCertChainFile, TrustManagerFactory trustManagerFactory, File keyCertChainFile, File keyFile, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, JdkApplicationProtocolNegotiator apn, long sessionCacheSize, long sessionTimeout) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
SSLContext	context() Returns the JDK SSLContext object held by this context.
boolean	isClient() Returns the true if and only if this context is for client-side.

Methods inherited from class io.netty.handler.ssl.JdkSslContext

applicationProtocolNegotiator, buildKeyManagerFactory, buildKeyManagerFactory, buildTrustManagerFactory, cipherSuites, newEngine, newEngine, sessionCacheSize, sessionContext, sessionTimeout

Methods inherited from class io.netty.handler.ssl.SslContext

defaultClientProvider, defaultServerProvider, generateKeySpec, isServer, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newHandler, newHandler, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext

Methods inherited from class java.lang.Object

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

Constructor Detail

JdkSslServerContext

public JdkSslServerContext(File certChainFile,
                   File keyFile)
                    throws SSLException

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

JdkSslServerContext

public JdkSslServerContext(File certChainFile,
                   File keyFile,
                   String keyPassword)
                    throws SSLException

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

JdkSslServerContext

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

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

JdkSslServerContext

public JdkSslServerContext(File certChainFile,
                   File keyFile,
                   String keyPassword,
                   Iterable<String> ciphers,
                   CipherSuiteFilter cipherFilter,
                   JdkApplicationProtocolNegotiator apn,
                   long sessionCacheSize,
                   long sessionTimeout)
                    throws SSLException

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 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

JdkSslServerContext

public JdkSslServerContext(File trustCertChainFile,
                   TrustManagerFactory trustManagerFactory,
                   File keyCertChainFile,
                   File keyFile,
                   String keyPassword,
                   KeyManagerFactory keyManagerFactory,
                   Iterable<String> ciphers,
                   CipherSuiteFilter cipherFilter,
                   ApplicationProtocolConfig apn,
                   long sessionCacheSize,
                   long sessionTimeout)
                    throws SSLException

Creates a new instance.

Parameters:

trustCertChainFile - an X.509 certificate chain file in PEM format. This provides the certificate chains 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 trustCertChainFile.

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 - 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

JdkSslServerContext

public JdkSslServerContext(File trustCertChainFile,
                   TrustManagerFactory trustManagerFactory,
                   File keyCertChainFile,
                   File keyFile,
                   String keyPassword,
                   KeyManagerFactory keyManagerFactory,
                   Iterable<String> ciphers,
                   CipherSuiteFilter cipherFilter,
                   JdkApplicationProtocolNegotiator apn,
                   long sessionCacheSize,
                   long sessionTimeout)
                    throws SSLException

Creates a new instance.

Parameters:

trustCertChainFile - an X.509 certificate chain file in PEM format. This provides the certificate chains 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 trustCertChainFile

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 Detail

isClient

public boolean isClient()

Description copied from class: SslContext

Returns the true if and only if this context is for client-side.

Specified by:

isClient in class SslContext

context

public SSLContext context()

Description copied from class: JdkSslContext

Returns the JDK SSLContext object held by this context.

Specified by:

context in class JdkSslContext