001 /* SSLSessionContext.java -- collection of SSL sessions. 002 Copyright (C) 2004 Free Software Foundation, Inc. 003 004 This file is part of GNU Classpath. 005 006 GNU Classpath is free software; you can redistribute it and/or modify 007 it under the terms of the GNU General Public License as published by 008 the Free Software Foundation; either version 2, or (at your option) 009 any later version. 010 011 GNU Classpath is distributed in the hope that it will be useful, but 012 WITHOUT ANY WARRANTY; without even the implied warranty of 013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 General Public License for more details. 015 016 You should have received a copy of the GNU General Public License 017 along with GNU Classpath; see the file COPYING. If not, write to the 018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 019 02110-1301 USA. 020 021 Linking this library statically or dynamically with other modules is 022 making a combined work based on this library. Thus, the terms and 023 conditions of the GNU General Public License cover the whole 024 combination. 025 026 As a special exception, the copyright holders of this library give you 027 permission to link this library with independent modules to produce an 028 executable, regardless of the license terms of these independent 029 modules, and to copy and distribute the resulting executable under 030 terms of your choice, provided that you also meet, for each linked 031 independent module, the terms and conditions of the license of that 032 module. An independent module is a module which is not derived from 033 or based on this library. If you modify this library, you may extend 034 this exception to your version of the library, but you are not 035 obligated to do so. If you do not wish to do so, delete this 036 exception statement from your version. */ 037 038 039 package javax.net.ssl; 040 041 import java.util.Enumeration; 042 043 /** 044 * A collection of saved SSL sessions, with thier corresponding session 045 * IDs. 046 * 047 * @author Casey Marshall (rsdio@metastatic.org) 048 */ 049 public interface SSLSessionContext 050 { 051 052 /** 053 * Returns an enumeration of all saved session IDs. Every element in 054 * the returned enumeration is a byte array. 055 * 056 * @return The session IDs. 057 */ 058 Enumeration getIds(); 059 060 /** 061 * Gets the session specified by its ID, or <code>null</code> if there 062 * is no session, or if it has expired. 063 * 064 * @param sessionId The ID of the session to get. 065 * @return The session, or <code>null</code>. 066 */ 067 SSLSession getSession(byte[] sessionId); 068 069 /** 070 * Returns the maximum number of sessions that may be cached by this 071 * session context. 072 * 073 * @return The maximum number of sessions that may be cached. 074 */ 075 int getSessionCacheSize(); 076 077 /** 078 * Returns the period of time (in seconds) that a session may be cached 079 * for before becoming invalid. 080 * 081 * @return The time a session may be valid. 082 */ 083 int getSessionTimeout(); 084 085 /** 086 * Sets the maximum number of sessions that may be cached by this 087 * session context. A cache size of 0 means no limit. 088 * 089 * @param size The new cache size. 090 * @throws IllegalArgumentException If <code>size</code> is negative. 091 */ 092 void setSessionCacheSize(int size); 093 094 /** 095 * Sets the period of time (in seconds) that a session may be cached 096 * for before becoming invalid. A timeout of 0 means that sessions 097 * never expire. 098 * 099 * @param seconds The new timeout. 100 * @throws IllegalArgumentException If <code>seconds</code> is negative. 101 */ 102 void setSessionTimeout(int seconds); 103 }