Top Description Inners Fields Constructors Methods
org.conscrypt

public final Class ClientSessionContext

extends AbstractSessionContext
Class Inheritance
Annotations
@Internal
Imports
java.util.ArrayList, .HashMap, .List, .Map, javax.net.ssl.SSLContext
Caches client sessions. Indexes by host and port. Users are typically looking to reuse any session for a given host and port.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
ClientSessionContext.HostAndPort

Field Summary

Modifier and TypeField and Description
private SSLClientSessionCache
persistentCache

private final Map<ClientSessionContext.HostAndPort, List<NativeSslSession>>
sessionsByHostAndPort

Sessions indexed by host and port.

Inherited from org.conscrypt.AbstractSessionContext:
sslCtxNativePointer

Constructor Summary

AccessConstructor and Description
pack-priv
ClientSessionContext()

Method Summary

Modifier and TypeMethod and Description
pack-priv synchronized NativeSslSession
getCachedSession(String hostName, int port, SSLParametersImpl sslParameters)

Gets the suitable session reference from the session cache container.

private NativeSslSession

Returns:

cached session or null if none found
getSession(String
of server
host, int
of server
port)

Finds a cached session for the given host name and port.

pack-priv NativeSslSession
getSessionFromPersistentCache(byte[] sessionId)

Implements abstract org.conscrypt.AbstractSessionContext.getSessionFromPersistentCache.

Called for server sessions only.
pack-priv void
onBeforeAddSession(NativeSslSession session)

Implements abstract org.conscrypt.AbstractSessionContext.onBeforeAddSession.

Called when the given session is about to be added.
pack-priv void
onBeforeRemoveSession(NativeSslSession session)

Implements abstract org.conscrypt.AbstractSessionContext.onBeforeRemoveSession.

Called when a session is about to be removed.
private void
putSession(ClientSessionContext.HostAndPort key, NativeSslSession session)

private void
removeSession(ClientSessionContext.HostAndPort key, NativeSslSession session)

public void
setPersistentCache(SSLClientSessionCache persistentCache)

Applications should not use this method.

pack-priv int
size()

Inherited from org.conscrypt.AbstractSessionContext:
cacheSessionfinalizegetIdsgetSessiongetSessionCacheSizegetSessionFromCachegetSessionTimeoutremoveSessionsetSessionCacheSizesetSessionTimeout

Field Detail

persistentCacheback to summary
private SSLClientSessionCache persistentCache
sessionsByHostAndPortback to summary
private final Map<ClientSessionContext.HostAndPort, List<NativeSslSession>> sessionsByHostAndPort

Sessions indexed by host and port. Protect from concurrent access by holding a lock on sessionsByHostAndPort. Invariant: Each list includes either exactly one multi-use session or one or more single-use sessions. The types of sessions are never mixed, and adding a session of one kind will remove all sessions of the other kind.

Annotations
@SuppressWarnings:serial

Constructor Detail

ClientSessionContextback to summary
pack-priv ClientSessionContext()

Method Detail

getCachedSessionback to summary
pack-priv synchronized NativeSslSession getCachedSession(String hostName, int port, SSLParametersImpl sslParameters)

Gets the suitable session reference from the session cache container.

getSessionback to summary
private NativeSslSession getSession(String host, int port)

Finds a cached session for the given host name and port.

Parameters
host:String

of server

port:int

of server

Returns:NativeSslSession

cached session or null if none found

getSessionFromPersistentCacheback to summary
pack-priv NativeSslSession getSessionFromPersistentCache(byte[] sessionId)

Implements abstract org.conscrypt.AbstractSessionContext.getSessionFromPersistentCache.

Doc from org.conscrypt.AbstractSessionContext.getSessionFromPersistentCache.

Called for server sessions only. Retrieves the session by ID from the persistent cache.

Visible for extension only, not intended to be called directly.

Annotations
@Override
onBeforeAddSessionback to summary
pack-priv void onBeforeAddSession(NativeSslSession session)

Implements abstract org.conscrypt.AbstractSessionContext.onBeforeAddSession.

Doc from org.conscrypt.AbstractSessionContext.onBeforeAddSession.

Called when the given session is about to be added. Used by ClientSessionContext to update its host-and-port based cache.

Visible for extension only, not intended to be called directly.

Annotations
@Override
onBeforeRemoveSessionback to summary
pack-priv void onBeforeRemoveSession(NativeSslSession session)

Implements abstract org.conscrypt.AbstractSessionContext.onBeforeRemoveSession.

Doc from org.conscrypt.AbstractSessionContext.onBeforeRemoveSession.

Called when a session is about to be removed. Used by ClientSessionContext to update its host-and-port based cache.

Visible for extension only, not intended to be called directly.

Annotations
@Override
putSessionback to summary
private void putSession(ClientSessionContext.HostAndPort key, NativeSslSession session)
removeSessionback to summary
private void removeSession(ClientSessionContext.HostAndPort key, NativeSslSession session)
setPersistentCacheback to summary
public void setPersistentCache(SSLClientSessionCache persistentCache)

Applications should not use this method. Instead use Conscrypt#setClientSessionCache(SSLContext, SSLClientSessionCache).

sizeback to summary
pack-priv int size()
org.conscrypt back to summary

private final Class ClientSessionContext.HostAndPort

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final String
host

pack-priv final int
port

Constructor Summary

AccessConstructor and Description
pack-priv
HostAndPort(String host, int port)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

hostback to summary
pack-priv final String host
portback to summary
pack-priv final int port

Constructor Detail

HostAndPortback to summary
pack-priv HostAndPort(String host, int port)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override