Source for javax.security.auth.Refreshable

   1: /* Refreshable.java -- an object whose state may be refreshed.
   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.security.auth;
  40: 
  41: /**
  42:  * An object whose internal state may be <em>refreshed:</em> as in a
  43:  * credential object with a expiry date.
  44:  */
  45: public interface Refreshable
  46: {
  47: 
  48:   /**
  49:    * Tells whether or not this object is current. Refreshable objects that
  50:    * are not current may need to be refreshed.
  51:    *
  52:    * @return Whether this object is current.
  53:    */
  54:   boolean isCurrent();
  55: 
  56:   /**
  57:    * Refresh this object. The process involved in refreshing an object is
  58:    * per-implementation dependent.
  59:    *
  60:    * @throws RefreshFailedException If refreshing this object fails.
  61:    * @throws SecurityException If the caller does not have permission to
  62:    *  refresh, or to take the steps involved in refreshing, this object.
  63:    */
  64:   void refresh() throws RefreshFailedException;
  65: }