Source for javax.net.ssl.SSLSessionContext

   1: /* SSLSessionContext.java -- collection of SSL sessions.
   2:    Copyright (C) 2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.net.ssl;
  40: 
  41: import java.util.Enumeration;
  42: 
  43: /**
  44:  * A collection of saved SSL sessions, with thier corresponding session
  45:  * IDs.
  46:  *
  47:  * @author Casey Marshall (rsdio@metastatic.org)
  48:  */
  49: public interface SSLSessionContext
  50: {
  51: 
  52:   /**
  53:    * Returns an enumeration of all saved session IDs. Every element in
  54:    * the returned enumeration is a byte array.
  55:    *
  56:    * @return The session IDs.
  57:    */
  58:   Enumeration getIds();
  59: 
  60:   /**
  61:    * Gets the session specified by its ID, or <code>null</code> if there
  62:    * is no session, or if it has expired.
  63:    *
  64:    * @param sessionId The ID of the session to get.
  65:    * @return The session, or <code>null</code>.
  66:    */
  67:   SSLSession getSession(byte[] sessionId);
  68: 
  69:   /**
  70:    * Returns the maximum number of sessions that may be cached by this
  71:    * session context.
  72:    *
  73:    * @return The maximum number of sessions that may be cached.
  74:    */
  75:   int getSessionCacheSize();
  76: 
  77:   /**
  78:    * Returns the period of time (in seconds) that a session may be cached
  79:    * for before becoming invalid.
  80:    *
  81:    * @return The time a session may be valid.
  82:    */
  83:   int getSessionTimeout();
  84: 
  85:   /**
  86:    * Sets the maximum number of sessions that may be cached by this
  87:    * session context. A cache size of 0 means no limit.
  88:    *
  89:    * @param size The new cache size.
  90:    * @throws IllegalArgumentException If <code>size</code> is negative.
  91:    */
  92:   void setSessionCacheSize(int size);
  93: 
  94:   /**
  95:    * Sets the period of time (in seconds) that a session may be cached
  96:    * for before becoming invalid. A timeout of 0 means that sessions
  97:    * never expire.
  98:    *
  99:    * @param seconds The new timeout.
 100:    * @throws IllegalArgumentException If <code>seconds</code> is negative.
 101:    */
 102:   void setSessionTimeout(int seconds);
 103: }