1 /* 2 * Copyright (c) 1999, 2015, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * 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 * @see javax.security.auth.Subject 36 */ 37 public interface Refreshable { 38 39 /** 40 * Determine if this {@code Object} is current. 41 * 42 * @return true if this {@code Object} is currently current, 43 * false otherwise. 44 */ 45 boolean isCurrent(); 46 47 /** 48 * Update or extend the validity period for this 49 * {@code Object}. 50 * 51 * @exception SecurityException if the caller does not have permission 52 * to update or extend the validity period for this 53 * {@code Object}. 54 * 55 * @exception RefreshFailedException if the refresh attempt failed. 56 */ 57 void refresh() throws RefreshFailedException; 58 }