01 /*
02 * Copyright 1999 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.security.auth;
27
28 /**
29 * Objects such as credentials may optionally implement this
30 * interface to provide the capability to refresh itself.
31 * For example, a credential with a particular time-restricted lifespan
32 * may implement this interface to allow callers to refresh the time period
33 * for which it is valid.
34 *
35 * @version 1.16, 05/05/07
36 * @see javax.security.auth.Subject
37 */
38 public interface Refreshable {
39
40 /**
41 * Determine if this <code>Object</code> is current.
42 *
43 * <p>
44 *
45 * @return true if this <code>Object</code> is currently current,
46 * false otherwise.
47 */
48 boolean isCurrent();
49
50 /**
51 * Update or extend the validity period for this
52 * <code>Object</code>.
53 *
54 * <p>
55 *
56 * @exception SecurityException if the caller does not have permission
57 * to update or extend the validity period for this
58 * <code>Object</code>. <p>
59 *
60 * @exception RefreshFailedException if the refresh attempt failed.
61 */
62 void refresh() throws RefreshFailedException;
63 }
|