Top Description Fields Constructors Methods
io.netty.handler.ssl

public final Class OpenSslClientContext

extends OpenSslContext
Class Inheritance
Imports
io.netty.internal.tcnative.SSL, java.io.File, java.security.KeyStore, .PrivateKey, java.security.cert.X509Certificate, java.util.Map, javax.net.ssl.KeyManagerFactory, .SSLException, .TrustManager, .TrustManagerFactory
A client-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 ReferenceCountedOpenSslClientContext.

Field Summary

Modifier and TypeField and Description
private final OpenSslSessionContext
sessionContext

Constructor Summary

AccessConstructor and Description
public
OpenSslClientContext()

Deprecated use SslContextBuilder
Creates a new instance.
public
OpenSslClientContext(File
an X.509 certificate chain file in PEM format. null to use the system default
certChainFile)

Deprecated use SslContextBuilder
Creates a new instance.
public
OpenSslClientContext(TrustManagerFactory
the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.
trustManagerFactory)

Deprecated use SslContextBuilder
Creates a new instance.
public
OpenSslClientContext(File
an X.509 certificate chain file in PEM format. null to use the system default
certChainFile, TrustManagerFactory
the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.
trustManagerFactory)

Deprecated use SslContextBuilder
Creates a new instance.
public
OpenSslClientContext(File
an X.509 certificate chain file in PEM format
certChainFile, TrustManagerFactory
the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default..
trustManagerFactory, Iterable<String>
the cipher suites to enable, in the order of preference. null to use the default cipher suites.
ciphers, ApplicationProtocolConfig
Provides a means to configure parameters related to application protocol negotiation.
apn, long
the size of the cache used for storing SSL session objects. 0 to use the default value.
sessionCacheSize, long
the timeout for the cached SSL session objects, in seconds. 0 to use the default value.
sessionTimeout)

Deprecated use SslContextBuilder
Creates a new instance.
public
OpenSslClientContext(File
an X.509 certificate chain file in PEM format
certChainFile, TrustManagerFactory
the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default..
trustManagerFactory, Iterable<String>
the cipher suites to enable, in the order of preference. null to use the default cipher suites.
ciphers, CipherSuiteFilter
a filter to apply over the supplied list of ciphers
cipherFilter, ApplicationProtocolConfig
Provides a means to configure parameters related to application protocol negotiation.
apn, long
the size of the cache used for storing SSL session objects. 0 to use the default value.
sessionCacheSize, long
the timeout for the cached SSL session objects, in seconds. 0 to use the default value.
sessionTimeout)

Deprecated use SslContextBuilder
Creates a new instance.
public
OpenSslClientContext(File
an X.509 certificate collection file in PEM format. null to use the system default
trustCertCollectionFile, TrustManagerFactory
the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default or the results of parsing trustCertCollectionFile
trustManagerFactory, File
an X.509 certificate chain file in PEM format. This provides the public key for mutual authentication. null to use the system default
keyCertChainFile, File
a PKCS#8 private key file in PEM format. This provides the private key for mutual authentication. null for no mutual authentication.
keyFile, String
the password of the keyFile. null if it's not password-protected. Ignored if keyFile is null.
keyPassword, KeyManagerFactory
the KeyManagerFactory that provides the javax.net.ssl.KeyManagers that is used to encrypt data being sent to servers. null to use the default or the results of parsing keyCertChainFile and keyFile.
keyManagerFactory, Iterable<String>
the cipher suites to enable, in the order of preference. null to use the default cipher suites.
ciphers, CipherSuiteFilter
a filter to apply over the supplied list of ciphers
cipherFilter, ApplicationProtocolConfig
Application Protocol Negotiator object.
apn, long
the size of the cache used for storing SSL session objects. 0 to use the default value.
sessionCacheSize, long
the timeout for the cached SSL session objects, in seconds. 0 to use the default value.
sessionTimeout)

Deprecated use SslContextBuilder
Creates a new instance.
pack-priv
OpenSslClientContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, String[] protocols, long sessionCacheSize, long sessionTimeout, boolean enableOcsp, String keyStore, Map.Entry<SslContextOption<?>, Object>... options)

Method Summary

Modifier and TypeMethod and Description
public OpenSslSessionContext
sessionContext()

Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.sessionContext.

