Package io.netty.handler.ssl

Class OpenSslSessionContext

java.lang.Object

io.netty.handler.ssl.OpenSslSessionContext

All Implemented Interfaces:

SSLSessionContext

Direct Known Subclasses:

OpenSslServerSessionContext, ReferenceCountedOpenSslClientContext.OpenSslClientSessionContext

public abstract class OpenSslSessionContext
extends Object
implements SSLSessionContext

OpenSSL specific SSLSessionContext implementation.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final ReferenceCountedOpenSslContext	context
private final long	mask
private final OpenSslKeyMaterialProvider	provider
private final OpenSslSessionCache	sessionCache
private final OpenSslSessionStats	stats

Constructor Summary

Constructors

Constructor	Description
OpenSslSessionContext(ReferenceCountedOpenSslContext context, OpenSslKeyMaterialProvider provider, long mask, OpenSslSessionCache cache)

Method Summary

Modifier and Type	Method	Description
(package private) final void	destroy()
Enumeration<byte[]>	getIds()
SSLSession	getSession(byte[] bytes)
int	getSessionCacheSize()
int	getSessionTimeout()
(package private) final boolean	isInCache(OpenSslSessionId id)
boolean	isSessionCacheEnabled()	Return true if caching of SSL sessions is enabled, false otherwise.
(package private) final void	removeFromCache(OpenSslSessionId id)	Remove the given OpenSslInternalSession from the cache, and so not re-use it for new connections.
void	setSessionCacheEnabled(boolean enabled)	Enable or disable caching of SSL sessions.
void	setSessionCacheSize(int size)
(package private) boolean	setSessionFromCache(long ssl, OpenSslInternalSession session, String host, int port)
void	setSessionTimeout(int seconds)
void	setTicketKeys(byte[] keys)	Deprecated. use setTicketKeys(OpenSslSessionTicketKey...).
void	setTicketKeys(OpenSslSessionTicketKey... keys)	Sets the SSL session ticket keys of this context.
OpenSslSessionStats	stats()	Returns the stats of this context.
(package private) final boolean	useKeyManager()

Methods inherited from class java.lang.Object

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

Field Details

stats

private final OpenSslSessionStats stats

provider

private final OpenSslKeyMaterialProvider provider

context

final ReferenceCountedOpenSslContext context

sessionCache

private final OpenSslSessionCache sessionCache

mask

private final long mask

Constructor Details

OpenSslSessionContext

OpenSslSessionContext(ReferenceCountedOpenSslContext context,
 OpenSslKeyMaterialProvider provider,
 long mask,
 OpenSslSessionCache cache)

Method Details

useKeyManager

final boolean useKeyManager()

setSessionCacheSize

public void setSessionCacheSize(int size)

Specified by:

setSessionCacheSize in interface SSLSessionContext

getSessionCacheSize

public int getSessionCacheSize()

Specified by:

getSessionCacheSize in interface SSLSessionContext

setSessionTimeout

public void setSessionTimeout(int seconds)

Specified by:

setSessionTimeout in interface SSLSessionContext

getSessionTimeout

public int getSessionTimeout()

Specified by:

getSessionTimeout in interface SSLSessionContext

getSession

public SSLSession getSession(byte[] bytes)

Specified by:

getSession in interface SSLSessionContext

getIds

public Enumeration<byte[]> getIds()

Specified by:

getIds in interface SSLSessionContext

setTicketKeys

@Deprecated
public void setTicketKeys(byte[] keys)

Deprecated.

use setTicketKeys(OpenSslSessionTicketKey...).

Sets the SSL session ticket keys of this context.

setTicketKeys

public void setTicketKeys(OpenSslSessionTicketKey... keys)

Sets the SSL session ticket keys of this context. Depending on the underlying native library you may omit the argument or pass an empty array and so let the native library handle the key generation and rotating for you. If this is supported by the underlying native library should be checked in this case. For example BoringSSL is known to support this.

setSessionCacheEnabled

public void setSessionCacheEnabled(boolean enabled)

Enable or disable caching of SSL sessions.

isSessionCacheEnabled

public boolean isSessionCacheEnabled()

Return true if caching of SSL sessions is enabled, false otherwise.

stats

public OpenSslSessionStats stats()

Returns the stats of this context.

removeFromCache

final void removeFromCache(OpenSslSessionId id)

Remove the given OpenSslInternalSession from the cache, and so not re-use it for new connections.

isInCache

final boolean isInCache(OpenSslSessionId id)

setSessionFromCache

boolean setSessionFromCache(long ssl,
 OpenSslInternalSession session,
 String host,
 int port)

destroy

final void destroy()