javax.net.ssl

Interface SSLSessionContext

Known Implementing Classes:
AbstractSessionContext, SimpleSessionContext

public interface SSLSessionContext

A collection of saved SSL sessions, with thier corresponding session IDs.

Method Summary

Enumeration<E>
getIds()
Returns an enumeration of all saved session IDs.
SSLSession
getSession(byte[] sessionId)
Gets the session specified by its ID, or null if there is no session, or if it has expired.
int
getSessionCacheSize()
Returns the maximum number of sessions that may be cached by this session context.
int
getSessionTimeout()
Returns the period of time (in seconds) that a session may be cached for before becoming invalid.
void
setSessionCacheSize(int size)
Sets the maximum number of sessions that may be cached by this session context.
void
setSessionTimeout(int seconds)
Sets the period of time (in seconds) that a session may be cached for before becoming invalid.

Method Details

getIds

public Enumeration<E> getIds()
Returns an enumeration of all saved session IDs. Every element in the returned enumeration is a byte array.
Returns:
The session IDs.

getSession

public SSLSession getSession(byte[] sessionId)
Gets the session specified by its ID, or null if there is no session, or if it has expired.
Parameters:
sessionId - The ID of the session to get.
Returns:
The session, or null.

getSessionCacheSize

public int getSessionCacheSize()
Returns the maximum number of sessions that may be cached by this session context.
Returns:
The maximum number of sessions that may be cached.

getSessionTimeout

public int getSessionTimeout()
Returns the period of time (in seconds) that a session may be cached for before becoming invalid.
Returns:
The time a session may be valid.

setSessionCacheSize

public void setSessionCacheSize(int size)
Sets the maximum number of sessions that may be cached by this session context. A cache size of 0 means no limit.
Parameters:
size - The new cache size.
Throws:
IllegalArgumentException - If size is negative.

setSessionTimeout

public void setSessionTimeout(int seconds)
Sets the period of time (in seconds) that a session may be cached for before becoming invalid. A timeout of 0 means that sessions never expire.
Parameters:
seconds - The new timeout.
Throws:
IllegalArgumentException - If seconds is negative.

SSLSessionContext.java -- collection of SSL sessions. Copyright (C) 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.