/*
 * Copyright (c) 1999, 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.security.auth;

Objects such as credentials may optionally implement this interface to provide the capability to refresh itself. For example, a credential with a particular time-restricted lifespan may implement this interface to allow callers to refresh the time period for which it is valid.
See Also:
Since:1.4
/** * Objects such as credentials may optionally implement this * interface to provide the capability to refresh itself. * For example, a credential with a particular time-restricted lifespan * may implement this interface to allow callers to refresh the time period * for which it is valid. * * @since 1.4 * @see javax.security.auth.Subject */
public interface Refreshable {
Determine if this Object is current.
Returns:true if this Object is currently current, false otherwise.
/** * Determine if this {@code Object} is current. * * @return true if this {@code Object} is currently current, * false otherwise. */
boolean isCurrent();
Update or extend the validity period for this Object.
Throws:
/** * Update or extend the validity period for this * {@code Object}. * * @exception SecurityException if the caller does not have permission * to update or extend the validity period for this * {@code Object}. * * @exception RefreshFailedException if the refresh attempt failed. */
void refresh() throws RefreshFailedException; }