Class DelegatingSslContext

java.lang.Object

io.netty.handler.ssl.SslContext

io.netty.handler.ssl.DelegatingSslContext

public abstract class DelegatingSslContext
extends SslContext

Adapter class which allows to wrap another SslContext and init SSLEngine instances.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DelegatingSslContext(SslContext ctx)

Method Summary

Modifier and Type	Method	Description
final ApplicationProtocolNegotiator	applicationProtocolNegotiator()	Returns the object responsible for negotiating application layer protocols for the TLS NPN/ALPN extensions.
final List<String>	cipherSuites()	Returns the list of enabled cipher suites, in the order of preference.
protected abstract void	initEngine(SSLEngine engine)	Init the SSLEngine.
protected void	initHandler(SslHandler handler)	Init the SslHandler.
final boolean	isClient()	Returns the true if and only if this context is for client-side.
final SSLEngine	newEngine(ByteBufAllocator alloc)	Creates a new SSLEngine.
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 long	sessionCacheSize()	Returns the size of the cache used for storing SSL session objects.
final SSLSessionContext	sessionContext()	Returns the SSLSessionContext object held by this context.
final long	sessionTimeout()	Returns the timeout for the cached SSL session objects, in seconds.

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

Constructor Details

DelegatingSslContext

protected DelegatingSslContext(SslContext ctx)

Method Details

isClient

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

cipherSuites

public final List<String> cipherSuites()

Description copied from class: SslContext

Returns the list of enabled cipher suites, in the order of preference.

Specified by:

cipherSuites in class SslContext

sessionCacheSize

public final long sessionCacheSize()

Description copied from class: SslContext

Returns the size of the cache used for storing SSL session objects.

Overrides:

sessionCacheSize in class SslContext

sessionTimeout

public final long sessionTimeout()

Description copied from class: SslContext

Returns the timeout for the cached SSL session objects, in seconds.

Overrides:

sessionTimeout in class SslContext

applicationProtocolNegotiator

public final ApplicationProtocolNegotiator applicationProtocolNegotiator()

Description copied from class: SslContext

Returns the object responsible for negotiating application layer protocols for the TLS NPN/ALPN extensions.

Specified by:

applicationProtocolNegotiator in class SslContext

newEngine

public final SSLEngine newEngine(ByteBufAllocator alloc)

Description copied from class: SslContext

Creates a new SSLEngine.

If SslProvider.OPENSSL_REFCNT is used then the object must be released. One way to do this is to wrap in a SslHandler and insert it into a pipeline. See SslContext.newHandler(ByteBufAllocator).

Specified by:

newEngine in class SslContext

Returns:

a new SSLEngine

newEngine

public final SSLEngine newEngine(ByteBufAllocator alloc,
 String peerHost,
 int peerPort)

Description copied from class: SslContext

Creates a new SSLEngine using advisory peer information.

If SslProvider.OPENSSL_REFCNT is used then the object must be released. One way to do this is to wrap in a SslHandler and insert it into a pipeline. See SslContext.newHandler(ByteBufAllocator, String, int).

Specified by:

newEngine in class SslContext

Parameters:

peerHost - the non-authoritative name of the host

peerPort - the non-authoritative port

Returns:

a new SSLEngine

newHandler

protected final SslHandler newHandler(ByteBufAllocator alloc,
 boolean startTls)

Description copied from class: SslContext

Create a new SslHandler.

Overrides:

newHandler in class SslContext

See Also:

• SslContext.newHandler(ByteBufAllocator)

newHandler

protected final SslHandler newHandler(ByteBufAllocator alloc,
 String peerHost,
 int peerPort,
 boolean startTls)

Description copied from class: SslContext

Create a new SslHandler.

Overrides:

newHandler in class SslContext

See Also:

• SslContext.newHandler(ByteBufAllocator, String, int, boolean, Executor)

newHandler

protected SslHandler newHandler(ByteBufAllocator alloc,
 boolean startTls,
 Executor executor)

Description copied from class: SslContext

Create a new SslHandler.

Overrides:

newHandler in class SslContext

See Also:

• SslContext.newHandler(ByteBufAllocator, String, int, boolean, Executor)

newHandler

protected SslHandler newHandler(ByteBufAllocator alloc,
 String peerHost,
 int peerPort,
 boolean startTls,
 Executor executor)

Overrides:

newHandler in class SslContext

sessionContext

public final SSLSessionContext sessionContext()

Description copied from class: SslContext

Returns the SSLSessionContext object held by this context.

Specified by:

sessionContext in class SslContext

initEngine

protected abstract void initEngine(SSLEngine engine)

Init the SSLEngine.

initHandler

protected void initHandler(SslHandler handler)

Init the SslHandler. This will by default call initEngine(SSLEngine), sub-classes may override this.