Interface SSLSessionContext
-
public interface SSLSessionContext
ASSLSessionContext
represents a set ofSSLSession
s associated with a single entity. For example, it could be associated with a server or client who participates in many sessions concurrently.Not all environments will contain session contexts.
There are
SSLSessionContext
parameters that affect how sessions are stored:- Sessions can be set to expire after a specified time limit.
- The number of sessions that can be stored in context can be limited.
SSLSessionContext
can be listed.- Since:
- 1.4
- See Also:
-
SSLSession
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description Enumeration<byte[]>
getIds()
Returns an Enumeration of all session id's grouped under thisSSLSessionContext
.SSLSession
getSession(byte[] sessionId)
Returns theSSLSession
bound to the specified session id.int
getSessionCacheSize()
Returns the size of the cache used for storingSSLSession
objects grouped under thisSSLSessionContext
.int
getSessionTimeout()
Returns the timeout limit ofSSLSession
objects grouped under thisSSLSessionContext
.void
setSessionCacheSize(int size)
Sets the size of the cache used for storingSSLSession
objects grouped under thisSSLSessionContext
.void
setSessionTimeout(int seconds)
Sets the timeout limit forSSLSession
objects grouped under thisSSLSessionContext
.
-
-
-
Method Detail
getSession
SSLSession getSession(byte[] sessionId)
Returns theSSLSession
bound to the specified session id.- Parameters:
-
sessionId
- the Session identifier - Returns:
-
the
SSLSession
or null if the specified session id does not refer to a valid SSLSession. - Throws:
-
NullPointerException
- ifsessionId
is null.
getIds
Enumeration<byte[]> getIds()
Returns an Enumeration of all session id's grouped under thisSSLSessionContext
.- Returns:
- an enumeration of all the Session id's
setSessionTimeout
void setSessionTimeout(int seconds) throws IllegalArgumentException
Sets the timeout limit forSSLSession
objects grouped under thisSSLSessionContext
.If the timeout limit is set to 't' seconds, a session exceeds the timeout limit 't' seconds after its creation time. When the timeout limit is exceeded for a session, the
SSLSession
object is invalidated and future connections cannot resume or rejoin the session. A check for sessions exceeding the timeout is made immediately whenever the timeout limit is changed for thisSSLSessionContext
.- Parameters:
-
seconds
- the new session timeout limit in seconds; zero means there is no limit. - Throws:
-
IllegalArgumentException
- if the timeout specified is< 0
. - See Also:
-
getSessionTimeout()
getSessionTimeout
int getSessionTimeout()
Returns the timeout limit ofSSLSession
objects grouped under thisSSLSessionContext
.If the timeout limit is set to 't' seconds, a session exceeds the timeout limit 't' seconds after its creation time. When the timeout limit is exceeded for a session, the
SSLSession
object is invalidated and future connections cannot resume or rejoin the session. A check for sessions exceeding the timeout limit is made immediately whenever the timeout limit is changed for thisSSLSessionContext
.- Returns:
- the session timeout limit in seconds; zero means there is no limit.
- See Also:
-
setSessionTimeout(int)
setSessionCacheSize
void setSessionCacheSize(int size) throws IllegalArgumentException
Sets the size of the cache used for storingSSLSession
objects grouped under thisSSLSessionContext
.- Parameters:
-
size
- the new session cache size limit; zero means there is no limit. - Throws:
-
IllegalArgumentException
- if the specified size is< 0
. - See Also:
-
getSessionCacheSize()
getSessionCacheSize
int getSessionCacheSize()
Returns the size of the cache used for storingSSLSession
objects grouped under thisSSLSessionContext
.- Returns:
- size of the session cache; zero means there is no size limit.
- See Also:
-
setSessionCacheSize(int)
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.