Returns the SSLSessionContext object held by this context.
Inherited from io.netty.handler.ssl.OpenSslContext:
finalizenewEngine0

Field Detail

sessionContextback to summary
private final OpenSslSessionContext sessionContext

Constructor Detail

OpenSslClientContextback to summary
public OpenSslClientContext() throws SSLException

Deprecated

use SslContextBuilder

Creates a new instance.

Annotations
@Deprecated
OpenSslClientContextback to summary
public OpenSslClientContext(File certChainFile) throws SSLException

Deprecated

use SslContextBuilder

Creates a new instance.

Parameters
certChainFile:File

an X.509 certificate chain file in PEM format. null to use the system default

Annotations
@Deprecated
OpenSslClientContextback to summary
public OpenSslClientContext(TrustManagerFactory trustManagerFactory) throws SSLException

Deprecated

use SslContextBuilder

Creates a new instance.

Parameters
trustManagerFactory:TrustManagerFactory

the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.

Annotations
@Deprecated
OpenSslClientContextback to summary
public OpenSslClientContext(File certChainFile, TrustManagerFactory trustManagerFactory) throws SSLException

Deprecated

use SslContextBuilder

Creates a new instance.

Parameters
certChainFile:File

an X.509 certificate chain file in PEM format. null to use the system default

trustManagerFactory:TrustManagerFactory

the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.

Annotations
@Deprecated
OpenSslClientContextback to summary
public OpenSslClientContext(File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout) throws SSLException

Deprecated

use SslContextBuilder

Creates a new instance.

Parameters
certChainFile:File

an X.509 certificate chain file in PEM format

trustManagerFactory:TrustManagerFactory

the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default..

ciphers:Iterable<String>

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

apn:ApplicationProtocolConfig

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

sessionCacheSize:long

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

sessionTimeout:long

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

Annotations
@Deprecated
OpenSslClientContextback to summary
public OpenSslClientContext(File certChainFile, TrustManagerFactory trustManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout) throws SSLException

Deprecated

use SslContextBuilder

Creates a new instance.

Parameters
certChainFile:File

an X.509 certificate chain file in PEM format

trustManagerFactory:TrustManagerFactory

the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default..

ciphers:Iterable<String>

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

cipherFilter:CipherSuiteFilter

a filter to apply over the supplied list of ciphers

apn:ApplicationProtocolConfig

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

sessionCacheSize:long

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

sessionTimeout:long

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

Annotations
@Deprecated
OpenSslClientContextback to summary
public OpenSslClientContext(File trustCertCollectionFile, TrustManagerFactory trustManagerFactory, File keyCertChainFile, File keyFile, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout) throws SSLException

Deprecated

use SslContextBuilder

Creates a new instance.

Parameters
trustCertCollectionFile:File

an X.509 certificate collection file in PEM format. null to use the system default

trustManagerFactory:TrustManagerFactory

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

keyCertChainFile:File

an X.509 certificate chain file in PEM format. This provides the public key for mutual authentication. null to use the system default

keyFile:File

a PKCS#8 private key file in PEM format. This provides the private key for mutual authentication. null for no mutual authentication.

keyPassword:String

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

keyManagerFactory:KeyManagerFactory

the KeyManagerFactory that provides the javax.net.ssl.KeyManagers that is used to encrypt data being sent to servers. null to use the default or the results of parsing keyCertChainFile and keyFile.

ciphers:Iterable<String>

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

cipherFilter:CipherSuiteFilter

a filter to apply over the supplied list of ciphers

apn:ApplicationProtocolConfig

Application Protocol Negotiator object.

sessionCacheSize:long

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

sessionTimeout:long

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

Annotations
@Deprecated
OpenSslClientContextback to summary
pack-priv OpenSslClientContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, String[] protocols, long sessionCacheSize, long sessionTimeout, boolean enableOcsp, String keyStore, Map.Entry<SslContextOption<?>, Object>... options) throws SSLException

Method Detail

sessionContextback to summary
public OpenSslSessionContext sessionContext()

Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.sessionContext.

Doc from io.netty.handler.ssl.SslContext.sessionContext.

Returns the SSLSessionContext object held by this context.

Annotations
@Override